カテゴリ：

DDLデータのロード/アンロード

DESCRIBE PIPE

パイプに指定されたプロパティ、およびプロパティのデフォルト値について説明します。

DESCRIBE は DESCに短縮できます。

こちらもご参照ください：

ALTER PIPE 、 CREATE PIPE 、 SHOW PIPES

構文

DESC[RIBE] PIPE <name>

パラメーター

名前

記述するパイプの識別子を指定します。識別子にスペースまたは特殊文字が含まれる場合、文字列全体を二重引用符で囲む必要があります。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

使用上の注意

• パイプ所有者（つまり、パイプの OWNERSHIP 権限を持つロール）、パイプの MONITOR または OPERATE 権限を持つロール、 または グローバル MONITOR EXECUTION権限を持つロールの結果のみを返します。

• パイプの現在のステータスを確認するには、 SYSTEM$PIPE_STATUS 関数をクエリします。

• このコマンドの出力を後処理するには、 RESULT_SCAN 関数を使用できます。この関数は、出力をクエリ可能なテーブルとして扱います。

出力

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

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

列	説明
created_on	パイプが作成された日時。
name	パイプの名前。
database_name	パイプが格納されているデータベース。
schema_name	パイプが格納されているスキーマ。
definition	COPY キューファイルからSnowflakeテーブルにデータをロードするために使用されるステートメント。
owner	パイプを所有する（つまり、パイプに対する OWNERSHIP 権限を持つ）ロールの名前。
notification_channel	DEFINITION 列で指定されたステージのAmazon SQS キューのAmazonリソース名。
comment	このパイプのコメント。
integration	通知イベントに依存してGoogle Cloud StorageまたはMicrosoft Azureクラウドストレージからのデータロードをトリガーするパイプの通知統合の名前。
pattern	PATTERN コピーオプションが指定されている場合は、パイプ定義の COPY INTO <テーブル> ステートメントのコピーオプション値。
error_integration	通知をトリガーするためにAmazon S3クラウドストレージのエラーイベントに依存するパイプの通知統合名。

例

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