Skip to main content
The pipeline can pull data directly from relational databases on a schedule. Configure a database source, set a cron expression, and the pipeline handles connection management, incremental extraction, and secret retrieval from Vault.

​
Supported Databases

DatabaseJDBC Driver
PostgreSQLorg.postgresql.Driver
MySQLcom.mysql.cj.jdbc.Driver
MSSQLcom.microsoft.sqlserver.jdbc.SQLServerDriver

​
Configuration

Database sources are configured in the databaseAttributes section of a pipeline configuration. Connection credentials (JDBC URL, username, password) are stored in Vault — not in the pipeline config itself. 
{
  "name": "customer_sync",
  "source": {
    "databaseAttributes": {
      "type": "postgres",
      "postgresSecretsName": "oss/postgres",
      "database": "production",
      "schema": "public",
      "table": "customers",
      "cronExpression": "0 */15 * * * ?",
      "timestampFieldName": "updated_at",
      "includeFields": ["id", "email", "name", "updated_at", "status"]
    },
    "schemaProperties": {
      "fields": [
        { "name": "id", "type": "bigint" },
        { "name": "email", "type": "varchar(255)" },
        { "name": "name", "type": "varchar(200)" },
        { "name": "updated_at", "type": "timestamp" },
        { "name": "status", "type": "varchar(20)" }
      ]
    }
  },
  "destination": {
    "database": {
      "dbName": "datris",
      "schema": "public",
      "table": "customers",
      "usePostgres": true
    }
  }
}

​
Configuration Reference

PropertyRequiredDescription
typeYesOne of postgres, mysql, mssql
postgresSecretsNameConditionalVault secret name for PostgreSQL credentials
mysqlSecretsNameConditionalVault secret name for MySQL credentials
mssqlSecretsNameConditionalVault secret name for MSSQL credentials
cronExpressionYesQuartz-format cron expression controlling the pull schedule
databaseNoDatabase name (if not in the JDBC URL)
schemaNoSchema within the database
tableYes*Table to pull data from (*unless sqlOverride is set)
timestampFieldNameYes*Column used for incremental pulls. Effectively required — the generated query always appends this column and orders by it.
includeFieldsNoArray of column names to select; when omitted, all columns are selected
sqlOverrideNoCustom SQL query that replaces the generated SELECT statement
outputDelimiterNoDelimiter for CSV output (default ,)

​
Secrets in Vault

Database credentials are never stored in the pipeline configuration. Instead, the pipeline reads them from HashiCorp Vault using the secret name configured above. The Vault secret must contain username, password, and jdbcUrl keys: 
{
  "username": "pipeline_reader",
  "password": "s3cureP@ss",
  "jdbcUrl": "jdbc:postgresql://db.internal.example.com:5432/production"
}
Store the credentials in Vault using the CLI: 
vault kv put oss/postgres \
  username="pipeline_reader" \
  password="s3cureP@ss" \
  jdbcUrl="jdbc:postgresql://db.internal.example.com:5432/production"

​
Cron-Based Scheduling

The cronExpression field accepts a Quartz cron string with six fields (seconds, minutes, hours, day-of-month, month, day-of-week):
ExpressionSchedule
0 */15 * * * ?Every 15 minutes
0 0 * * * ?Every hour on the hour
0 0 2 * * ?Daily at 02:00
0 0 0 ? * MONEvery Monday at midnight

​
Incremental Pulls

Incremental extraction relies on timestampFieldName, which is effectively required: the generated SELECT always appends that column to the projection and orders the result by it (ORDER BY {timestampFieldName}). After each pull, the pipeline records the value of that column from the last (highest-ordered) row returned — this is the high-water mark. It is not computed with a MAX() aggregate; it is simply the timestamp of the final row in the ordered result set. On the next execution, the pipeline adds a WHERE {timestampFieldName} > {lastValue} clause to fetch only new or updated rows. The high-water mark is stored in MongoDB in the {environment}-data-pull collection.

​
Custom SQL

Set sqlOverride to run an arbitrary query instead of a simple SELECT ... FROM table: 
{
  "databaseAttributes": {
    "type": "postgres",
    "postgresSecretsName": "oss/postgres",
    "sqlOverride": "SELECT o.id, o.total, c.email FROM orders o JOIN customers c ON o.customer_id = c.id",
    "cronExpression": "0 */30 * * * ?"
  }
}

​
Field Filtering

Use includeFields to select a subset of columns from the source table: 
{
  "databaseAttributes": {
    "table": "users",
    "includeFields": ["id", "username", "email", "created_at"]
  }
}
When sqlOverride is set, includeFields is ignored because the SQL query already defines the column list.

​
Troubleshooting

SymptomCheck
Connection refusedVerify the jdbcUrl in Vault is correct and the database allows connections from the pipeline host.
Authentication failedConfirm the Vault secret name is correct and contains valid username/password/jdbcUrl keys.
Zero rows returned on incremental pullThe high-water mark in MongoDB may already be ahead of the data. Delete the entry in the {environment}-data-pull collection to reset it.
SQL syntax errorWhen using sqlOverride, test the query directly against the database first.