Skip to main content

Sigma

Connect Catalog to Sigma to sync workbooks, datasets, and metadata. You can use Catalog-managed credentials or run the extraction package yourself.

Requirements​

warning

A warehouse integration must already be configured to complete the first ingestion of this integration.

  • You must be an organization Admin to create a Sigma API token and Client ID.
  • Anyone with access to an active Sigma API token and Client ID can authenticate with Sigma's API at the access level associated with the token.

Catalog Managed​

To get started with Sigma in Catalog, you need to be a Sigma admin and provide:

  • A Sigma API token (secret)
  • Your Client ID
  • The Host URL of your instance

For more information on how to retrieve the API token and Client ID, see Get an API Token and Client ID.

To get the correct Host URL of your instance, see Identify your API request URL.

Input your credentials directly into your Catalog account in the following format:

{
    "apiToken": "*****",
    "clientId": "*****",
    "host": "https://<your_provider_url>.sigmacomputing.com"
}
Sigma API Details

For further details on the Sigma API, see Get Started with Sigma's API.

For your first sync, it will take up to 48 h and we will let you know when it is complete.

If you are not comfortable giving us access to your credentials, continue to Client Managed.

Client Managed​

Doing a One-Shot Extract​

For your trial, you can give us a one-shot view of your BI tool.

To get things working quickly, use this Google Colab to run the package.

Running the Extraction Package​

Install the PyPI Package​

For further details on the Catalog Extractor PyPI package, see castor-extractor on PyPI.

Running the PyPI Package​

Once the package has been installed, run the following command in your terminal:

castor-extract-sigma [arguments]

The script will run and display logs similar to:

INFO - Extracting users from Sigma API
INFO - POST(https://cloud.sigma.com/api/4.0/login)
INFO - GET(https://cloud.sigma.com/api/4.0/users/search)
INFO - Fetched page 1 / 7 results
INFO - GET(https://catalog.cloud.sigma.com/api/4.0/users/search)
INFO - Fetched page 2 / 0 results


...

INFO - Wrote output file: /tmp/catalog/1649079699-projects.json
INFO - Wrote output file: /tmp/catalog/1649079699-summary.json
Extraction Arguments​
  • -H, --host: Sigma host
  • -c, --client-id: Sigma client ID
  • -a, --api-token: Generated API key
  • -o, --output: Directory to write to

Scheduling and Push to Catalog​

When moving out of trial, you will want to refresh your Sigma content in Catalog. Here is how to do it:

The Catalog team will provide you with:

  1. Catalog Identifier (an ID for us to match your Sigma files with your Catalog instance)
  2. Catalog Token (an API token)

You can then use the castor-upload command:

castor-upload [arguments]
Upload Arguments​
  • -k, --token: Token provided by Catalog
  • -s, --source_id: Account ID provided by Catalog
  • -t, --file_type: Source type to upload. Currently supported: DBT, VIZ, or WAREHOUSE
Target Files​

To specify the target files, provide one of the following:

  • -f, --file_path: To push a single file

or

  • -d, --directory_path: To push several files at once

The tool will upload all files included in the given directory. Make sure it contains only the extracted files before pushing.

Then schedule the script run and the push to Catalog using your preferred scheduler.