{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"redocly_category":"Treasure Code","product_name":"Treasure Code","type":"markdown"},"seo":{"title":"tdx connection - Connection Management | Treasure Data","description":"Manage result output connections for job exports and segment activations. List connections and view schemas.","siteUrl":"https://docs.treasuredata.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]},"image":"/assets/og-image.ba836864a30434f560a4f7720f8a09019ad30ff828b20c5052ae933ba7121524.d7ef4821.png"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"connection","__idx":0},"children":["connection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Manage result output connections used for exporting job results and segment activations."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart LR\n subgraph Type[\"Connector Type\"]\n Settings[\"Settings
credentials, auth\"]\n Schema[\"Schema
output options\"]\n end\n\n Settings -->|creates| Connection\n Schema -->|configures| Activation[\"Activation
connector_config\"]\n Connection -->|used by| Activation\n\n CmdSettings[\"tdx connection settings\"] -.-> Settings\n CmdSchema[\"tdx connection schema\"] -.-> Schema\n CmdListShow[\"tdx connection list/show\"] -.-> Connection\n\n style Settings fill:#e1f5fe\n style Schema fill:#fff3e0\n style Connection fill:#e8f5e9\n style Activation fill:#fce4ec\n","diagramHtml":"

Connector Type

creates

configures

used by

Settings
credentials, auth

Schema
output options

Connection

Activation
connector_config

tdx connection settings

tdx connection schema

tdx connection list/show

","diagramHtmlDark":"

Connector Type

creates

configures

used by

Settings
credentials, auth

Schema
output options

Connection

Activation
connector_config

tdx connection settings

tdx connection schema

tdx connection list/show

"},"children":["flowchart LR\n subgraph Type[\"Connector Type\"]\n Settings[\"Settings
credentials, auth\"]\n Schema[\"Schema
output options\"]\n end\n\n Settings -->|creates| Connection\n Schema -->|configures| Activation[\"Activation
connector_config\"]\n Connection -->|used by| Activation\n\n CmdSettings[\"tdx connection settings\"] -.-> Settings\n CmdSchema[\"tdx connection schema\"] -.-> Schema\n CmdListShow[\"tdx connection list/show\"] -.-> Connection\n\n style Settings fill:#e1f5fe\n style Schema fill:#fff3e0\n style Connection fill:#e8f5e9\n style Activation fill:#fce4ec\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Two types of configuration:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings"]}," - Credentials and auth needed to ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["create"]}," a connection"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Schema"]}," - Options for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connector_config"]}," when ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["using"]}," a connection in activations"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commands","__idx":2},"children":["Commands"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Command"},"children":["Command"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx connection list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List all result output connections"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx connection show "]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show connection details"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx connection types"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List available connector types"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx connection schema "]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show connector output schema for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connector_config"]}," in activations"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx connection settings "]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show connection-level settings (credentials, authentication)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"usage","__idx":3},"children":["Usage"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-connections","__idx":4},"children":["List Connections"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List all result output connections available in your account:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# List all connections (simple format: name, type, owner)\ntdx connection list\n\n# Output in table format (detailed view)\ntdx connection list --table\n\n# Output as JSON\ntdx connection list --json\n\n# Limit results\ntdx connection list --limit 10\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default output format:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":" s3 my-s3-export - John Doe\nsalesforce salesforce-sync - Jane Smith\n bigquery bigquery-warehouse - Data Team\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"show-connection","__idx":5},"children":["Show Connection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Show detailed information about a specific connection by name:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Show by name\ntdx connection show my-s3-connection\n\n# Output as JSON\ntdx connection show \"My Salesforce Connection\" --json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-connector-types","__idx":6},"children":["List Connector Types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List all available connector types for activations:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# List all connector types\ntdx connection types\n\n# Output as JSON\ntdx connection types --json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default output format:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":" s3 S3\n pgsql PostgreSQL\n salesforce Salesforce\n bigquery BigQuery\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"show-connector-schema","__idx":7},"children":["Show Connector Schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Show the output schema for a connector type. This shows what fields are available in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connector_config"]}," when configuring ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["activations"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Show schema for salesforce connector\ntdx connection schema salesforce\n\n# Show schema for s3\ntdx connection schema s3\n\n# Output as JSON (full schema)\ntdx connection schema salesforce --json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default output format:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Connector: salesforce\n\nAvailable fields:\n object: Object Name [text]\n Salesforce object name (e.g., Contact, Lead, Account)\n mode: Mode [select]\n Options: append, replace, upsert\n Default: append\n external_id_field: External ID Field [text]\n Show when: mode=[\"upsert\"]\n"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Using with Activations"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The schema shows available fields for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connector_config"]}," section in activation YAML:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"activations:\n - name: SFMC Export\n connection: my-sfmc\n connector_config:\n de_name: CustomerSegment\n shared_data_extension: false\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you run ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx sg push"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx journey push"]},", the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connector_config"]}," is automatically validated against the schema. Invalid values will be caught with helpful error messages before pushing to TD."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"show-connection-settings","__idx":8},"children":["Show Connection Settings"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Show the connection-level settings for a connector type. This shows what credentials and configuration are needed when ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["creating a connection"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Show settings for REST API connector\ntdx connection settings rest\n\n# Show settings for S3\ntdx connection settings s3\n\n# Output as JSON (full metadata)\ntdx connection settings rest --json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default output format:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Connector: rest\nName: REST API (For internal CDP KVS server only)\n\nCredential settings:\n endpoint: Endpoint\n HTTP Request endpoint\n\nAvailable fields:\n method: HTTP Method [select]\n HTTP Method to use in request\n Options: PUT, POST, PATCH\n Default: POST\n headers: Request headers\n JSON map of headers name/value to be included in request\n"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Schema vs Settings"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schema"]}]}," - Output settings for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connector_config"]}," in activations (what to send)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settings"]}]}," - Connection-level settings (credentials, endpoints, authentication)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Some connectors (like ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rest"]},") only have connection settings and no output schema."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"aliases","__idx":9},"children":["Aliases"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx connections"]}," - Alias for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdx connection list"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"output-fields","__idx":10},"children":["Output Fields"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"connection-listdetails","__idx":11},"children":["Connection List/Details"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Connection name (unique identifier)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Connection type (e.g., s3, td, postgresql, gspreadsheet)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settings"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Connection settings (JSON object) or URL string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["organization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Organization (deprecated)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":12},"children":["Examples"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# List connections and filter with jq\ntdx connection list --json | jq '.[] | select(.name | contains(\"s3\"))'\n\n# Export connection list to a file\ntdx connection list --json > connections.json\n\n# Check what credentials are needed for a connector\ntdx connection settings salesforce\n\n# Check what output options are available for activations\ntdx connection schema salesforce\n","lang":"bash"},"children":[]}]},"headings":[{"value":"connection","id":"connection","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Commands","id":"commands","depth":2},{"value":"Usage","id":"usage","depth":2},{"value":"List Connections","id":"list-connections","depth":3},{"value":"Show Connection","id":"show-connection","depth":3},{"value":"List Connector Types","id":"list-connector-types","depth":3},{"value":"Show Connector Schema","id":"show-connector-schema","depth":3},{"value":"Show Connection Settings","id":"show-connection-settings","depth":3},{"value":"Aliases","id":"aliases","depth":2},{"value":"Output Fields","id":"output-fields","depth":2},{"value":"Connection List/Details","id":"connection-listdetails","depth":3},{"value":"Examples","id":"examples","depth":2}],"frontmatter":{"seo":{"title":"tdx connection - Connection Management | Treasure Data","description":"Manage result output connections for job exports and segment activations. List connections and view schemas.","image":"/assets/og-image.ba836864a30434f560a4f7720f8a09019ad30ff828b20c5052ae933ba7121524.d7ef4821.png"}},"lastModified":"2026-02-14T00:54:05.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/treasure-code/commands/connection","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}