artifact_repositories

Creates, updates, deletes, gets or lists an artifact_repositories resource.

Overview

Name	artifact_repositories
Type	Resource
Id	snowflake.apps.artifact_repositories

Fields

The following fields are returned by SELECT queries:

get

successful

Name	Datatype	Description
name	string	Name of the artifact repository (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
database_name	string	Database in which the artifact repository is stored (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
schema_name	string	Schema in which the artifact repository is stored (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
api_integration	string	Link to an integration object
comment	string	user comment associated to an object in the dictionary
created_on	string (date-time)	Date and time when the artifact repository was created.
owner	string	Role that owns the artifact repository (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
owner_role_type	string	The type of role that owns the artifact repository (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
type	string	Specifies the type of the repository. The only current supported option is ‘PIP’. (PIP)

list

A Snowflake artifact repository

Name	Datatype	Description
name	string	Name of the artifact repository (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
database_name	string	Database in which the artifact repository is stored (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
schema_name	string	Schema in which the artifact repository is stored (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
api_integration	string	Link to an integration object
comment	string	user comment associated to an object in the dictionary
created_on	string (date-time)	Date and time when the artifact repository was created.
owner	string	Role that owns the artifact repository (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
owner_role_type	string	The type of role that owns the artifact repository (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
type	string	Specifies the type of the repository. The only current supported option is ‘PIP’. (PIP)

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 an artifact repository
list	select	database_name, schema_name, endpoint	like, startsWith, showLimit, fromName	List artifact repositories
create	insert	database_name, schema_name, endpoint, name, type, api_integration	createMode	Create an artifact repository
create_or_alter	replace	database_name, schema_name, artifact_repository_name, endpoint, name, type, api_integration		Create or update an artifact repository
delete	delete	database_name, schema_name, name, endpoint	ifExists	Delete an artifact repository
rename	exec	database_name, schema_name, name, targetName, endpoint	ifExists, targetDatabase, targetSchema	Changes the name of an artifact repository

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
artifact_repository_name	string	Identifier (i.e. name) for the resource.
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.
fromName	string	Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.
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.
showLimit	integer	Parameter to limit the maximum number of rows returned by a command.
startsWith	string	Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
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 an artifact repository

SELECT
name,
database_name,
schema_name,
api_integration,
comment,
created_on,
owner,
owner_role_type,
type
FROM snowflake.apps.artifact_repositories
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List artifact repositories

SELECT
name,
database_name,
schema_name,
api_integration,
comment,
created_on,
owner,
owner_role_type,
type
FROM snowflake.apps.artifact_repositories
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND "like" = '{{ like }}'
AND startsWith = '{{ startsWith }}'
AND showLimit = '{{ showLimit }}'
AND fromName = '{{ fromName }}'
;

INSERT examples

create

Create an artifact repository

INSERT INTO snowflake.apps.artifact_repositories (
name,
type,
comment,
api_integration,
database_name,
schema_name,
endpoint,
createMode
)
SELECT 
'{{ name }}' /* required */,
'{{ type }}' /* required */,
'{{ comment }}',
'{{ api_integration }}' /* required */,
'{{ database_name }}',
'{{ schema_name }}',
'{{ endpoint }}',
'{{ createMode }}'
RETURNING
status
;

Manifest

# Description fields are for documentation purposes
- name: artifact_repositories
props:
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the artifact_repositories resource.
  - name: schema_name
    value: "{{ schema_name }}"
    description: Required parameter for the artifact_repositories resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the artifact_repositories resource.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the artifact repository
  - name: type
    value: "{{ type }}"
    description: |
      Specifies the type of the repository. The only current supported option is ‘PIP’.
    valid_values: ['PIP']
  - name: comment
    value: "{{ comment }}"
    description: |
      user comment associated to an object in the dictionary
  - name: api_integration
    value: "{{ api_integration }}"
    description: |
      Link to an integration object
  - 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.

REPLACE examples

create_or_alter

Create or update an artifact repository

REPLACE snowflake.apps.artifact_repositories
SET 
name = '{{ name }}',
type = '{{ type }}',
comment = '{{ comment }}',
api_integration = '{{ api_integration }}'
WHERE 
database_name = '{{ database_name }}' --required
AND schema_name = '{{ schema_name }}' --required
AND artifact_repository_name = '{{ artifact_repository_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND name = '{{ name }}' --required
AND type = '{{ type }}' --required
AND api_integration = '{{ api_integration }}' --required
RETURNING
status;

DELETE examples

delete

Delete an artifact repository

DELETE FROM snowflake.apps.artifact_repositories
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

rename

Changes the name of an artifact repository

EXEC snowflake.apps.artifact_repositories.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 }}'
;