Quickstart¶

This is the shortest path from an installed package to a planned pipeline. It keeps credentials simple and points to deeper docs only after the first manifest is understandable.

1. Install dpone¶

pip install "dpone[postgres,mssql]"
dpone --help

For all public connectors:

pip install "dpone[full]"

2. Create a manifest¶

Create manifests/orders_to_landing.yaml:

source:
  type: postgres
  connection_id: postgres_oltp
  connection_type: env
  table:
    schema: public
    name: orders
  options:
    incremental_column: updated_at
    batch_size: 50000

sink:
  type: mssql
  connection_id: mssql_dwh
  connection_type: env
  table:
    schema: landing
    name: orders
  strategy:
    mode: incremental_merge
    unique_key: order_id
  options:
    bulk:
      mode: bcp
    schema_evolution:
      enabled: true

state:
  type: mssql
  connection_id: mssql_dwh
  table:
    schema: etl_state
    name: dpone_state

3. Provide credentials¶

For local development, environment variables are the most transparent option:

export DPONE_CONN_POSTGRES_OLTP_HOST=127.0.0.1
export DPONE_CONN_POSTGRES_OLTP_PORT=5432
export DPONE_CONN_POSTGRES_OLTP_DATABASE=app
export DPONE_CONN_POSTGRES_OLTP_USER=app
export DPONE_CONN_POSTGRES_OLTP_PASSWORD=secret

export DPONE_CONN_MSSQL_DWH_HOST=127.0.0.1
export DPONE_CONN_MSSQL_DWH_PORT=1433
export DPONE_CONN_MSSQL_DWH_DATABASE=dwh
export DPONE_CONN_MSSQL_DWH_USER=sa
export DPONE_CONN_MSSQL_DWH_PASSWORD=secret
export DPONE_CONN_MSSQL_DWH_TRUST_SERVER_CERTIFICATE=yes

For Airflow, Vault, or inline params, use Credentials quickstart first and then the complete Connections and credentials reference.

4. Inspect before writing¶

dpone doctor --profile local
dpone plan manifests/orders_to_landing.yaml

The plan should show the source query, staging table, load strategy, schema evolution actions, reconciliation policy, and state backend.

5. Run¶

dpone run manifests/orders_to_landing.yaml --run-id orders_local --format json
dpone run-report --run-id orders_local --pipeline orders_to_landing

6. Where to go next¶

Need	Guide
Understand append/upsert/replace/XMin/CDC	Load strategies
Run from CLI or Python	Running pipelines
Pick a supported source -> sink combination	Source -> sink matrix
Configure MSSQL `bcp` safely	MSSQL guide
Configure schema evolution behavior	Schema evolution
Prepare production gates	Production readiness