Pipeline Configuration

Pipelines are configured entirely through JSON. Each pipeline defines a source, optional processing steps (preprocessing, data quality, transformation), and one or more destinations. You don’t need to write JSON by hand — once you have the Datris Data Platform up and running, the Datris UI provides a step-by-step pipeline wizard that builds the full configuration for you. Just pick your source, destination, and any processing options, and the platform generates the JSON behind the scenes.

Full Configuration Example

{
  "name": "sales_data",
  "source": {
    "schemaProperties": {
      "fields": [
        {"name": "order_id", "type": "int"},
        {"name": "customer_name", "type": "string"},
        {"name": "amount", "type": "double"},
        {"name": "order_date", "type": "date"},
        {"name": "region", "type": "string"}
      ]
    },
    "fileAttributes": {
      "csvAttributes": {
        "delimiter": ",",
        "header": true,
        "encoding": "UTF-8"
      }
    }
  },
  "preprocessor": {
    "endpoint": "http://my-service:8080/preprocess",
    "async": false,
    "bearerToken": "my-token",
    "timeoutMs": 300000
  },
  "dataQuality": {
    "validateFileHeader": true,
    "aiRule": {
      "instruction": "Amount must be a positive number, all dates must be in YYYY-MM-DD format",
      "onFailureIsError": true
    },
  },
  "transformation": {
    "aiTransformation": {
      "instruction": "convert all date values to YYYY-MM-DD format. Trim whitespace from all columns. Remove duplicate rows."
    }
  },
  "destination": {
    "objectStore": {
      "prefixKey": "sales/daily",
      "fileFormat": "parquet",
      "partitionBy": ["region"],
      "deleteBeforeWrite": false,
      "writeMode": "append"
    },
    "database": {
      "dbName": "analytics",
      "schema": "public",
      "table": "sales",
      "keyFields": ["order_id"],
      "usePostgres": true,
      "truncateBeforeWrite": false,
      "useTransaction": true
    },
    "kafka": {
      "topic": "sales-events",
      "keyField": "order_id"
    }
  }
}

Configuration Fields

Top Level

Field	Type	Required	Description
`name`	string	Yes	Pipeline name (max 80 characters)
`source`	object	Yes	Source configuration
`preprocessor`	object	No	Optional REST endpoint called before processing
`dataQuality`	object	No	Data validation rules
`transformation`	object	No	Data transformation settings
`destination`	object	Yes	One or more output destinations
`catalog`	string	No	Free-form label that groups related pipelines and taps in the Data Catalog. Empty or null = Uncataloged.
`tags`	string[]	No	Free-form discovery labels — `find_data` and the catalog search rank over them. See Provenance, Lineage & Discovery.
`provenance`	object	No	`{ "stamp": true }` appends `_datris_*` provenance fields to every row this pipeline lands. Off by default. See Provenance, Lineage & Discovery.
`authoritative`	boolean	No	Source of authority. Unset or `true`: this pipeline’s dataset may be the system of record (a single destination is, by default). `false`: everything it lands is a derived copy — a rollup, a replica, an index built from another dataset. See Provenance, Lineage & Discovery.
`destination.authoritative`	string	No	For pipelines with several destinations only: which destination kind (`postgres`, `mongodb`, `snowflake`, …) is the golden copy. Without it, all of them show as undeclared in lineage until you decide.

Source

Field	Type	Required	Description
`schemaProperties`	object	Yes*	Schema definition with field names and types. *Required for structured/semi-structured data
`fileAttributes`	object	No	File format configuration (CSV, JSON, XML, XLS, unstructured)
`databaseAttributes`	object	No	Database pull configuration
`streamAttributes`	object	No	Stream source configuration (Kafka)

Source > Schema Properties

Field	Type	Description
`dbName`	string	Database name associated with this schema (used by some destinations)
`fields`	array	List of `{"name": "...", "type": "..."}` objects
`schemaVersion`	int	Schema version (default `1`)

