Connections

Look up connections by path

This endpoint returns details about the fully qualified path to an object in a specific connection by connection ID.

Usage notes

Different connections support different paths:

  • For a Snowflake connection, you can specify DATABASE.SCHEMA.TABLE, DATABASE.SCHEMA.STORED_PROCEDURE, or a less-specific path.
  • For Amazon Redshift, you can specify SCHEMA.TABLE, SCHEMA.STORED_PROCEDURE, or a less-specific path.
  • For Databricks, you can specify CATALOG.SCHEMA.TABLE or a less-specific path.

Connection path details include the connection path ID, called the inodeId in the response, and the type of object in the connection path, either a table or a scope (database, schema, catalog, or other higher-level object).

post/v2/connection/{connectionId}/lookup

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

connectionIdstring required

Request body

Response

The response body.

kind'scope' | 'table' | 'semanticView' | 'metricView' | 'stored-procedure' required
inodeIdstring required
urlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.