procedures

Creates, updates, deletes, gets or lists a procedures resource.

Overview

Name	procedures
Type	Resource
Id	snowflake.functions.procedures

Fields

The following fields are returned by SELECT queries:

get

successful

Name	Datatype	Description
name	string	Name of the procedure (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
database_name	string	The name of the database in which the function/procedure exists. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
schema_name	string	The name of the schema in which the function/procedure exists. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
arguments	array	List of arguments for the function/procedure
body	string	Function/procedure definition
comment	string	Specifies a comment for the function/procedure
created_on	string (date-time)	The date and time when the function/procedure was created
execute_as	string	What permissions should the procedure execution be called with (CALLER, OWNER)
is_builtin	boolean	If the function/procedure is built-in or not (user-defined)
is_secure	boolean	Specifies whether the function/procedure is secure or not
language_config	object	Language that the function/procedure is written in
max_num_arguments	integer	The maximum number of arguments
min_num_arguments	integer	The minimum number of arguments
owner	string	Role that owns the function/procedure
owner_role_type	string	The type of role that owns the function/procedure
return_type	object	Return type of the function/procedure. Should be a SQL data type or a table

list

A Snowflake procedure

Name	Datatype	Description
name	string	Name of the procedure (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
database_name	string	The name of the database in which the function/procedure exists. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
schema_name	string	The name of the schema in which the function/procedure exists. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
arguments	array	List of arguments for the function/procedure
body	string	Function/procedure definition
comment	string	Specifies a comment for the function/procedure
created_on	string (date-time)	The date and time when the function/procedure was created
execute_as	string	What permissions should the procedure execution be called with (CALLER, OWNER)
is_builtin	boolean	If the function/procedure is built-in or not (user-defined)
is_secure	boolean	Specifies whether the function/procedure is secure or not
language_config	object	Language that the function/procedure is written in
max_num_arguments	integer	The maximum number of arguments
min_num_arguments	integer	The minimum number of arguments
owner	string	Role that owns the function/procedure
owner_role_type	string	The type of role that owns the function/procedure
return_type	object	Return type of the function/procedure. Should be a SQL data type or a table

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	database_name, schema_name, name_with_args, endpoint		Fetch a procedure
list	select	database_name, schema_name, endpoint	like	List procedures
create	insert	database_name, schema_name, endpoint, name, arguments, return_type, language_config, body	createMode, copyGrants	Create a procedure
delete	delete	database_name, schema_name, name_with_args, endpoint	ifExists	Delete a procedure
call	exec	database_name, schema_name, name_with_args, endpoint, call_arguments		Call a procedure

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
database_name	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.
endpoint	string	Organization and account identifier (orgname-accountname) (default: orgname-accountname)
name_with_args	string	Function's name with Args
schema_name	string	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.
copyGrants	boolean	Parameter to enable copy grants when creating the object.
createMode	string	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.
ifExists	boolean	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.
like	string	Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.

SELECT examples

get

Fetch a procedure

SELECT
name,
database_name,
schema_name,
arguments,
body,
comment,
created_on,
execute_as,
is_builtin,
is_secure,
language_config,
max_num_arguments,
min_num_arguments,
owner,
owner_role_type,
return_type
FROM snowflake.functions.procedures
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND name_with_args = '{{ name_with_args }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List procedures

SELECT
name,
database_name,
schema_name,
arguments,
body,
comment,
created_on,
execute_as,
is_builtin,
is_secure,
language_config,
max_num_arguments,
min_num_arguments,
owner,
owner_role_type,
return_type
FROM snowflake.functions.procedures
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND "like" = '{{ like }}'
;

INSERT examples

create

Create a procedure

INSERT INTO snowflake.functions.procedures (
name,
execute_as,
is_secure,
arguments,
return_type,
language_config,
comment,
body,
database_name,
schema_name,
endpoint,
createMode,
copyGrants
)
SELECT 
'{{ name }}' /* required */,
'{{ execute_as }}',
{{ is_secure }},
'{{ arguments }}' /* required */,
'{{ return_type }}' /* required */,
'{{ language_config }}' /* required */,
'{{ comment }}',
'{{ body }}' /* required */,
'{{ database_name }}',
'{{ schema_name }}',
'{{ endpoint }}',
'{{ createMode }}',
'{{ copyGrants }}'
RETURNING
status
;

Manifest

# Description fields are for documentation purposes
- name: procedures
props:
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the procedures resource.
  - name: schema_name
    value: "{{ schema_name }}"
    description: Required parameter for the procedures resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the procedures resource.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the procedure
  - name: execute_as
    value: "{{ execute_as }}"
    description: |
      What permissions should the procedure execution be called with
    valid_values: ['CALLER', 'OWNER']
  - name: is_secure
    value: {{ is_secure }}
    description: |
      Specifies whether the function/procedure is secure or not
  - name: arguments
    description: |
      List of arguments for the function/procedure
    value:
      - name: "{{ name }}"
        datatype: "{{ datatype }}"
        default_value: "{{ default_value }}"
  - name: return_type
    description: |
      Return type of the function/procedure. Should be a SQL data type or a table
    value:
      type: "{{ type }}"
  - name: language_config
    description: |
      Language that the function/procedure is written in
    value:
      language: "{{ language }}"
      called_on_null_input: {{ called_on_null_input }}
  - name: comment
    value: "{{ comment }}"
    description: |
      Specifies a comment for the function/procedure
  - name: body
    value: "{{ body }}"
    description: |
      Function/procedure definition
  - name: createMode
    value: "{{ createMode }}"
    description: 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.
    description: 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.
  - name: copyGrants
    value: {{ copyGrants }}
    description: Parameter to enable copy grants when creating the object.
    description: Parameter to enable copy grants when creating the object.

DELETE examples

delete

Delete a procedure

DELETE FROM snowflake.functions.procedures
WHERE database_name = '{{ database_name }}' --required
AND schema_name = '{{ schema_name }}' --required
AND name_with_args = '{{ name_with_args }}' --required
AND endpoint = '{{ endpoint }}' --required
AND ifExists = '{{ ifExists }}'
;

Lifecycle Methods

call

Call a procedure

EXEC snowflake.functions.procedures.call 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name_with_args='{{ name_with_args }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"call_arguments": "{{ call_arguments }}"
}'
;