DESCRIBE PIPE

파이프에 대해 지정된 속성과 속성의 기본값을 설명합니다.

DESCRIBE는 DESC로 축약할 수 있습니다.

참고 항목:

DROP PIPE , ALTER PIPE , CREATE PIPE , SHOW PIPES

구문

DESC[RIBE] PIPE <name>
Copy

매개 변수

name

설명할 파이프의 식별자를 지정합니다. 식별자에 공백이나 특수 문자가 포함된 경우 전체 문자열을 큰따옴표로 묶어야 합니다. 큰따옴표로 묶인 식별자도 대/소문자를 구분합니다.

사용법 노트

  • 파이프 소유자(즉, 파이프에 대한 OWNERSHIP 권한을 가진 역할), 파이프에 대한 MONITOR 또는 OPERATE 권한을 가진 역할 또는 전역 MONITOR EXECUTION 권한을 가진 역할에 대한 결과만 반환합니다.

  • 파이프의 현재 상태를 확인하려면 SYSTEM$PIPE_STATUS 함수를 쿼리하십시오.

  • 이 명령의 출력을 후처리하기 위해 파이프 연산자 (->>) 또는 RESULT_SCAN 함수를 사용할 수 있습니다. 두 구문 모두 출력을 쿼리할 수 있는 결과 세트로 간주합니다.

    For example, you can use the pipe operator or RESULT_SCAN function to select specific columns from the SHOW command output or filter the rows.

    When you refer to the output columns, use double-quoted identifiers for the column names. For example, to select the output column type, specify SELECT "type".

    You must use double-quoted identifiers because the output column names for SHOW commands are in lowercase. The double quotes ensure that the column names in the SELECT list or WHERE clause match the column names in the SHOW command output that was scanned.

출력

명령 출력은 다음 열에 파이프 속성 및 메타데이터를 제공합니다.

| created_on | name | database_name | schema_name | definition | owner | notification_channel | comment | integration | pattern | error_integration | invalid_reason | kind |
Copy

설명

created_on

파이프가 만들어진 날짜 및 시간입니다.

name

The name of the pipe object.

Manually created pipes: This is the name defined in the CREATE PIPE statement.

Default pipe (Snowpipe Streaming high-performance): The value is derived from the target table name; for example, MY_TABLE-STREAMING.

database_name

The name of the database that contains the Snowpipe object.

Manually created pipe: The name of the database that the pipe object belongs to.

Default pipe (Snowpipe Streaming high-performance): The name of the target table’s database.

schema_name

The name of the schema that contains the Snowpipe object.

Manually created pipe: The name of the schema that the pipe object belongs to.

Default pipe: The name of the target table’s schema.

definition

COPY statement that is used to load data from queued files into a Snowflake table.

owner

The name of the role that possesses the OWNERSHIP privilege on the pipe object.

Named pipe: The name of the role that owns the pipe, which is the role specified in the CREATE PIPE statement or granted ownership later.

Default pipe (Snowpipe Streaming high-performance): This column displays NULL.

notification_channel

Amazon Resource Name of the Amazon SQS queue for the stage that is named in the DEFINITION column.

comment

A user-provided or system-generated text string that describes the pipe object.

Named pipe: The user-defined comment that is provided during the CREATE PIPE statement.

Default pipe (Snowpipe Streaming High-Performance): A system-generated string that is always the following sentences: “Default pipe for Snowpipe Streaming High Performance ingestion to a table. Created and managed by Snowflake.”

integration

알림 이벤트를 사용하여 Google Cloud Storage 또는 Microsoft Azure 클라우드 저장소에서 데이터 로딩을 트리거하는 파이프에 대한 알림 통합의 이름입니다.

pattern

복사 옵션이 지정된 경우, 파이프 정의의 COPY INTO <테이블> 문의 PATTERN 복사 옵션 값입니다.

error_integration

알림을 트리거하기 위해 Amazon S3 클라우드 저장소의 오류 이벤트에 의존하는 파이프의 알림 통합 이름입니다.

invalid_reason

문제가 있을 수 있는 파이프에 대한 자세한 정보를 표시합니다. SYSTEM$PIPE_STATUS 와 함께 제공된 정보를 사용하여 파이프 문제를 보다 효과적으로 해결할 수 있습니다. 파이프에 문제가 없으면 값은 NULL입니다.

kind

파이프의 종류로, STAGE 입니다.

Kafka 관련 열

설명

broker_integration

Kafka와 함께 사용되는 외부 액세스 통합의 이름입니다.

broker_secret

Kafka에서 사용되는 시크릿의 이름입니다.

row_format

레코드의 행 형식으로, JSON 또는 AVRO 입니다.

schema

베리언트로 표현된 레코드 스키마입니다.

topic

동기화된 항목의 이름입니다.

CREATE PIPE 의 예에서 만든 mypipe 파이프에 대해 설명합니다.

desc pipe mypipe;

+-------------------------------+--------+---------------+-------------+---------------------------------+----------+---------+
| created_on                    | name   | database_name | schema_name | definition                      | owner    | comment |
|-------------------------------+--------+---------------+-------------+---------------------------------+----------+---------|
| 2017-08-15 06:11:05.703 -0700 | MYPIPE | MYDATABASE    | PUBLIC      | copy into mytable from @mystage | SYSADMIN |         |
+-------------------------------+--------+---------------+-------------+---------------------------------+----------+---------+
Copy