snow object describe¶

구문¶

snow object describe  <object_type>  <object_name>  --connection <connection>  --host <host>  --port <port>  --account <account>  --user <user>  --password <password>  --authenticator <authenticator>  --private-key-file <private_key_file>  --token <token>  --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 

인자¶

object_type

오브젝트 유형입니다. 예를 들어, 테이블, 데이터베이스, 컴퓨팅 풀 등이 있습니다.

object_name

오브젝트의 이름입니다.

선택 사항¶

--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 TEXT

Snowflake에 연결할 때 사용할 OAuth 토큰입니다.

--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|JSON_EXT|CSV]

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

--verbose, -v

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

--debug

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

--silent

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

--enhanced-exit-codes

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

--help

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

사용법 노트¶

프로시저 및 함수에 대한 IDENTIFIER 는 "hello(int,string)" 같은 인자 유형을 지정해야 합니다.

예¶

함수를 설명하려면 다음과 유사한 명령을 실행합니다.

snow object describe function "hello_function(string)" 

describe function hello_function(string) +--------------------------------------------------------------------- | property | value |--------------------+------------------------------------------------ | signature | (NAME VARCHAR) | returns | VARCHAR(16777216) | language | PYTHON | null handling | CALLED ON NULL INPUT | volatility | VOLATILE | body | None | imports | | handler | functions.hello_function | runtime_version | 3.9 | packages | ['snowflake-snowpark-python'] | installed_packages | ['_libgcc_mutex==0.1','_openmp_mutex==5.1',... +---------------------------------------------------------------------