snow sql¶

구문¶

snow sql
  --query <query>
  --filename <files>
  --stdin
  --variable <data_override>
  --retain-comments
  --single-transaction / --no-single-transaction
  --project <project_definition>
  --env <env_overrides>
  --connection <connection>
  --host <host>
  --port <port>
  --account <account>
  --user <user>
  --password <password>
  --authenticator <authenticator>
  --private-key-file <private_key_file>
  --token-file-path <token_file_path>
  --database <database>
  --schema <schema>
  --role <role>
  --warehouse <warehouse>
  --temporary-connection
  --mfa-passcode <mfa_passcode>
  --enable-diag
  --diag-log-path <diag_log_path>
  --diag-allowlist-path <diag_allowlist_path>
  --oauth-client-id <oauth_client_id>
  --oauth-client-secret <oauth_client_secret>
  --oauth-authorization-url <oauth_authorization_url>
  --oauth-token-request-url <oauth_token_request_url>
  --oauth-redirect-uri <oauth_redirect_uri>
  --oauth-scope <oauth_scope>
  --oauth-disable-pkce
  --oauth-enable-refresh-tokens
  --oauth-enable-single-use-refresh-tokens
  --client-store-temporary-credential
  --format <format>
  --verbose
  --debug
  --silent
  --enhanced-exit-codes

인자¶

없음

선택 사항¶

--query, -q TEXT

실행할 쿼리입니다.

--filename, -f FILE

실행할 파일입니다. 기본값: [].

--stdin, -i

표준 입력에서 쿼리를 읽습니다. 이 명령으로 입력을 파이프할 때 사용합니다. 기본값: False.

--variable, -D TEXT

키=값 형식의 문자열. 제공된 경우 SQL 콘텐츠는 템플릿으로 취급되며 제공된 데이터를 사용하여 렌더링됩니다.

--retain-comments

Snowflake에 전달된 쿼리의 설명을 유지합니다. 기본값: False.

--single-transaction / --no-single-transaction

자동 커밋이 비활성화된 상태로 연결합니다. 문을 BEGIN/COMMIT으로 둘러싸 단일 트랜잭션으로 실행하여 모든 명령이 성공적으로 완료되거나 아무런 변경 사항도 적용되지 않도록 합니다. 기본값: False.

-p, --project TEXT

Snowflake 프로젝트가 저장된 경로입니다. 현재 작업 디렉터리로 기본 설정됩니다.

--env TEXT

키=값 형식의 문자열입니다. 템플릿에 사용되는 환경 섹션의 변수를 재정의합니다. 기본값: [].

--connection, -c, --environment TEXT

config.toml 파일에 정의된 연결의 이름입니다. 기본값: default.

--host TEXT

연결을 위한 호스트 주소입니다. 연결에 지정된 값을 재정의합니다.

--port INTEGER

연결의 포트입니다. 연결에 지정된 값을 재정의합니다.

--account, --accountname TEXT

Snowflake 계정에 할당된 이름입니다. 연결에 지정된 값을 재정의합니다.

--user, --username TEXT

Snowflake에 연결할 사용자 이름입니다. 연결에 지정된 값을 재정의합니다.

--password TEXT

Snowflake 비밀번호입니다. 연결에 지정된 값을 재정의합니다.

--authenticator TEXT

Snowflake 인증자입니다. 연결에 지정된 값을 재정의합니다.

--private-key-file, --private-key-path TEXT

Snowflake 개인 키 파일 경로입니다. 연결에 지정된 값을 재정의합니다.

--token-file-path TEXT

Snowflake에 연결할 때 사용할 OAuth 토큰이 포함된 파일 경로입니다.

--database, --dbname TEXT

사용할 데이터베이스입니다. 연결에 지정된 값을 재정의합니다.

--schema, --schemaname TEXT

사용할 데이터베이스 스키마입니다. 연결에 지정된 값을 재정의합니다.

--role, --rolename TEXT

사용할 역할입니다. 연결에 지정된 값을 재정의합니다.

--warehouse TEXT

사용할 웨어하우스입니다. 연결에 지정된 값을 재정의합니다.

