Data models

Swap data model sources

Swap the data sources used by a data model. You can swap from one connection to another, and/or from one dataset or table to another.

Usage notes

  • Retrieve the dataModelId by calling the /v2/dataModels endpoint.

  • Retrieve the connectionId by calling the /v2/connections endpoint.

  • To map the sources of a specific element, you can use the table or dataset ID:

    • List sources of data model by calling the /v2/dataModels/{dataModelId}/sources endpoint.
    • Retrieve table and dataset IDs by calling the /v2/files endpoint. Use the typeFilters option to filter for table and dataset files. Use id field in the response as the fromId or toId, as relevant.
  • To swap warehouse tables in a connection, set the swapTables option to true.

    • Use the paths option to specify the connection paths to swap. The connection path is a list of strings that represents the path to the table in the cloud data warehouse. For example, ["database", "schema", "table"].
    • If the table schema is the same in both connections, leave the paths option empty to swap all warehouse tables in the connection. You can also pass a partial path to swap between databases, catalogs, or schemas.
    • If sourceMapping is provided, those mappings take precedence over the connection swaps.
    • If swapTables is not set to true, warehouse tables stay on the original connection. Custom SQL elements and input tables still follow the connection mapping.

Usage scenarios

  • Data model development: Use a test data source while developing a data model, then swap the source to a production database when ready to share the data model for production use.
post/v2/dataModels/{dataModelId}/swapSources

Request

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

Path parameters

dataModelIdstring required

Unique identifier of the data model.

Request body

copyInputTableDataboolean

Response

The response body.

unswappedSourcesstring[] required

IDs of sources in the workbook that were not swapped.

unswappedConnectionsstring[] required

IDs of custom SQL connections in the workbook that were not swapped.

Changes

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