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

PATTERN コピーオプションが指定されている場合は、パイプ定義の COPY INTO <テーブル> ステートメントのコピーオプション値。

error_integration

通知をトリガーするためにAmazon S3クラウドストレージのエラーイベントに依存するパイプの通知統合名。

invalid_reason

問題があると思われるパイプの詳細情報を表示します。提供される情報と合わせて SYSTEM$PIPE_STATUS を使用すると、より効果的にパイプのトラブルシューティングができます。パイプに問題がない場合は、値は NULL です。

kind

パイプの種類。これは STAGE。

Kafka-related列

列

説明

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
言語: 日本語