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 関数。どちらのコンストラクトも、出力を クエリできる結果セットとして扱います。

    たとえば、パイプ演算子または RESULT_SCAN 関数を使用して、 SHOW コマンド出力から特定の列を選択したり、行をフィルター処理したりできます。

    出力列を参照する場合は、列名に 二重引用符で囲まれた識別子 を使用します。たとえば、出力列 type を選択するには、 SELECT "type" を指定します。

    SHOW コマンドの出力列名は小文字のため、二重引用符で囲まれた識別子を使用する必要があります。二重引用符により、 SELECT リストまたは WHERE 句内の列名が、スキャンされた SHOW コマンド出力内の列名と一致することが保証されます。

出力

コマンド出力では、次の列にパイプのプロパティとメタデータが提供されます。

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

手動で作成されたパイプ:これは、 CREATEPIPE ステートメントで定義されている名前です。

デフォルトのパイプ（Snowpipe Streaming高性能）:値はターゲットテーブル名から派生します。例: MY_TABLE-STREAMING

database_name

Snowpipeオブジェクトを含むデータベースの名前。

手動で作成されたパイプ:パイプオブジェクトが属するデータベースの名前。

デフォルトのパイプ（Snowpipe Streaming高性能）:ターゲットテーブルのデータベースの名前。

schema_name

Snowpipeオブジェクトを含むスキーマの名前。

手動で作成されたパイプ:パイプオブジェクトが属するスキーマの名前。

デフォルトのパイプ:ターゲットテーブルのスキーマの名前。

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.

名前付きパイプ:パイプを所有するロールの名前。これは、 CREATEPIPE ステートメントで指定されたロール、または後で所有権を付与されるロールです。

デフォルトのパイプ（Snowpipe Streaming高性能）:この列には NULL が表示されます。

notification_channel

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

comment

パイプオブジェクトを説明する、ユーザー提供またはシステム生成のテキスト文字列。

名前付きパイプ:CREATEPIPE ステートメント中に提供されるユーザー定義のコメント。

デフォルトのパイプ（Snowpipe Streaming高性能）:常に次の文を持つシステム生成の文字列:「テーブルへのSnowpipe Streaming高性能のインジェスチョンのデフォルトパイプ。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
言語: 日本語