Function

List Functions¶

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

Path Parameters¶

ParameterDescription
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.

Query Parameters¶

ParameterDescription
like string
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.

Response¶

CodeDescription
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.

Query Parameters¶

ParameterDescription
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.

Response¶

CodeDescription
200
Successful request.
202

Fetch a Function¶

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

Path Parameters¶

ParameterDescription
nameWithArgs string
Function's name with Args

Response¶

CodeDescription
200
successful
202

Delete a function¶

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

Query Parameters¶

ParameterDescription
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.

Response¶

CodeDescription
200
202

Execute a Function¶

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

Path Parameters¶

ParameterDescription
name 
Identifier (i.e. name) for the resource.

Response¶

CodeDescription
200
successful
202
Language: English