SQL workbooks

Use SQL workbooks to save SQL content and manage its versions. These interfaces do not execute SQL; use SQL execution when you need to run SQL.

  • workbook_id identifies a record with saved SQL. This value is returned when creating a record or viewing a list of saved SQL.

  • version_id identifies a SQL version in this record. This value is returned when creating a draft or viewing a version list.

Interface paths, field names, and some error responses still use workbook or “SQL workbook”, which all refer to the SQL save record described above.

Choose a task

Task

Description

Inspect SQL workbook list

Lists the SQL save records that can be read by the current access credentials.

Read saved SQL content

View the SQL content in a workbook version without executing it.

Add SQL workbook

Create a SQL workbook that holds SQL content and its versions.

Rename a SQL workbook

Modifying the name of the SQL saved record will not modify the SQL content or version saved therein.

Remove SQL workbook

Delete a SQL save record and all its versions.

Inspect SQL workbook version list

List all versions of a SQL workbook.

Start a SQL draft

Creates an editable draft version of a SQL save record and saves the original SQL content.

Edit an SQL draft

Edit SQL in an unfinalized draft without executing it.

Finalize a read-only SQL version

Save and finalize a draft version.
Last updated on