authors

date

version

snow_cli_version

Snowflake CLI

Snowflake CLI is next gen command line utility to interact with Snowflake.

Note

All commands has --help option
All command allows output format to be table(default) or json.

Install

pip install -U snowflake-cli-labs

or

pipx install snowflake-cli-labs

Get Help

snow --help

Information

General information about version of CLI and Python, default configuration path etc.,

snow  --info

Tip

The connection configuration config.toml by default is stored under$HOME/.snowflake. If you wish to change it set the environment variable $SNOWFLAKE_HOME¹ to director where you want to store the config.toml

Connection

Add

snow connection add

Adding connection cheatsheets following the prompts,

snow connection add

Adding connection using command options,

snow connection add --connection-name cheatsheets \
  --account <your-account-identifier> \
  --user <your-user> \
  --password <your-password>

Note

Currently need to follow the prompts for the defaults or add other parameters

List

snow connection list

Set Default

snow connection set-default cheatsheets

Test a Connection

snow connection test -c cheatsheets

Tip

If you don't specify -c, then it test with default connection that was set in the config

Cortex

Supported LLMs²

Large
- reka-core
- llama3-70b
- mistral-large
Medium
- snowflake-arctic(default)
- reka-flash
- mixtral-8x7b
- llama2-70b-chat
Small
- llama3-8b
- mistral-7b
- gemma-7b

Complete

Generate a response for a given prompt,

snow cortex complete "Tell me about Snowflake"

With a specific supported LLM,

snow cortex complete "Tell me about Snowflake" --model=mistral-7b

With history,

snow cortex complete --file samples/datacloud.json

Extract Answer

Get answer for the question from a text,

snow cortex extract-answer 'what does snowpark do ?' 'Snowpark provides a set of libraries and runtimes in Snowflake to securely deploy and process non-SQL code, including Python, Java and Scala.'

Get answers for the questions from a text file,

snow cortex extract-answer 'What does Snowflake eliminate?'  --file samples/answers.txt

snow cortex extract-answer 'What non-SQL code Snowpark process?'  --file samples/answers.txt

Sentiment

Sentiment Score	Sentiment
1	Positive
-1	Negative

A positive sentiment (score: 0.64) from a text,

snow cortex sentiment 'Snowflake is a awesome company to work.'

A negative sentiment ( approx score -0.4 ) from a text,

snow cortex sentiment --file samples/sentiment.txt

Summarize

From a text,

snow cortex summarize 'SnowCLI is next gen command line utility to interact with Snowflake. It supports manipulating lot of Snowflake objects from command line.'

From a file,

snow cortex summarize --file samples/asl_v2.txt

Translate

Currently supported languages

English(en)
French(fr)
German(de)
Polish(pl)
Japanese(ja)
Korean(ko)
Italian(it)
Portuguese(pt)
Spanish(es)
Swedish(sv)
Russian(ru)

Translate from English to French a text,

snow cortex translate --from en --to fr 'snowflake is an awesome company to work for.'

Translate from English to Spanish a text from a file,

snow cortex translate --from en --to es --file samples/translate.txt

Work with Snowflake Objects using SQL

Creating Objects

Simple one line query,

snow sql -q 'CREATE DATABASE FOO'

Loading DDL/DML commands from a file,

snow sql --filename my_objects.sql

Using Standard Input(stdin)

cat <<EOF | snow sql --stdin
CREATE OR REPLACE DATABASE FOO;
USE DATABASE FOO;
CREATE OR REPLACE SCHEMA CLI;
USE SCHEMA CLI;
CREATE OR ALTER TABLE employees(
  id int,
  first_name string,
  last_name string,
  dept int
);
EOF

Listing Objects

Use the following command to see the list of supported objects,

snow object list --help

Warehouses

List all available warehouses for the current role,

snow object list warehouse

Databases

List all available databases for the current role,

snow object list database

List all databases in JSON format,

snow object list database --format json

Tip

With JSON you can extract values using tools like jq e.g. to get only names of the databases

 snow object list database --format json | jq '.[].name'

List databases that starts with snow,

snow object list database --like '%snow%'

Schemas

List all schemas,

snow object list schema

Filtering schemas by database named foo,

snow object list schema --in database foo

Tables

List all tables

snow object list table

List tables in a specific schema cli of a database foo,

snow object list table --database foo --in schema cli

Describe an Object

Let us describe the table employees in the foo database' schema cli,

