Function
List Functions¶
GET/api/v2/databases/{database}/schemas/{schema}/functions
Lists the user functions under the database and schema.
パスパラメータ¶
| パラメーター | 型 | 説明 |
|---|---|---|
| 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 [
{
"function_type": "service-function",
"name": "string",
"arguments": [
{
"name": "string",
"datatype": "FIXED",
"value": null
}
],
"returns": "FIXED",
"max_batch_rows": 0,
"created_on": "2019-08-24T14:15:22Z",
"signature": "string",
"language": "string",
"body": "string"
}
]
| |||||||||
| 202 | Successfully accepted the request, but it is not completed yet. {
"code": "392604",
"message": "Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management."
}
|
| 400 | Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the request body for retry. |
| 401 | Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a new access token for retry. |
| 403 | Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled. |
| 404 | Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled. |
| 405 | Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST. |
| 429 | Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints. |
| 500 | Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support. |
| 503 | Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended. |
| 504 | Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended. |
| パラメーター | 型 | 説明 |
|---|
Create a Function¶
POST/api/v2/databases/{database}/schemas/{schema}/functions
Create a function.
クエリパラメーター¶
| パラメーター | 型 | 説明 |
|---|---|---|
| createMode | string | Query parameter allowing support for different modes of resource creation. Possible values include:
|
| パラメーター | 型 | 説明 |
|---|
{
"function_type": "service-function",
"name": "string",
"arguments": [
{
"name": "string",
"datatype": "FIXED",
"value": null
}
],
"returns": "FIXED",
"max_batch_rows": 0,
"created_on": "2019-08-24T14:15:22Z",
"signature": "string",
"language": "string",
"body": "string"
}応答¶
| コード | 説明 | ||||
|---|---|---|---|---|---|
| 200 | Successful request. {
"status": "Request successfully completed"
}
| ||||
| 202 |
| 400 | |
| 401 | |
| 403 | |
| 404 | |
| 405 | |
| 408 | Request Timeout. This indicates that the request from the client timed out and was not completed by the server. |
| 409 | Conflict. The requested operation could not be performed due to a conflicting state that could not be resolved. This usually happens when a CREATE request was performed when there is a pre-existing resource with the same name, and also without one of the options orReplace/ifNotExists. |
| 429 | |
| 500 | |
| 503 | |
| 504 |
| パラメーター | 型 | 説明 |
|---|---|---|
| status | string | Message returned by the server. |
Fetch a Function¶
GET/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}
Fetch a Function using the describe command output.
パスパラメータ¶
| パラメーター | 型 | 説明 |
|---|---|---|
| nameWithArgs | string | Function's name with Args |
応答¶
| コード | 説明 | ||||||
|---|---|---|---|---|---|---|---|
| 200 | successful {
"function_type": "service-function",
"name": "string",
"arguments": [
{
"name": "string",
"datatype": "FIXED",
"value": null
}
],
"returns": "FIXED",
"max_batch_rows": 0,
"created_on": "2019-08-24T14:15:22Z",
"signature": "string",
"language": "string",
"body": "string"
}
| ||||||
| 202 |
| 400 | |
| 401 | |
| 403 | |
| 404 | |
| 405 | |
| 429 | |
| 500 | |
| 503 | |
| 504 |
| パラメーター | 型 | 説明 |
|---|
Delete a function¶
DELETE/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}
Delete a function with the given name and args.
クエリパラメーター¶
| パラメーター | 型 | 説明 |
|---|---|---|
| ifExists | boolean | Query parameter that specifies how to handle the request for a resource that does not exist:
|
応答¶
| コード | 説明 |
|---|---|
| 200 | |
| 202 |
| 400 | |
| 401 | |
| 403 | |
| 404 | |
| 405 | |
| 429 | |
| 500 | |
| 503 | |
| 504 |
Execute a Function¶
POST/api/v2/databases/{database}/schemas/{schema}/functions/{name}:execute
Execute a Function.
パスパラメータ¶
| パラメーター | 型 | 説明 |
|---|---|---|
| name | Identifier (i.e. name) for the resource. |
| パラメーター | 型 | 説明 |
|---|
[
{
"name": "string",
"datatype": "FIXED",
"value": null
}
]応答¶
| コード | 説明 | ||||
|---|---|---|---|---|---|
| 200 | successful {}
| ||||
| 202 |
| 400 | |
| 401 | |
| 403 | |
| 404 | |
| 405 | |
| 429 | |
| 500 | |
| 503 | |
| 504 |
| パラメーター | 型 | 説明 |
|---|