Notebook

List notebooks

GET/api/v2/databases/{database}/schemas/{schema}/notebooks
List notebooks

路径参数

参数描述
database string
Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases.
schema 
Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database.

查询参数

参数描述
like string
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWith string
Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
showLimit integer
Query parameter to limit the maximum number of rows returned by a command.
fromName string
Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.

响应

代码描述
200
successful
202
Successfully accepted the request, but it is not completed yet.

Create a notebook

POST/api/v2/databases/{database}/schemas/{schema}/notebooks
Create a notebook

查询参数

参数描述
createMode string
Query parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

响应

代码描述
200
Successful request.
202

Fetch a notebook

GET/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}
Fetch a notebook

路径参数

参数描述
name 
Identifier (i.e. name) for the resource.

响应

代码描述
200
successful
202

Delete a notebook

DELETE/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}
Delete a notebook

查询参数

参数描述
ifExists boolean
Query parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

响应

代码描述
200
202

Execute a Notebook

POST/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:execute
Execute a Notebook

查询参数

参数描述
asyncExec boolean
Asynchronous execution enable/disable. Default is disable.

响应

代码描述
200
202

Changes the name of the notebook to new name. The new identifier must be unique for the schema

POST/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:rename
Changes the name of the notebook to new name. The new identifier must be unique for the schema.

查询参数

参数描述
targetDatabase string
Database of the target resource. Defaults to the source's database
targetSchema string
Schema of the target resource. Defaults to the source's schema
targetName string
Name of the target resource.

响应

代码描述
200
202

Adds a LIVE version to the notebook

POST/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:add-live-version
Adds a LIVE version to the notebook

查询参数

参数描述
fromLast boolean
Sets the LIVE version to the LAST version of the notebook
comment string
Sets a comment for the notebook or version of the notebook

响应

代码描述
200
202

If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository

POST/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:commit
If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository

查询参数

参数描述
version string
live version of the alias
comment string
Sets a comment for the notebook or version of the notebook

响应

代码描述
200
202
语言: 中文