Function

List Functions

GET/api/v2/databases/{database}/schemas/{schema}/functions
Lists the user functions under the database and schema.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

ビュー

パスパラメータ

パラメーター説明
database 
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.

応答

コード説明
200
successful
202
Successfully accepted the request, but it is not completed yet.

Create a Function

POST/api/v2/databases/{database}/schemas/{schema}/functions
Create a function.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

ビュー

クエリパラメーター

パラメーター説明
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 Function

GET/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}
Fetch a Function using the describe command output.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

ビュー

パスパラメータ

パラメーター説明
nameWithArgs string
Function's name with Args

応答

コード説明
200
successful
202

Delete a function

DELETE/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}
Delete a function with the given name and args.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

ビュー

クエリパラメーター

パラメーター説明
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 Function

POST/api/v2/databases/{database}/schemas/{schema}/functions/{name}:execute
Execute a Function.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

ビュー

パスパラメータ

パラメーター説明
name 
Identifier (i.e. name) for the resource.

応答

コード説明
200
successful
202
言語: 日本語