external_volumes

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

Overview

Name	external_volumes
Type	Resource
Id	snowflake.external_volume.external_volumes

Fields

Name	Datatype	Description
name	string	String that specifies the identifier (the name) for the external volume; must be unique in your account.
allow_writes	boolean	Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog.
comment	string	String (literal) that specifies a comment for the external volume.
created_on	string	Date and time when the external volume was created.
owner	string	Role that owns the external volume
owner_role_type	string	The type of role that owns the external volume
storage_locations	array	Set of named cloud storage locations in different regions and, optionally, cloud platforms.

Methods

Name	Accessible by	Required Params	Optional Params	Description
fetch_external_volume	SELECT	name, endpoint	-	Fetch an external volume
list_external_volumes	SELECT	endpoint	like	List external volumes
create_external_volume	INSERT	data__name, data__storage_locations, endpoint	createMode	Create an external volume
delete_external_volume	DELETE	name, endpoint	ifExists	Delete an external volume
undrop_external_volume	EXEC	name, endpoint	-	Undrop an external volume

Optional Parameter Details

Name	Description	Type	Default
createMode	Query 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.	string	errorIfExists
ifExists	Query 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.	boolean	false
like	Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.	string	-

SELECT examples

List external volumes

SELECT
name,
allow_writes,
comment,
created_on,
owner,
owner_role_type,
storage_locations
FROM snowflake.external_volume.external_volumes
WHERE endpoint = '{{ endpoint }}';

INSERT example

Use the following StackQL query and manifest file to create a new external_volumes resource.

Required Properties

/*+ create */
INSERT INTO snowflake.external_volume.external_volumes (
data__name,
data__storage_locations,
data__allow_writes,
data__comment,
endpoint
)
SELECT 
'{{ name }}',
'{{ storage_locations }}',
'{{ allow_writes }}',
'{{ comment }}',
'{{ endpoint }}'
;

All Properties

/*+ create */
INSERT INTO snowflake.external_volume.external_volumes (
data__name,
data__storage_locations,
endpoint
)
SELECT 
'{{ name }}',
'{{ storage_locations }}',
'{{ endpoint }}'
;

Manifest

- name: external_volumes
  props:
    - name: data__name
      value: string
    - name: data__storage_locations
      value: string
    - name: endpoint
      value: string
    - name: name
      value: string
    - name: storage_locations
      value: array
      props:
        - name: name
          value: string
        - name: storage_provider
          value: string
    - name: allow_writes
      value: boolean
    - name: comment
      value: string

DELETE example

Deletes the specified external_volumes resource.

/*+ delete */
DELETE FROM snowflake.external_volume.external_volumes
WHERE name = '{{ name }}'
AND endpoint = '{{ endpoint }}';