Supported types: boolean, int, tinyint, smallint, bigint, float, double, decimal(p,s), string, varchar(n), char(n), date, timestamp

Source > File Attributes

CSV:

"csvAttributes": {
  "delimiter": ",",
  "header": true,
  "encoding": "UTF-8"
}

JSON:

"jsonAttributes": {
  "everyRowContainsObject": true,
  "encoding": "UTF-8"
}

XML:

"xmlAttributes": {
  "everyRowContainsObject": true,
  "encoding": "UTF-8"
}

Excel:

"xlsAttributes": {
  "worksheet": 0,
  "tempCsvFileDelimiter": ","
}

Unstructured:

"unstructuredAttributes": {
  "fileExtension": "pdf",
  "preserveFilename": true
}

Source > Database Attributes

Field	Type	Required	Description
`type`	string	Yes	`postgres`, `mysql`, or `mssql`
`postgresSecretsName`	string	Conditional	Vault secret name for Postgres credentials
`mssqlSecretsName`	string	Conditional	Vault secret name for MSSQL credentials
`mysqlSecretsName`	string	Conditional	Vault secret name for MySQL credentials
`cronExpression`	string	Yes	Cron schedule for polling (e.g., `0 /5 * * ?`)
`database`	string	No	Database name
`schema`	string	No	Schema name
`table`	string	Yes*	Table to query (*unless `sqlOverride` is set)
`includeFields`	array	No	Column whitelist
`timestampFieldName`	string	Yes*	Column for incremental pulls (*unless `sqlOverride` is set)
`sqlOverride`	string	No	Custom SELECT query (replaces auto-generated query)
`outputDelimiter`	string	No	Delimiter for CSV output (default `,`)

Preprocessor

Field	Type	Default	Description
`endpoint`	string	Required	URL of the preprocessing service
`async`	boolean	`false`	If true, returns immediately
`bearerToken`	string	null	Authorization bearer token
`timeoutMs`	int	300000	Request timeout (milliseconds)
`batchSize`	int	0	Rows per call for row-based payloads; `0` sends every row in one call. When `> 0`, each request also carries `batch` and `ofBatches`, and every response’s `data.rows` are stitched in call order. See Preprocessor

Data Quality

See Data Quality for detailed documentation.

Field	Type	Description
`aiRule`	object	AI rule — plain-English validation instruction
`validateFileHeader`	boolean	Validate CSV header matches schema field order
`validationSchema`	string	Path to JSON Schema file for JSON/XML validation

Transformation

See AI Transformation for detailed documentation.

Field	Type	Description
`aiTransformation`	object	AI transformation — plain-English transformation instruction

Destination > Object Store

The object store destination writes Parquet files, ORC files, or an Apache Iceberg table to either the built-in MinIO (default) or to AWS S3. The provider is selected by the provider field; everything else is shared across both.

Field	Type	Default	Description
`prefixKey`	string	Required	Path prefix for output files under the bucket
`fileFormat`	string	`parquet`	Output format: `parquet`, `orc`, or `iceberg` (a table at the prefix with atomic commits, `merge` upserts, and schema evolution)
`partitionBy`	array	null	Column names for partitioning
`destinationBucketOverride`	string	null	Custom bucket (default: `{environment}-data` for MinIO; required for S3)
`deleteBeforeWrite`	boolean	false	Delete existing data at path before writing
`writeToTemporaryLocation`	boolean	false	Write to temp location first
`writeMode`	string	`append`	`append`, `overwrite`, `ignore`, `errorifexists`, or `merge` (`iceberg` only; requires `keyFields`)
`keyFields`	array	null	Natural-key columns for `writeMode: merge` on an Iceberg table. Each must be a destination schema column; rejected with any other write mode
`provider`	string	`minio`	`minio` (built-in, default) or `s3` (AWS S3)
`endpoint`	string	null	S3 endpoint URL override. Must use `https://`. Leave unset for the AWS regional default. Ignored for `minio`.
`credentialsSecret`	string	null	For `provider=s3`: name of a Platform-tab Vault secret containing `accessKey`, `secretKey`, `region` (and optionally `sessionToken`). Leave unset only when Datris runs on an AWS instance role.

