Skip to main content
Version: v3.x (DDN)

DDN CLI: ddn connector introspect

Introspect the Connector data source to update the Connector configuration.

Synopsis

After you've initialized a data connector, you'll need to run this introspection command to complete or update the local configuration for the connector. The generated configuration file will then be used by the CLI to incorporate various resources (such as models, commands, and relationships) into your API.

ddn connector introspect <connector-name> --subgraph <path-to-subgraph-config-file> [flags]

Examples

# Introspect Connector my_db from Subgraph located at ./foo/subgraph.yaml and update DataConnectorLink
ddn connector introspect my_db --subgraph ./foo/subgraph.yaml

# Introspect Connector located at ./foo/my_db/connector.yaml
ddn connector introspect --connector ./foo/my_db/connector.yaml

# Introspect Connector my_db but do not update DataConnectorLink
ddn connector introspect my_db --subgraph ./foo/subgraph.yaml --no-update-link

Options

    --add-all-resources      Add all Models, Commands and Relationships from the updated DataConnectorLink to the local metadata
--ci Disables the use of context
--connector string Path to Connector YAML config file
-c, --context string Name of the context to use. (default <current_context>)
-e, --env stringArray Environment variable, e.g. key=val. Can be repeated to provide multiple env vars
--env-file stringArray Path to .env file. Can be repeated to provide multiple env files
-h, --help help for introspect
--no-update-link Ignore updating DataConnectorLink in the metadata
--subgraph string Path to Subgraph config file

Options inherited from parent operations

--log-level string   Log level. Can be DEBUG, WARN, INFO, ERROR, or FATAL. (default "INFO")
--no-prompt Do not prompt for required but missing flags
--out string Output format. Can be table, json or yaml. (default "table")
--timeout int Request timeout in seconds [env: HASURA_DDN_TIMEOUT] (default 100)

Parent operation