Procedure

List procedures¶

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

Path Parameters¶

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

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 procedure¶

POST/api/v2/databases/{database}/schemas/{schema}/procedures
Create a procedure

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.
copyGrants boolean
Query parameter to enable copy grants when creating the object.

Response¶

CodeDescription
200
Successful request.
202

Fetch a procedure¶

GET/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}
Fetch a procedure

Path Parameters¶

ParameterDescription
nameWithArgs string
Function's name with Args

Response¶

CodeDescription
200
successful
202

Delete a procedure¶

DELETE/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}
Delete a procedure

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

Call a procedure¶

POST/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}:call
Call a procedure

Response¶

CodeDescription
200
successful
202