snow object describe table employees --database foo --schema cli

Drop an object

Drop an table named employees in schema cli of database foo,

snow object drop table employees --database foo --schema cli

Streamlit Applications

Create a Streamlit application and deploy to Snowflake,

snow streamlit init streamlit_app

Create a warehouse that the Streamlit application will use,

snow sql -q 'CREATE WAREHOUSE my_streamlit_warehouse'

Create a database that the Streamlit application will use,

snow sql -q 'CREATE DATABASE my_streamlit_app'

Deploy an Application

Important

Ensure you are in the Streamlit application folder before running the command.

snow streamlit deploy --database=my_streamlit_app

List Applications

List all available streamlit applications,

snow streamlit list

Describe Application

Get details about a streamlit application streamlit_app in schema of public of databasemy_streamlit_app,

snow streamlit describe streamlit_app --schema=public --database=my_streamlit_app

Note

When describing Streamlit application either provide the schema as parameter or use fully qualified name

Get Application URL

Get the streamlit application URL i.e. the URL used to access the hosted application,

snow streamlit get-url streamlit_app --database=my_streamlit_app

Drop Application

Drop a streamlit application named streamlit_app in schema of public of databasemy_streamlit_app,

snow streamlit drop streamlit_app --schema=public --database=my_streamlit_app

Stages

SnowCLI allows managing the internal stages.

Create

Create a stage named cli_stage in schema cli of database foo,

snow stage create cli_stage  --schema=cli --database=foo

Describe

Get details of stage,

snow stage describe cli_stage  --schema=cli --database=foo

List Stages

List all available stages,

snow stage list

List stages in specific to a database named foo,

snow stage list --in database foo

List stages by name that starts with cli in database foo,

snow stage list --like 'cli%' --in database foo

Copy Files

Download employees.csv,

curl -sSL -o employees.csv https://raw.githubusercontent.com/Snowflake-Labs/sf-cheatsheets/main/samples/employees.csv

Copy employees.csv to stage cli_stage to a path /data,

snow stage copy employees.csv '@cli_stage/data'  --schema=cli --database=foo

List Files in Stage

List all files in stage cli_stage in schema cli of database foo,

snow stage list-files cli_stage  --schema=cli --database=foo

List files by pattern,

snow stage list-files cli_stage --pattern='.*[.]csv' --schema=cli --database=foo

Execute Files From Stage

Download the load_employees.sql,

curl -sSL -o load_employees.sql https://raw.githubusercontent.com/Snowflake-Labs/sf-cheatsheets/main/samples/load_employees.sql

Copy load_employees.sql to stage cli_stage at path /sql,

snow stage copy load_employees.sql '@cli_stage/sql'  --schema=cli --database=foo

Execute the SQL³ from stage,

snow stage execute '@cli_stage/sql/load_employees.sql'  --schema=cli --database=foo

Note

