This guide covers linking a source database and creating a dSource using dct-toolkit. A dSource is the initial ingestion point for data into Delphix, and is the source from which VDBs are provisioned. Estimated time: 15 minutes.

Prerequisites

  • dct-toolkit installed and configured (create_config completed)

  • A source database environment already registered in DCT

  • Database connectivity configured (network access and credentials)

  • DCT permissions to create dSources

Step 1: Identify your source environment

# List all environments
				dct-toolkit get_environments --columns=id,name,os_type,hostname

				# View full details including available repositories
			dct-toolkit get_environment_by_id environment_id=<ENV_NAME_OR_ID> -js

Record the environment ID or name for your source database — you'll need it in the next step.

Step 2: Link the source database

The linking command varies by database type. Use -h with any link command to see all available parameters for your platform.

Oracle (direct ingestion)

dct-toolkit link_oracle_database \
				source_name=<DSOURCE_NAME> \
				source_db_name=<DATABASE_NAME> \
				source_host_name=<HOSTNAME> \
				environment_id=<ENV_NAME_OR_ID> \
				db_credentials.username=<DB_USER> \
			db_credentials.password=<DB_PASSWORD>

Key parameters: source_db_name is the Oracle database name, not the SID. The database user must have appropriate Oracle privileges (such as SYSDBA, SELECT_CATALOG_ROLE, and CREATE SESSION).

SQL Server (staging pull)

dct-toolkit link_mssql_database \
				source_name=<DSOURCE_NAME> \
				source_db_name=<DATABASE_NAME> \
				environment_id=<ENV_NAME_OR_ID> \
				db_credentials.username=<DB_USER> \
			db_credentials.password=<DB_PASSWORD>

The database user needs db_owner or equivalent permissions.

PostgreSQL and AppData (staging pull)

dct-toolkit link_appdata_database \
				source_name=<DSOURCE_NAME> \
				environment_id=<ENV_NAME_OR_ID> \
			parameters='<JSON_PARAMETERS>'

The parameters JSON structure is defined by the plugin. Obtain the correct structure from the plugin's index file.

Step 3: Monitor the linking job

By default, dct-toolkit waits for job completion and shows progress inline. To run asynchronously instead, add --no-wait to the link command and then monitor separately:

# List recent jobs
				dct-toolkit get_jobs --columns=id,status,type,target_name sort=-start_time

				# Get specific job details
				dct-toolkit get_job_by_id job_id=<JOB_ID>

				# Full details including logs
			dct-toolkit get_job_by_id job_id=<JOB_ID> -js

Step 4: Verify dSource creation

# List all dSources
				dct-toolkit get_dsources --columns=id,name,database_type,status

				# Get full details
			dct-toolkit get_dsource_by_id dsource_id=<DSOURCE_NAME_OR_ID> -js

Step 5: Verify the initial snapshot

DCT creates an initial snapshot automatically when linking completes.

# List snapshots for the dSource
				dct-toolkit get_dsource_snapshots dsource_id=<DSOURCE_NAME_OR_ID>

				# Get snapshot details
				dct-toolkit get_snapshot_by_id snapshot_id=<SNAPSHOT_ID> -js

				# Trigger a manual snapshot (re-sync from source)
			dct-toolkit snapshot_dsource dsource_id=<DSOURCE_NAME_OR_ID>

Troubleshooting

Issue Resolution
Environment not found Verify the environment is registered with dct-toolkit search_environments name=<ENV_NAME>.
Database connection failed Check network connectivity from the Delphix engine to the source database. Verify database credentials have appropriate privileges (Oracle: SELECT_CATALOG_ROLE and CREATE SESSION; SQL Server: db_owner or equivalent).
Job failed during linking Run dct-toolkit get_job_by_id job_id=<JOB_ID> -js for detailed logs.
Insufficient permissions Verify your DCT account has the CREATE_DSOURCE permission. Check access group membership and role assignments in the DCT UI.

Next steps

Last updated
Oct 14, 2026