Sign in

v1

latestOpenAPI 3.0.0raw.githubusercontent.com2024-06-14254049.0 KB
Functions

Get a function

Gets a function from within a parent catalog and schema.

get/functions/{name}

Response

The function was successfully retrieved.

namestring

Name of function, relative to parent schema.

catalog_namestring

Name of parent catalog.

schema_namestring

Name of parent schema relative to its parent catalog.

data_type'BOOLEAN' | 'BYTE' | 'SHORT' | 'INT' | 'LONG' | 'FLOAT' | 'DOUBLE' | 'DATE' | 'TIMESTAMP' | 'TIMESTAMP_NTZ' | 'STRING' | 'BINARY' | 'DECIMAL' | 'INTERVAL' | 'ARRAY' | 'STRUCT' | 'MAP' | 'CHAR' | 'NULL' | 'USER_DEFINED_TYPE' | 'TABLE_TYPE'

Name of type (INT, STRUCT, MAP, etc.).

full_data_typestring

Pretty printed function data type.

routine_body'SQL' | 'EXTERNAL'

Function language. When EXTERNAL is used, the language of the routine function should be specified in the external_language field, and the return_params of the function cannot be used (as TABLE return type is not supported), and the sql_data_access field must be NO_SQL.

routine_definitionstring

Function body.

parameter_style'S'

Function parameter style. S is the value for SQL.

is_deterministicboolean

Whether the function is deterministic.

sql_data_access'CONTAINS_SQL' | 'READS_SQL_DATA' | 'NO_SQL'

Function SQL data access.

is_null_callboolean

Function null call.

security_type'DEFINER'

Function security type.

specific_namestring

Specific name of the function; Reserved for future use.

commentstring

User-provided free-form text description.

propertiesstring

JSON-serialized key-value pair map, encoded (escaped) as a string.

full_namestring

Full name of function, in form of catalog_name.schema_name.function__name

created_atinteger

Time at which this function was created, in epoch milliseconds.

updated_atinteger

Time at which this function was last updated, in epoch milliseconds.

function_idstring

Id of Function, relative to parent schema.

external_languagestring

External language of the function.