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

Usage notes

• Retrieve the workbookId by calling the /v2/workbooks endpoint.

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

• Retrieve the sources used by a workbook from the v2/workbooks/{workbookId}/sources endpoint.

• To swap all 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 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, only Custom SQL elements have their connections changed.

Usage scenarios

• Workbook development: Use a test data source while developing a workbook, then swap the source to a production database when ready to share the workbook for production use.