sequences

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

Overview

Name	sequences
Type	Resource
Id	snowflake.pipelines.sequences

Fields

The following fields are returned by SELECT queries:

get

successful

Name	Datatype	Description
name	string	Name of the sequence (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
database_name	string	Database in which the sequence is stored (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
schema_name	string	Schema in which the sequence is stored (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
comment	string	Comment for the sequence
created_on	string (date-time)	Date and time when the sequence was created.
increment	integer (int64)	Step interval of the sequence
ordered	boolean	Whether or not the values are generated in increasing or decreasing order
owner	string	Role that owns the sequence (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
owner_role_type	string	The type of role that owns the sequence
start	integer (int64)	First value returned by the sequence

list

A Snowflake sequence

Name	Datatype	Description
name	string	Name of the sequence (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
database_name	string	Database in which the sequence is stored (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
schema_name	string	Schema in which the sequence is stored (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
comment	string	Comment for the sequence
created_on	string (date-time)	Date and time when the sequence was created.
increment	integer (int64)	Step interval of the sequence
ordered	boolean	Whether or not the values are generated in increasing or decreasing order
owner	string	Role that owns the sequence (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
owner_role_type	string	The type of role that owns the sequence
start	integer (int64)	First value returned by the sequence

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	database_name, schema_name, name, endpoint		Fetch a sequence
list	select	database_name, schema_name, endpoint	like	List sequences
create	insert	database_name, schema_name, endpoint, name	createMode	Create a sequence
delete	delete	database_name, schema_name, name, endpoint	ifExists	Delete a sequence
clone	exec	database_name, schema_name, name, endpoint, name	createMode, targetDatabase, targetSchema	Create a new sequence by cloning from the specified resource
rename	exec	database_name, schema_name, name, targetName, endpoint	ifExists, targetDatabase, targetSchema	Rename a sequence with a new identifier

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	string	Identifier (i.e. name) for the resource.
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.
targetName	string	Name of the target resource.
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.
targetDatabase	string	Database of the target resource. Defaults to the source's database
targetSchema	string	Schema of the target resource. Defaults to the source's schema

SELECT examples

get

Fetch a sequence

SELECT
name,
database_name,
schema_name,
comment,
created_on,
increment,
ordered,
owner,
owner_role_type,
start
FROM snowflake.pipelines.sequences
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List sequences

SELECT
name,
database_name,
schema_name,
comment,
created_on,
increment,
ordered,
owner,
owner_role_type,
start
FROM snowflake.pipelines.sequences
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND "like" = '{{ like }}'
;

INSERT examples

create

Create a sequence

INSERT INTO snowflake.pipelines.sequences (
start,
increment,
ordered,
comment,
name,
database_name,
schema_name,
endpoint,
createMode
)
SELECT 
{{ start }},
{{ increment }},
{{ ordered }},
'{{ comment }}',
'{{ name }}' /* required */,
'{{ database_name }}',
'{{ schema_name }}',
'{{ endpoint }}',
'{{ createMode }}'
RETURNING
status
;

Manifest

# Description fields are for documentation purposes
- name: sequences
props:
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the sequences resource.
  - name: schema_name
    value: "{{ schema_name }}"
    description: Required parameter for the sequences resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the sequences resource.
  - name: start
    value: {{ start }}
    description: |
      First value returned by the sequence
  - name: increment
    value: {{ increment }}
    description: |
      Step interval of the sequence
  - name: ordered
    value: {{ ordered }}
    description: |
      Whether or not the values are generated in increasing or decreasing order
  - name: comment
    value: "{{ comment }}"
    description: |
      Comment for the sequence
  - name: name
    value: "{{ name }}"
    description: |
      Name of the sequence
  - 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.

DELETE examples

delete

Delete a sequence

DELETE FROM snowflake.pipelines.sequences
WHERE database_name = '{{ database_name }}' --required
AND schema_name = '{{ schema_name }}' --required
AND name = '{{ name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND ifExists = '{{ ifExists }}'
;

Lifecycle Methods

clone

Create a new sequence by cloning from the specified resource

EXEC snowflake.pipelines.sequences.clone 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@createMode='{{ createMode }}', 
@targetDatabase='{{ targetDatabase }}', 
@targetSchema='{{ targetSchema }}' 
@@json=
'{
"start": {{ start }}, 
"increment": {{ increment }}, 
"ordered": {{ ordered }}, 
"comment": "{{ comment }}", 
"name": "{{ name }}"
}'
;

rename

Rename a sequence with a new identifier

EXEC snowflake.pipelines.sequences.rename 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@targetName='{{ targetName }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@ifExists={{ ifExists }}, 
@targetDatabase='{{ targetDatabase }}', 
@targetSchema='{{ targetSchema }}'
;