--temporary-connection, -x

Config에 정의된 연결 대신 명령줄 매개 변수로 정의된 연결을 사용합니다. 기본값: False.

--mfa-passcode TEXT

다단계 인증(MFA)에 사용할 토큰입니다.

--enable-diag

연결 진단 보고서를 생성할지 여부입니다. 기본값: False.

--diag-log-path TEXT

생성된 보고서의 경로입니다. 기본값은 시스템 임시 디렉터리입니다. 기본값: <system_temporary_directory>.

--diag-allowlist-path TEXT

허용 목록 매개 변수가 포함된 JSON 파일의 경로입니다.

--oauth-client-id TEXT

Snowflake 통합을 위해 ID 공급자가 제공한 클라이언트 ID의 값입니다.

--oauth-client-secret TEXT

Snowflake 통합을 위해 ID 공급자가 제공한 클라이언트 시크릿의 값입니다.

--oauth-authorization-url TEXT

드라이버에 인증 코드를 제공하는 ID 공급자 엔드포인트입니다.

--oauth-token-request-url TEXT

드라이버에 액세스 토큰을 제공하는 ID 공급자 엔드포인트입니다.

--oauth-redirect-uri TEXT

인증 코드 리디렉션에 사용할 URI 입니다.

--oauth-scope TEXT

ID 공급자 승인 요청에서 요청된 범위입니다.

--oauth-disable-pkce

PKCE (Proof Key for Code Exchange)를 비활성화합니다. 기본값: False.

--oauth-enable-refresh-tokens

실제 액세스 토큰이 오래되었을 때 자동 재인증을 활성화합니다. 기본값: False.

--oauth-enable-single-use-refresh-tokens

일회용 새로 고침 토큰 시맨틱에 옵트인할지 여부입니다. 기본값: False.

--client-store-temporary-credential

임시 자격 증명을 저장합니다.

--format [TABLE|JSON]

출력 형식을 지정합니다. 기본값: TABLE.

--verbose, -v

로그 수준 정보 이상에 대한 로그 항목을 표시합니다. 기본값: False.

--debug

로그 수준 디버그 이상에 대한 로그 항목을 표시하며, 디버그 로그에는 추가 정보가 포함됩니다. 기본값: False.

--silent

콘솔로의 중간 출력을 끕니다. 기본값: False.

--enhanced-exit-codes

실패 유형에 따라 종료 오류 코드를 차별화하십시오. 기본값: False.

--help

이 명령에 대한 도움말 텍스트를 표시합니다.

사용법 노트¶

다음 옵션 중 하나를 사용하여 실행할 SQL 쿼리를 지정할 수 있습니다.

• --query 옵션을 사용하여 쿼리 문자열을 지정합니다.

• --filename 옵션을 사용하여 SQL 쿼리가 포함된 하나 이상의 파일을 실행합니다. 예:

  • snow sql -f myfile.sql

  • snow sql -f file1.sql -f file2.sql

• 쿼리를 stdin 으로 지정하고 snow sql 명령으로 파이프합니다(예: cat my.sql | snow sql.).

• 쿼리에 SYSTEM 함수 의 달러 기호 등 셸에서 해석하지 않으려는 특수 문자가 포함되어 있는 경우 다음 중 하나를 수행할 수 있습니다.

  • 다음과 같이 큰따옴표 대신 작은따옴표로 쿼리를 묶습니다.

    snow sql -q 'SELECT SYSTEM$CLIENT_VERSION_INFO()'

  • 다음에서와 같이, 특수 문자를 이스케이프합니다.

    snow sql -q "SELECT SYSTEM\$CLIENT_VERSION_INFO()"

• 변수를 사용하여 SQL 쿼리의 <% variable_name %> 자리표시자와 -D 명령줄 옵션의 조합으로 SQL 쿼리를 템플릿화할 수 있습니다

  snow sql -q "select * from my-database order by <% column_name %>" -D "column_name=Country"
  

  Copy

  참고

  현재 템플릿에는 SnowSQL &variable_name 및 <% variable_name %> 구문을 사용할 수 있습니다. 그러나 Snowflake는 <% variable_name %> 구문을 사용할 것을 권장합니다.

