> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/references/resources/nilus/batch/sample-configs.md).

# Batch sample configs

Ready-to-use batch pipeline configurations covering full snapshots, incremental loads, and merge patterns across common source types.

All examples below use the current Nilus pipeline shape with `spec.type: batch`:

```yaml
type: nilus
spec:
  type: batch
```

This page is a sample gallery for common batch connector patterns; for the field-by-field reference, see [Batch Pipeline Config](https://v2.dataos.info/references/resources/nilus/batch/pipeline-config.md).

{% hint style="info" %}
Streaming sources (Kafka, NATS+JetStream) use `spec.type: stream`, not `spec.type: batch`. See [Stream Sample Configs](https://v2.dataos.info/references/resources/nilus/stream/sample-configs.md) for those patterns.
{% endhint %}

## Current Nilus shape

```yaml
name: nilus-batch-example
version: v1alpha
type: nilus
spec:
  type: batch
  compute: universe-compute
  source:
    address: <source-uri>
    options:
      source_table: <object-or-schema.table>
  sink:
    address: <sink-uri>
    options:
      dest_table: <target-object>
      incremental_strategy: <append|replace|merge>
```

## SQL database to Lakehouse

Use this as the recommended first production-like path when the source is represented by a DataOS depot and Nilus should read one PostgreSQL table into a DataOS Lakehouse destination.

```yaml
name: postgres-orders-batch
version: v1alpha
type: nilus
spec:
  type: batch
  compute: universe-compute
  source:
    address: dataos://postgressource?purpose=ro
    options:
      source_table: public.orders
      incremental_key: updated_at
      primary_key: order_id
  sink:
    address: dataos://orderslakehouse?purpose=rw
    options:
      dest_table: analytics.orders
      incremental_strategy: merge
```

## SaaS API to warehouse

Use this pattern for connectors such as Salesforce, Stripe, or HubSpot where Nilus extracts named objects or endpoints over an API. Direct connector URIs with `{ENV_VAR}` placeholders require `spec.use.projection`; see [Secrets and Projections](https://v2.dataos.info/references/resources/nilus/concepts/secrets-and-projections.md) for the full projection block.

```yaml
name: salesforce-account-batch
version: v1alpha
type: nilus
spec:
  type: batch
  compute: universe-compute
  source:
    address: salesforce://?username={SALESFORCE_USERNAME}&password={SALESFORCE_PASSWORD}&token={SALESFORCE_TOKEN}&domain={SALESFORCE_DOMAIN}
    options:
      source_table: account
  sink:
    address: databricks://token:{DATABRICKS_TOKEN}@{DATABRICKS_HOST}?http_path={DATABRICKS_HTTP_PATH}&catalog=main&schema=crm
    options:
      dest_table: account
      incremental_strategy: append
```

## Spreadsheet to Lakehouse

Use this pattern for sheet-style sources that behave like snapshots rather than incremental databases.

```yaml
name: gsheets-sheet-batch
version: v1alpha
type: nilus
spec:
  type: batch
  compute: universe-compute
  source:
    address: gsheets://?credentials_path=/etc/dataos/secret/gsheets_sa.json
    options:
      source_table: 1OblKaJc2HwoprRNHSH9eKRdPlx1M45tUuzf5x9k_TNY.EMP_DATA
  sink:
    address: dataos://sheetlakehouse?purpose=rw
    options:
      dest_table: analytics.emp_data
      incremental_strategy: replace
```

## Azure Synapse dedicated SQL pool to Lakehouse

Synapse batch reads use the MS SQL Server path (`mssql://` or a SQL Server/MSSQL depot). There is no `synapse://` scheme. Dedicated SQL pools often need `MSSQL_IGNORE_NO_TRANSACTION_ON_ROLLBACK`; see [Azure Synapse](https://v2.dataos.info/references/resources/nilus/batch/batch-sources/azure-synapse.md) and [Secrets and projections](https://v2.dataos.info/references/resources/nilus/concepts/secrets-and-projections.md).

```yaml
name: synapse-orders-batch
version: v1alpha
type: nilus
spec:
  type: batch
  compute: universe-compute
  use:
    projection:
      projections:
        envVars:
          - key: MSSQL_IGNORE_NO_TRANSACTION_ON_ROLLBACK
            template: "true"
  source:
    address: dataos://synapse_depot?purpose=ro
    options:
      source_table: dbo.orders
      incremental_key: modified_at
      primary_key: order_id
  sink:
    address: dataos://analyticslakehouse?purpose=rw
    options:
      dest_table: synapse.orders
      incremental_strategy: merge
```

## Validation notes

* Use `type: nilus` and keep the pipeline type under `spec.type: batch`.
* `source_table` means different things by connector: a SQL table, an API object, a spreadsheet range, or a stream name.
* Prefer `replace` for snapshot-style sources such as Google Sheets.
* Use `append` or `merge` only when the source contract and destination semantics support them.

## Related docs

* [Batch pipeline config](https://v2.dataos.info/references/resources/nilus/batch/pipeline-config.md)
* [CDC sample configs](https://v2.dataos.info/references/resources/nilus/cdc/sample-configs.md)
* [Stream sample configs](https://v2.dataos.info/references/resources/nilus/stream/sample-configs.md)
* [Optimize sink datasets](https://v2.dataos.info/references/resources/nilus/pipeline-optimization/optimize-sink-datasets.md)
* [Salesforce](https://v2.dataos.info/references/resources/nilus/batch/batch-sources/salesforce.md)
* [Google Sheets](https://v2.dataos.info/references/resources/nilus/batch/batch-sources/google-sheets.md)
* [Azure Synapse](https://v2.dataos.info/references/resources/nilus/batch/batch-sources/azure-synapse.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://v2.dataos.info/references/resources/nilus/batch/sample-configs.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
