CData Connect Cloud Python API Docs | dltHub

Build a CData Connect Cloud-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.

Last updated:

CData Connect Cloud provides a REST API that allows users to query data, perform batch operations, and execute stored procedures across configured data sources. The REST API base URL is https://cloud.cdata.com/api and all requests require HTTP Basic Authentication using a Personal Access Token (PAT).

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading CData Connect Cloud data in under 10 minutes.


What data can I load from CData Connect Cloud?

Here are some of the endpoints you can load from CData Connect Cloud:

ResourceEndpointMethodData selectorDescription
tables/tablesGETRetrieves a list of tables and views.
query/queryPOSTrowsExecutes a SQL query against configured data sources.
workspaces/workspacesGETLists workspaces configured in the account.
connections/connectionsGETLists data connections available.
metadata/metadataGETRetrieves metadata for schema/tables.

How do I authenticate with the CData Connect Cloud API?

Authentication is performed using the Authorization header with a Base64-encoded string of 'email

', where the email is your account identifier and the password is your generated Personal Access Token. Standard HTTP Basic authentication can be used where the client handles the encoding.

1. Get your credentials

To obtain credentials for the CData Connect Cloud REST API, follow these steps: 1. Log in to your CData Connect Cloud account. 2. Click on the Gear icon in the top-right corner to open the Settings page. 3. Navigate to the Access Tokens section. 4. Click Create PAT (Personal Access Token). 5. Provide a name for the token and click Create. 6. Copy the generated PAT immediately, as it will not be displayed again. This token serves as the password for API authentication.

2. Add them to .dlt/secrets.toml

[sources.cdata_connect_cloud_source] cdata_username = "your_email@example.com" cdata_pat = "your_personal_access_token_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.


How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI harness:

dlthub ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

dlthub ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the CData Connect Cloud API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

python cdata_connect_cloud_pipeline.py

If everything is configured correctly, you'll see output like this:

Pipeline cdata_connect_cloud_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset cdata_connect_cloud_data The duckdb destination used duckdb:/cdata_connect_cloud.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

dlt pipeline cdata_connect_cloud_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.


Python pipeline example

This example loads /api/query and /api/odata from the CData Connect Cloud API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def cdata_connect_cloud_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://cloud.cdata.com/api", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key}, }, "resources": [ {"name": "tables", "endpoint": {"path": "tables"}}, {"name": "query", "endpoint": {"path": "query", "data_selector": "rows"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="cdata_connect_cloud_pipeline", destination="duckdb", dataset_name="cdata_connect_cloud_data", ) load_info = pipeline.run(cdata_connect_cloud_source()) print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.


How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("cdata_connect_cloud_pipeline").dataset() sessions_df = data.tables.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM cdata_connect_cloud_data.tables LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("cdata_connect_cloud_pipeline").dataset() data.tables.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.


What destinations can I load CData Connect Cloud data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.


Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI harness:

  • data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
  • dlthub-platform — Deploy, schedule, and monitor your pipeline in production.
dlthub ai toolkit data-exploration install dlthub ai toolkit dlthub-platform install

Was this page helpful?

Community Hub

Need more dlt context for CData Connect Cloud?

Request dlt skills, commands, AGENT.md files, and AI-native context.

Available Pipelines