For S3-specific behavior — credentials secret format, per-bucket credential isolation, multiple S3 destinations in one deployment — see the S3 Destination page.

Destination > Database

Field	Type	Default	Description
`dbName`	string	Required	Database name
`schema`	string	Required	Schema name
`table`	string	Required	Table name
`keyFields`	array	null	Natural-key columns (enables upsert on PostgreSQL, MongoDB, Snowflake, and Databricks). For MongoDB the keys are matched against fields inside the stored JSON document, so they don’t need to appear as schema columns; use lowercase field names
`usePostgres`	boolean	false	Write to PostgreSQL
`useMongoDB`	boolean	false	Write to MongoDB
`useSnowflake`	boolean	false	Write to the user’s Snowflake account — see Snowflake Destination
`useDatabricks`	boolean	false	Write a Unity Catalog managed Delta table in the user’s Databricks workspace — see Databricks Destination
`warehouse`	string	null	Snowflake virtual warehouse name, or Databricks SQL warehouse ID (required for those destinations)
`role`	string	null	Snowflake role to assume (optional, Snowflake only)
`credentialsSecret`	string	null	Platform secret holding destination credentials (required for Snowflake and Databricks)
`manageTableManually`	boolean	false	If false, auto-creates tables
`truncateBeforeWrite`	boolean	false	Truncate table before loading (atomic replace on Databricks)
`useTransaction`	boolean	true	Wrap in a transaction (Postgres/Snowflake; no effect on Databricks — each load is one atomic Delta commit)
`options`	array	null	Custom COPY options (e.g., `["FORMAT csv", "DELIMITER ','"]`)

Exactly one of usePostgres, useMongoDB, useSnowflake, or useDatabricks must be true. For Databricks, dbName names the Unity Catalog catalog.

Destination > Kafka

Field	Type	Default	Description
`topic`	string	Required	Kafka topic name
`keyField`	string	null	Column to use as message key
`overrideBootstrapServers`	string	null	Custom bootstrap servers
`timeoutMs`	int	10000	Producer timeout

Destination > ActiveMQ

Field	Type	Description
`queueName`	string	ActiveMQ queue name

Destination > REST Endpoint

Field	Type	Default	Description
`endpoint`	string	Required	URL to POST data to
`async`	boolean	false	If true, doesn’t wait for response
`bearerToken`	string	null	Authorization token
`apiKey`	string	null	API key for authentication
`timeoutSeconds`	int	0	Request timeout (seconds); 0 means unset
`timeoutMs`	int	300000	Request timeout (milliseconds)
`batchSize`	int	0	Rows per call for row-based payloads; `0` sends every row in one call. When `> 0`, each request also carries `batch` and `ofBatches`. See REST Endpoint

Destination > Qdrant

Field	Type	Description
`collectionName`	string	Qdrant collection name
`chunking`	object	Chunking config (see below)
`metadata`	object	Key-value metadata to attach to each chunk
`embeddingSecretName`	string	Optional override of the embedding Vault secret. Defaults to the server-level `ai.embedding.secretName`.
`qdrantSecretName`	string	Vault secret for Qdrant connection

Destination > Weaviate

Field	Type	Description
`className`	string	Weaviate class name
`chunking`	object	Chunking config (see below)
`metadata`	object	Key-value metadata to attach to each chunk
`embeddingSecretName`	string	Optional override of the embedding Vault secret. Defaults to the server-level `ai.embedding.secretName`.
`weaviateSecretName`	string	Vault secret for Weaviate connection

Destination > pgvector