• 쿼리에서 스크립트 블록을 지정합니다. 예:

  EXECUTE IMMEDIATE $$
  -- Snowflake Scripting code
  DECLARE
    radius_of_circle FLOAT;
    area_of_circle FLOAT;
  BEGIN
    radius_of_circle := 3;
    area_of_circle := pi() * radius_of_circle * radius_of_circle;
    RETURN area_of_circle;
  END;
  $$
  ;
  

  Copy

  참고

  Snowflake CLI 명령줄에서 스크립트 블록을 직접 지정하는 경우, 일부 셸에서는 해당 구분 기호를 다른 것으로 해석하기 때문에 $$ 구분 기호가 작동하지 않을 수 있습니다. 예를 들어 bash 및 zsh 셸은 이를 프로세스 ID (PID)로 해석합니다. 이 제한을 해결하려면 다음과 같은 대안을 사용할 수 있습니다.

  • 그래도 명령줄에서 스크립트 블록을 지정하려면 \$\$ 에서처럼 $$ 구분 기호를 이스케이프 처리하면 됩니다.

  • 기본 $$ 구분 기호가 있는 스크립트 블록을 별도의 파일에 넣고 snow sql -f <filename> 명령으로 호출할 수도 있습니다.

snow sql --enhanced-exit-codes -q 'select 1' -f my.query

echo $?

2

snow sql

$ snow sql
  ╭───────────────────────────────────────────────────────────────────────────────────╮
  │ Welcome to Snowflake-CLI REPL                                                   │
  │ Type 'exit' or 'quit' to leave                                                  │
  ╰───────────────────────────────────────────────────────────────────────────────────╯
  >

> create table my_table (c1 int);

+-------------------------------------+
| status                              |
|-------------------------------------|
| Table MY_TABLE successfully created.|
+-------------------------------------+

예¶

• 다음 예제에서는 SQL SYSTEM$CLIENT_VERSION_INFO 시스템 함수를 사용하여 클라이언트 및 드라이버에 대한 버전 정보를 반환합니다.

  snow sql --query 'SELECT SYSTEM$CLIENT_VERSION_INFO();'
  

  Copy

  select current_version();
  +-------------------+
  | CURRENT_VERSION() |
  |-------------------|
  | 8.25.1            |
  +-------------------+
  

• 다음 예제는 클라이언트 측 변수를 사용하여 데이터베이스를 지정하는 방법을 보여줍니다.

  snow sql -q "select * from <% database %>.logs" -D "database=dev"
  

  Copy

  명령이 실행되면 <% database %> 변수의 값 dev 를 대체하여 dev.logs 식별자를 생성한 다음 select * from dev.logs SQL 쿼리를 처리하기 위해 Snowflake로 보냅니다.

  참고

  현재 템플릿에는 SnowSQL &variable_name 및 & { variable_name } 구문을 사용할 수 있습니다. 그러나 Snowflake는 <% variable_name %> 구문을 사용할 것을 권장합니다.

• 이 예제에서는 --env 옵션을 사용하여 환경 변수를 전달하는 방법을 보여줍니다.

  snow sql -q "select '<% ctx.env.test %>'" --env test=value_from_cli
  

  Copy

• 기본적으로 Snowflake CLI 는 SQL 쿼리의 설명을 출력에서 제거합니다. 다음 예에서는 --retain-comments 옵션을 사용하여 쿼리 결과에 설명을 포함합니다.

  example.sql 파일에 다음 문과 설명이 포함되어 있다고 가정합니다.

  select 'column1';
  -- My comment
  select 'column2';
  

  Copy

  다음 명령을 실행하면 -- My comment 가 쿼리 결과에 나타납니다.

  snow sql -f example.sql --retain-comments
  

  Copy

  select 'column1';
  +-----------+
  | 'COLUMN1' |
  |-----------|
  | ABC       |
  +-----------+
  
  -- My comment
  select 'bar';
  +-----------+
  | 'COLUMN2' |
  |-----------|
  | 123       |
  +-----------+
  

  Copy