Execute takes the glob pattern, allowing to specify the file pattern to execute. @stage/* or @stage/*.sql both executes only sql files

Query all employees to make sure the load worked,

snow sql --schema=cli --database=foo -q 'SELECT * FROM EMPLOYEES'

Download variables.sql,

curl -sSL -o variables.sql https://raw.githubusercontent.com/Snowflake-Labs/sf-cheatsheets/main/samples/variables.sql

Copy the variables.sql to stage,

snow stage copy  variables.sql '@cli_stage/sql' --schema=cli --database=foo

Execute files from stage with values for template variables({{.dept}} in variables.sql),

snow stage execute '@cli_stage/sql/variables.sql' --variable="dept=1"  --schema=cli --database=foo

Executing variables.sql would have created a view named EMPLOYEE_DEPT_VIEW, list the view it to see the variables replaced,

snow object list view --like 'emp%' --database=foo --schema=cli

Note

SnowCLI allows processing templating using {{...}} and &{...}

{{...}} is a preferred templating i.g Jinja templating for server side processing
&{...} is a preferred templating for client side processing
All client side context variables can be accessed using &{ctx.env.<var>} e.g. &{ctx.env.USER} returns the current OS user

Remove File(s) from Stage

Remove all files from stage cli_stage on path /data

snow stage remove cli_stage 'data/'  --schema=cli --database=foo

Native Apps

Create App

Create a Snowflake Native App my_first_app in current working directory,

snow app init my_first_app

Create a Snowflake Native App in directory my_first_app

snow app init --name 'my-first-app' my_first_app

Note

Since the name becomes a part of the application URL its recommended to have URL safe names

Create a Snowflake Native App with Streamlit Python template⁴

snow app init my_first_app --template streamlit-python

Note

You can also create your Snowflake Native App template and use --template-repo instead, to scaffold your Native App using your template.

Run App

From the application directory i.e. cd my_first_app

snow app run

Version App

![IMPORTANT] The version name should be valid SQL identifier i.e. no dots, no dashes and start with a character usually version labels use v.

Create Version

Create a development version named dev,

snow app version create

Create a development version named v1_0,

snow app version create v1_0

List available versions

snow app version list

Drop a Version

snow app version drop v1_0

Deploy a Version

Deploy a particular version of an application,

snow app run --version=v1_0

Deploy a particular version and patch,

snow app run --version=v1_0 --patch=1

Note

Version patches are automatically incremented when creating version with same name

Open App

Open the application on a browser,

snow app open

Deploy

Synchronize the local application file changes with stage and don't create/update the running application,

snow app deploy

Delete App

snow app teardown

If the application has version associated then drop the version,

snow app version drop

And then drop the application

snow app teardown

Drop application and its associated database objects,

snow app teardown --cascade

Snowpark Container Services(SPCS)

Important

SPCS is available only on certain AWS regions and not available for trial accounts
All Snowpark Containers are run using a defined compute pool.

Compute Pool

List of available instance families⁵

CPU_X64_XS
CPU_X64_S
CPU_X64_M
CPU_X64_L
HIGHMEM_X64_S
HIGHMEM_X64_M
HIGHMEM_X64_L
GPU_NV_S
GPU_NV_M
GPU_NV_L

Create

Create a compute pool named my_xs_compute_pool with family CPU_X64_XS,

snow spcs compute-pool create my_xs_compute_pool \
  --family CPU_X64_XS

Create with if not exists,

snow spcs compute-pool create my_xs_compute_pool \
  --family CPU_X64_XS --if-not-exists

Create with initially suspended (default: not suspended initially),

snow spcs compute-pool create my_xs_compute_pool \
  --family CPU_X64_XS --init-suspend

Create with auto suspend(default: 3600 secs) set to 2 mins(120 secs) ,

snow spcs compute-pool create my_xs_compute_pool \
  --family CPU_X64_XS --auto-suspend-secs=120

Create with minimum nodes(scale down) as 1(default) and maximum nodes(scale up) as 3

snow spcs compute-pool create my_xs_compute_pool \
  --family CPU_X64_XS --min-nodes=1 --max-nodes=3

Create with auto resume on service/job request,

snow spcs compute-pool create my_xs_compute_pool \
  --family CPU_X64_XS --auto-resume

Create with auto-resume disabled,

Note

Auto Resume disabled requires the compute pool to be started manually.

snow spcs compute-pool create my_xs_compute_pool \
  --family CPU_X64_XS --no-auto-resume

List Compute Pool

List all available compute pools for current role,

snow spcs compute-pool list

List compute pools like my_xs%

snow spcs compute-pool list --like 'my_xs%'

Describe Compute Pool

Get details about a compute pool,

snow spcs compute-pool describe my_xs_compute_pool

Status of Compute Pool

To know the current status of a compute pool,

snow spcs compute-pool status my_xs_compute_pool

Suspend a Compute Pool

Suspend a compute pool,

snow spcs compute-pool suspend my_xs_compute_pool

Resume a Compute Pool

Resume a compute pool,

snow spcs compute-pool resume my_xs_compute_pool

Properties on Compute Pool

You can set/unset the following properties on a compute pool after it's created,

Option	Description
`--min-nodes`	Minimum Node(s)
`--max-nodes`	Maximum Nodes(s)
`--auto-resume`	Enable Auto Resume
`--no-auto-resume`	Disable Auto Resume
`--auto-suspend-secs`	Auto Suspend in seconds
`--comment`	Comment

Set

Add a comment to the compute pool,

snow spcs compute-pool set --comment 'my small compute pool' my_xs_compute_pool

Unset

Remove the comment from compute pool,

snow spcs compute-pool unset --comment my_xs_compute_pool

Delete all services on Compute Pool

Delete all services running on a compute pool

snow spcs compute-pool stop-all my_xs_compute_pool

Drop Compute Pool

Drop the compute pool,

snow spcs compute-pool drop my_xs_compute_pool

Image Registry

Login

Important

This requires Docker on local system

snow spcs image-registry login

Token

Get current user token to access image registry,

snow spcs image-registry token

Registry URL

Get image registry URL,

snow spcs image-registry url

Image Repository

Important

A Database and Schema is required to create the Image Repository
Services can't be created using ACCOUNTADMIN, a custom role is required

The SQL script defines role, grants and warehouse.

As ACCOUNTADMIN run the script to setup required Snowflake resources,

A Role named cheatsheets_spcs_demo_role to create Snowpark Container Services
A Database named CHEATSHEETS_DB where the services will be attached to
A Schema named DATA_SCHEMA on DB CHEATSHEETS_DB to hold the image repository.
A Warehouse cheatsheets_spcs_wh_s which will be used to run query from services.

Set your Snowflake account user name,

export SNOWFLAKE_USER=<your snowflake user>

Run the spcs_setup.sql create the aforementioned Snowflake objects,

curl https://raw.githubusercontent.com/Snowflake-Labs/sf-cheatsheets/main/samples/spcs_setup.sql |
snow sql --stdin

Create

Create a image repository named my_image_repository,

snow spcs image-repository create my_image_repository \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Create with if not exists,

snow spcs image-repository create my_image_repository \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role' \
  --if-not-exists

Replace image repository my_image_repository,

snow spcs image-repository create my_image_repository \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role' \
  --replace

List Image Repositories

List all image repositories in the database and schema,

snow spcs image-repository list \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

URL

Get URL of the image repository my_image_repository,

snow spcs image-repository url my_image_repository \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

List Images

Let us push a sample image to repository,

IMAGE_REPOSITORY=$(snow spcs image-repository url my_image_repository \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA'  \
  --role='cheatsheets_spcs_demo_role')
docker pull --platform=linux/amd64 nginx
docker tag nginx "$IMAGE_REPOSITORY/nginx"
docker push "$IMAGE_REPOSITORY/nginx"

List all images in repository my_image_repository,

snow spcs image-repository list-images my_image_repository \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

List Image Tags

List all tags for image nginx in repository my_image_repository,

Important

The --image-name should be fully qualified name. Use list-images to get the fully qualified image name

snow spcs image-repository list-tags my_image_repository \
  --image-name=/CHEATSHEETS_DB/DATA_SCHEMA/my_image_repository/nginx \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Drop

snow spcs image-repository drop my_image_repository \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Services

Create a SPCS service specification⁶ file,

Tip

Tools like jq can help extract data from the command output e.g. to get the image name

export IMAGE=$(snow spcs image-repository list-images my_image_repository \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' --format json | jq -r '.[0].image')

cat <<EOF | tee work/service-spec.yaml
spec:
  containers:
    - name: nginx
      image: $IMAGE
      readinessProbe:
        port: 80
        path: /
  endpoints:
    - name: nginx
      port: 80
      public: true
EOF

Create a Service named nginx using compute pool my_xs_compute_pool and specification work/service-spec.yaml,

snow spcs service create nginx \
  --compute-pool=my_xs_compute_pool \
  --spec-path=work/service-spec.yaml \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Create a Service if not exists,

snow spcs service create nginx \
  --compute-pool=my_xs_compute_pool \
  --spec-path=work/service-spec.yaml \
  --if-not-exists \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Create with minimum instances 1 (default) and maximum instances to be 3,

snow spcs service create nginx \
  --compute-pool=my_xs_compute_pool \
  --spec-path=work/service-spec.yaml \
  --min-instances=1 \
  --max-instances=3 \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Create service that uses a specific warehouse cheatsheets_spcs_wh_s for all its queries,

snow spcs service create nginx \
  --compute-pool=my_xs_compute_pool \
  --spec-path=work/service-spec.yaml \
  --query-warehouse='cheatsheets_spcs_wh_s' \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Status

Check service status,

Note

It will take few minutes for the service to be in READY status

snow spcs service status nginx \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Describe

Get more details about the service,

snow spcs service describe nginx \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Check Logs of Service

Check the logs of service with the container named nginx with instance 0,

Note

Find instanceId and containerName using the command describe command.

snow spcs service logs nginx \
  --container-name=nginx \
  --instance-id=0 \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

List

List all available services,

snow spcs service list  \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Query services in database,

snow spcs service list  --in database CHEATSHEETS_DB \
  --role='cheatsheets_spcs_demo_role'

Query services in database and like ng%,

snow spcs service list  --in database CHEATSHEETS_DB --like 'ng%' \
  --role='cheatsheets_spcs_demo_role'

Service Endpoints

List the service endpoint for the service nginx,

snow spcs service list-endpoints nginx  \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Note

Open the ingress_url on the browser will take you to NGINX home page after authentication

Suspend a service

Suspend the service,

snow spcs service suspend nginx  \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Resume a service

Resume the service,

snow spcs service resume nginx  \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Note

Resume service will take few minutes, use the status command to check the status

Supported properties on Service

You can set/unset the following properties on a service even after it's created,

Option	Description
`--min-instances`	Minimum number of service instance(s), typically used while scaling down
`--max-instances`	Maximum number of service instance(s), typically used while scaling up
`--auto-resume`	Enable auto resume
`--no-auto-resume`	Disable auto resume
`--query-warehouse`	The Warehouse to use while doing query from the service
`--comment`	Comment for the service

Set

Add a comment to the service,

snow spcs service set --comment 'the nginx service' nginx  \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Use service describe to check on the updated property

Unset

Remove the comment from the service,

snow spcs service unset --comment nginx  \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Upgrade

Upgrade the service nginx with new specification e.g a tag upgrade or probe updates etc.,

snow spcs service upgrade nginx \
  --spec-path=work/service-spec_V2.yaml \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Drop

Drop a service named nginx

snow spcs service drop nginx \
  --database='CHEATSHEETS_DB' \
  --schema='DATA_SCHEMA' \
  --role='cheatsheets_spcs_demo_role'

Note

SPCS has compute associated with it, run the clean up script to clean the Snowflake resources created as part of this cheatsheet.

curl https://raw.githubusercontent.com/Snowflake-Labs/sf-cheatsheets/main/samples/spcs_cleanup.sql |
snow sql --stdin

References

Accelerate Development and Productivity with DevOps in Snowflake

Quickstarts

Snowflake Developers::Quickstart
Snowflake Developers::Getting Started With Snowflake CLI
Intro to Snowpark Container Services
Build a Data App and run it on Snowpark Container Services
Build Rag Based Equipment Maintenance App Using Snowflake Cortex
Build a Retrieval Augmented Generation (RAG) based LLM assistant using Streamlit and Snowflake Cortex

Documentation

Snowflake CLI
Execute Immediate Jinja Templating
Snowpark Native App Framework
Snowpark Container Services
Snowflake Cortex LLM Functions

Tutorials

Snowflake Native App Tutorial
Snowpark Container Services Tutorial

Footnotes

https://docs.snowflake.com/developer-guide/snowflake-cli-v2/connecting/specify-credentials#how-to-use-environment-variables-for-snowflake-credentials ↩
https://docs.snowflake.com/en/user-guide/snowflake-cortex/llm-functions#choosing-a-model ↩
https://docs.snowflake.com/en/sql-reference/sql/execute-immediate ↩
https://github.com/snowflakedb/native-apps-templates ↩
https://docs.snowflake.com/en/sql-reference/sql/create-compute-pool ↩
https://docs.snowflake.com/en/developer-guide/snowpark-container-services/specification-reference ↩

Files

snowflake-cli.md

Latest commit

History

snowflake-cli.md

File metadata and controls

Snowflake CLI

Install

Get Help

Information

Connection

Add

List

Set Default

Test a Connection

Cortex

Complete

Extract Answer

Sentiment

Summarize

Translate

Work with Snowflake Objects using SQL

Creating Objects

Listing Objects

Warehouses

Databases

Schemas

Tables

Describe an Object

Drop an object

Streamlit Applications

Deploy an Application

List Applications

Describe Application

Get Application URL

Drop Application

Stages

Create

Describe

List Stages

Copy Files

List Files in Stage

Execute Files From Stage

Remove File(s) from Stage

Native Apps

Create App

Run App

Version App

Create Version

Drop a Version

Deploy a Version

Open App

Deploy

Delete App

Snowpark Container Services(SPCS)

Compute Pool

Create

List Compute Pool

Describe Compute Pool

Status of Compute Pool

Suspend a Compute Pool

Resume a Compute Pool

Properties on Compute Pool

Set

Unset

Delete all services on Compute Pool

Drop Compute Pool

Image Registry

Login

Token

Registry URL

Image Repository

Create

List Image Repositories

URL

List Images

List Image Tags

Drop

Services

Status