Field	Type	Description
`tableName`	string	PostgreSQL table name
`schemaName`	string	PostgreSQL schema name
`chunking`	object	Chunking config (see below)
`metadata`	object	Key-value metadata to attach to each chunk
`embeddingSecretName`	string	Optional override of the embedding Vault secret. Defaults to the server-level `ai.embedding.secretName`.
`postgresSecretName`	string	Vault secret for PostgreSQL connection

Destination > Milvus

Field	Type	Description
`collectionName`	string	Milvus collection name
`chunking`	object	Chunking config (see below)
`metadata`	object	Key-value metadata to attach to each chunk
`embeddingSecretName`	string	Optional override of the embedding Vault secret. Defaults to the server-level `ai.embedding.secretName`.
`milvusSecretName`	string	Vault secret for Milvus connection

Destination > Chroma

Field	Type	Description
`collectionName`	string	Chroma collection name
`chunking`	object	Chunking config (see below)
`metadata`	object	Key-value metadata to attach to each chunk
`embeddingSecretName`	string	Optional override of the embedding Vault secret. Defaults to the server-level `ai.embedding.secretName`.
`chromaSecretName`	string	Vault secret for Chroma connection

Chunking Config

Used by all vector store destinations.

Field	Type	Default	Description
`strategy`	string	`recursive`	Chunking strategy: `fixed`, `sentence`, `paragraph`, `recursive`
`chunkSize`	int	500	Maximum characters per chunk
`chunkOverlap`	int	50	Overlap between consecutive chunks
`maxChunkTokens`	int	0 (off)	Optional token-count cap. When set, the chunker refuses to emit any chunk over this estimate, splitting oversized output before it ever reaches the embedding API. Recommended: ~80% of the embedding model’s input cap (e.g. 6500 for `text-embedding-3-small`). Without it, the server-side embedding guard catches oversized chunks as a fallback.
`tokensPerCharRatio`	float	2.0	Chars-per-token ratio for the chunker’s heuristic counter. Lower is more conservative (more splits); raise to ~3.5 for predictable Latin prose.

Destination > Live Read (`scratch`)

Nothing is landed: the run’s rows are held briefly and handed back to the caller, then expire. Use it for an answer now — a validation result or a transformed view — never for data you want to keep. See Live Read.

"destination": {
  "scratch": {}
}

Rule
Fields	None — the object is empty.
Sources	Structured only (CSV, JSON, XML); a sample is required at create time so the typed header exists.
Exclusive	Cannot be combined with any other destination in the same pipeline.
Reading rows	The status rollup carries `resultPreview`; page the rest with `GET /api/v1/pipeline/result`, `datris pipeline result`, or the `get_pipeline_result` MCP tool.

Destination > Schema Properties (Optional)

Define a separate destination schema if column mapping differs from the source:

"destination": {
  "schemaProperties": {
    "dbName": "analytics",
    "fields": [
      {"name": "order_id", "type": "int"},
      {"name": "customer", "type": "string"}
    ]
  }
}

Multiple Destinations

A single pipeline can write to multiple destinations simultaneously. All destinations execute in parallel:

"destination": {
  "objectStore": { ... },
  "database": { ... },
  "kafka": { ... },
  "activeMQ": { ... },
  "restEndpoint": { ... }
}

scratch is the exception: a Live Read pipeline lands nothing, so it cannot be combined with another destination.

​Full Configuration Example

​Configuration Fields

​Top Level

​Source

​Source > Schema Properties

​Source > File Attributes

​Source > Database Attributes

​Preprocessor

​Data Quality

​Transformation

​Destination > Object Store

​Destination > Database

​Destination > Kafka

​Destination > ActiveMQ

​Destination > REST Endpoint

​Destination > Qdrant

​Destination > Weaviate

​Destination > pgvector

​Destination > Milvus

​Destination > Chroma

​Chunking Config

​Destination > Live Read (scratch)

​Destination > Schema Properties (Optional)

​Multiple Destinations