適用対象: Azure Database for PostgreSQL - フレキシブル サーバー
Azure Storage 拡張機能によって提供される関数の一覧を次に示します。
azure_storage.account_add
ストレージ アカウントとそれに関連付けられているアクセス キーを、 azure_storage
拡張機能がアクセスできるストレージ アカウントの一覧に追加できるようにする関数。
この関数の以前の呼び出しでこのストレージ アカウントへの参照が既に追加されている場合、新しいエントリは追加されませんが、代わりに既存のエントリのアクセス キーが更新されます。
注
この関数は、参照されるアカウント名が存在するかどうか、または指定されたアクセス キーを使用してアクセスできるかどうかを検証しません。 ただし、Azure ストレージ アカウントに適用される名前付けの検証規則に従って、ストレージ アカウントの名前が有効であることを検証します。
azure_storage.account_add(account_name_p text, account_key_p text);
この関数にはオーバーロードされたバージョンがあり、参照先の Azure Storage アカウントの名前と、認証の種類、アカウントの種類、ストレージ資格情報など、必要なすべての設定をカプセル化する account_config
パラメーターを受け取ります。
azure_storage.account_add(account_config jsonb);
権限
azure_storage_admin
のメンバーである必要があります。
論争
account_name_p
text
BLOB、ファイル、キュー、テーブルなど、すべてのオブジェクトを含む Azure BLOB ストレージ アカウントの名前。 ストレージ アカウントには、HTTPS 経由で世界中のどこからでもアクセスできる一意の名前空間が用意されています。
account_key_p
text
ストレージ アカウントのいずれかのアクセス キーの値。 Azure Blob Storage のアクセス キーは、ストレージ アカウントのルート パスワードに似ています。 アクセス キーは常に慎重に保護してください。 キーを安全に管理およびローテーションするには、Azure Key Vault を使用します。 アカウント キーは、スーパーユーザーのみがアクセスできるテーブルに格納されます。
azure_storage_admin
ロールを付与されたユーザーは、関数を介してこのテーブルを操作できます。 追加されたストレージ アカウントを確認するには、関数 azure_storage.account_list を使用します。
account_config
jsonb
Azure Storage アカウントの名前と、認証の種類、アカウントの種類、ストレージ資格情報など、必要なすべての設定。 ユーティリティ関数 azure_storage.account_options_managed_identity、 azure_storage.account_options_credentials、または azure_storage.account_options を使用して、この引数として渡す必要がある有効な値を作成することをお勧めします。
戻り値の型
VOID
azure_storage.account_options_managed_identity
ユーティリティ関数として機能し、 azure_storage.account_add 内でパラメーターとして呼び出すことができ、システム割り当てマネージド ID を使用して Azure Storage アカウントと対話するときに、 account_config
引数の有効な値を生成するのに役立ちます。
azure_storage.account_options_managed_identity(name text, type azure_storage.storage_type);
権限
任意のユーザーまたはロールがこの関数を呼び出すことができます。
論争
名前
text
BLOB、ファイル、キュー、テーブルなど、すべてのオブジェクトを含む Azure BLOB ストレージ アカウントの名前。 ストレージ アカウントには、HTTPS 経由で世界中のどこからでもアクセスできる一意の名前空間が用意されています。
型
azure_storage.storage_type
サポートされているストレージの種類の 1 つの値。 サポートされている値のみが blob
。
戻り値の型
jsonb
azure_storage.account_options_credentials
ユーティリティ関数として機能し、 azure_storage.account_add 内でパラメーターとして呼び出すことができます。Azure Storage アクセス キーを使用して Azure Storage アカウントを操作するときに、 account_config
引数の有効な値を生成するのに役立ちます。
azure_storage.account_options_credentials(name text, credentials text, type azure_storage.storage_type);
権限
任意のユーザーまたはロールがこの関数を呼び出すことができます。
論争
名前
text
BLOB、ファイル、キュー、テーブルなど、すべてのオブジェクトを含む Azure BLOB ストレージ アカウントの名前。 ストレージ アカウントには、HTTPS 経由で世界中のどこからでもアクセスできる一意の名前空間が用意されています。
認証情報
text
ストレージ アカウントのいずれかのアクセス キーの値。 Azure Blob Storage のアクセス キーは、ストレージ アカウントのルート パスワードに似ています。 アクセス キーは常に慎重に保護してください。 キーを安全に管理およびローテーションするには、Azure Key Vault を使用します。 アカウント キーは、スーパーユーザーのみがアクセスできるテーブルに格納されます。
azure_storage_admin
ロールを付与されたユーザーは、関数を介してこのテーブルを操作できます。 追加されたストレージ アカウントを確認するには、関数 azure_storage.account_list を使用します。
型
azure_storage.storage_type
サポートされているストレージの種類の 1 つの値。 サポートされている値のみが blob
。
戻り値の型
jsonb
azure_storage.account_options
ユーティリティ関数として機能し、 azure_storage.account_add 内でパラメーターとして呼び出すことができ、Azure Storage アクセス キーまたはシステム割り当てマネージド ID を使用して Azure Storage アカウントと対話するときに、 account_config
引数の有効な値を生成するのに役立ちます。
azure_storage.account_options(name text, auth_type azure_storage.auth_type, storage_type azure_storage.storage_type, credentials text DEFAULT NULL);
権限
任意のユーザーまたはロールがこの関数を呼び出すことができます。
論争
名前
text
BLOB、ファイル、キュー、テーブルなど、すべてのオブジェクトを含む Azure BLOB ストレージ アカウントの名前。 ストレージ アカウントには、HTTPS 経由で世界中のどこからでもアクセスできる一意の名前空間が用意されています。
auth_type
azure_storage.auth_type
サポートされているストレージの種類の 1 つの値。 サポートされている値のみが access-key
され、 managed-identity
。
storage_type
azure_storage.storage_type
サポートされているストレージの種類の 1 つの値。 サポートされている値のみが blob
。
認証情報
text
ストレージ アカウントのいずれかのアクセス キーの値。 Azure Blob Storage のアクセス キーは、ストレージ アカウントのルート パスワードに似ています。 アクセス キーは常に慎重に保護してください。 キーを安全に管理およびローテーションするには、Azure Key Vault を使用します。 アカウント キーは、スーパーユーザーのみがアクセスできるテーブルに格納されます。
azure_storage_admin
ロールを付与されたユーザーは、関数を介してこのテーブルを操作できます。 追加されたストレージ アカウントを確認するには、関数 azure_storage.account_list を使用します。
戻り値の型
jsonb
azure_storage.account_remove
azure_storage
拡張機能がアクセスできるストレージ アカウントの一覧からストレージ アカウントとそれに関連付けられているアクセス キーを削除できるようにする関数。
azure_storage.account_remove(account_name_p text);
権限
azure_storage_admin
のメンバーである必要があります。
論争
account_name_p
text
BLOB、ファイル、キュー、テーブルなど、すべてのオブジェクトを含む Azure BLOB ストレージ アカウントの名前。 ストレージ アカウントには、HTTPS 経由で世界中のどこからでもアクセスできる一意の名前空間が用意されています。
戻り値の型
VOID
azure_storage.account_user_add
azure_storage
拡張機能によって提供される関数を使用して、PostgreSQL ユーザーまたはロールにストレージ アカウントへのアクセス権を付与できるようにする関数。
注
この関数の実行は、名前が最初の引数として渡されているストレージ アカウントが 既に azure_storage.account_add を使用して作成されており、名前が 2 番目の引数として渡されるユーザーまたはロールが既に存在する場合にのみ成功します。
azure_storage.account_add(account_name_p text, user_p regrole);
権限
azure_storage_admin
のメンバーである必要があります。
論争
account_name_p
text
BLOB、ファイル、キュー、テーブルなど、すべてのオブジェクトを含む Azure BLOB ストレージ アカウントの名前。 ストレージ アカウントには、HTTPS 経由で世界中のどこからでもアクセスできる一意の名前空間が用意されています。
user_p
regrole
サーバーで使用可能な PostgreSQL ユーザーまたはロールの名前。
戻り値の型
VOID
azure_storage.account_user_remove
azure_storage
拡張機能によって提供される関数を使用して、ストレージ アカウントへの PostgreSQL ユーザーまたはロールのアクセスを取り消す関数。
注
この関数の実行は、名前が最初の引数として渡されているストレージ アカウントが 既に azure_storage.account_add を使用して作成されており、名前が 2 番目の引数として渡されるユーザーまたはロールがまだ存在する場合にのみ成功します。
ユーザーまたはロールがサーバーから削除されると、 DROP USER | ROLE
を実行することで、Azure Storage アカウントへの参照で付与されたアクセス許可も自動的に削除されます。
azure_storage.account_user_remove(account_name_p text, user_p regrole);
権限
azure_storage_admin
のメンバーである必要があります。
論争
account_name_p
text
BLOB、ファイル、キュー、テーブルなど、すべてのオブジェクトを含む Azure BLOB ストレージ アカウントの名前。 ストレージ アカウントには、HTTPS 経由で世界中のどこからでもアクセスできる一意の名前空間が用意されています。
user_p
regrole
サーバーで使用可能な PostgreSQL ユーザーまたはロールの名前。
戻り値の型
VOID
azure_storage.account_list
azure_storage.account_add 関数を使用して構成されたストレージ アカウントの名前と、azure_storage
拡張機能によって提供される関数を介してそのストレージ アカウントを操作するためのアクセス許可が付与されている PostgreSQL ユーザーまたはロールを一覧表示する関数。
azure_storage.account_list();
権限
azure_storage_admin
のメンバーである必要があります。
論争
この関数は引数を受け取りません。
戻り値の型
TABLE(account_name text, auth_type azure_storage.auth_type, azure_storage_type azure_storage.storage_type, allowed_users regrole[])
追加された Azure Storage アカウントの一覧、各アカウントの操作に使用される認証の種類、ストレージの種類、およびアクセス権が付与されている PostgreSQL ユーザーまたはロールの一覧を含む 4 列のテーブル。
azure_storage.blob_list
参照先ストレージ アカウントの特定のコンテナーに格納されている BLOB の名前とその他のプロパティ (size、lastModified、eTag、contentType、contentEncoding、contentHash) を一覧表示する関数。
azure_storage.blob_list(account_name text, container_name text, prefix text DEFAULT ''::text);
権限
この関数を呼び出すユーザーまたはロールは、account_name
を実行して、参照されるの許可リストに追加する必要があります。
azure_storage_admin
のメンバーは、azure_storage.account_add を使用して参照が追加されたすべての Azure Storage アカウントを自動的に参照できます。
論争
account_name
text
BLOB、ファイル、キュー、テーブルなど、すべてのオブジェクトを含む Azure BLOB ストレージ アカウントの名前。 ストレージ アカウントには、HTTPS 経由で世界中のどこからでもアクセスできる一意の名前空間が用意されています。
コンテナ名
text
コンテナーの名前。 コンテナーは、ファイル システム内のディレクトリと同様に、BLOB のセットを整理します。 ストレージ アカウントには無制限の数のコンテナーを含めることができます。また、コンテナーには無制限の数の BLOB を格納できます。
コンテナー名は、コンテナーまたはその BLOB のアドレス指定に使用される一意の URI の一部であるため、有効なドメイン ネーム システム (DNS) 名である必要があります。
コンテナーに名前を付ける場合は、必ず 次の規則に従ってください。
コンテナーの URI は次のようになります。 https://myaccount.blob.core.windows.net/mycontainer
プレフィックス
text
指定すると、この関数は、このパラメーターで指定された値で始まる名前の BLOB を返します。 既定値は空の文字列です。
戻り値の型
TABLE(path text, bytes bigint, last_modified timestamp with time zone, etag text, content_type text, content_encoding text, content_hash text)
BLOB の完全な名前やその他のプロパティなど、返される BLOB ごとに 1 つのレコードを含むテーブル。
パス
text
BLOB の完全な名前。
バイト
bigint
BLOB のサイズ (バイト単位)。
last_modified
timestamp with time zone
BLOB が最後に変更された日時。 BLOB を変更する操作 (BLOB のメタデータまたはプロパティの更新など) を行うと、BLOB の最終更新時刻が変更されます。
ETAGの
text
ETag プロパティは、更新時のオプティミスティック コンカレンシーに使用されます。 レコードが最後に更新された時刻を格納する Timestamp という別のプロパティがあるため、タイムスタンプではありません。 たとえば、エンティティを読み込んで更新する場合、ETag は現在格納されているものと一致する必要があります。 複数のユーザーが同じアイテムを編集している場合は、互いの変更を上書きしないようにするため、適切な ETag を設定することが重要です。
content_type
text
BLOB に指定されたコンテンツ タイプ。 既定のコンテンツ タイプは application/octet-stream
。
content_encoding
text
Azure Storage で定義できる BLOB の Content-Encoding プロパティ。 圧縮コンテンツの場合は、プロパティを Gzip に設定できます。 ブラウザーがコンテンツにアクセスすると、コンテンツが自動的に展開されます。
content_hash
text
トランスポート中に BLOB の整合性を検証するために使用されるハッシュ。 このヘッダーを指定すると、ストレージ サービスは、コンテンツから計算されたハッシュを使用して指定されたハッシュをチェックします。 2 つのハッシュが一致しない場合、操作はエラー コード 400 (Bad Request) で失敗します。
azure_storage.blob_get
データのインポートを許可する関数。 Azure Storage アカウント内の BLOB コンテナーからファイルをダウンロードします。 その後、内容が行に変換され、SQL 言語コンストラクトで使用および処理できます。 この関数は、インポートする前に BLOB コンテナーからフェッチされたデータをフィルター処理および操作するためのサポートを追加します。
注
参照先のストレージ アカウントのコンテナーにアクセスする前に、この関数は、Azure ストレージ アカウントに課される名前付け検証規則に従って、引数として渡されたストレージ アカウントとコンテナーの名前が有効かどうかを確認します。 いずれかが無効な場合は、エラーが発生します。
azure_storage.blob_get(account_name text, container_name text, path text, decoder text DEFAULT 'auto'::text, compression text DEFAULT 'auto'::text, options jsonb DEFAULT NULL::jsonb);
この関数にはオーバーロードされたバージョンがあり、出力形式レコードを簡単に定義できる rec
パラメーターを受け取ります。
azure_storage.blob_get(account_name text, container_name text, path text, rec anyelement, decoder text DEFAULT 'auto'::text, compression text DEFAULT 'auto'::text, options jsonb DEFAULT NULL::jsonb);
権限
この関数を呼び出すユーザーまたはロールは、account_name
を実行して、参照されるの許可リストに追加する必要があります。
azure_storage_admin
のメンバーは、azure_storage.account_add を使用して参照が追加されたすべての Azure Storage アカウントを自動的に参照できます。
論争
account_name
text
BLOB、ファイル、キュー、テーブルなど、すべてのオブジェクトを含む Azure BLOB ストレージ アカウントの名前。 ストレージ アカウントには、HTTPS 経由で世界中のどこからでもアクセスできる一意の名前空間が用意されています。
コンテナ名
text
コンテナーの名前。 コンテナーは、ファイル システム内のディレクトリと同様に、BLOB のセットを整理します。 ストレージ アカウントには無制限の数のコンテナーを含めることができます。また、コンテナーには無制限の数の BLOB を格納できます。
コンテナー名は、コンテナーまたはその BLOB のアドレス指定に使用される一意の URI の一部であるため、有効なドメイン ネーム システム (DNS) 名である必要があります。
コンテナーに名前を付ける場合は、必ず 次の規則に従ってください。
コンテナーの URI は次のようになります。 https://myaccount.blob.core.windows.net/mycontainer
パス
text
BLOB の完全な名前。
rec
anyelement
レコード出力構造の定義。
デコーダ
text
BLOB 形式の仕様。 次のいずれかの値に設定できます。
形式 | デフォルト | 説明 |
---|---|---|
auto |
true |
BLOB の名前に割り当てられた最後の一連の文字に基づいて値を推論します。 BLOB 名が .csv または .csv.gz で終わる場合は、 csv と見なされます。
.tsv または.tsv.gz で終わる場合は、tsv と見なされます。
.json 、.json.gz 、.xml 、.xml.gz 、.txt 、または.txt.gz で終わる場合は、text が想定されます。 |
csv |
PostgreSQL COPY で使用されるコンマ区切り値の形式。 | |
tsv |
タブ区切りの値。既定の PostgreSQL COPY 形式です。 | |
binary |
バイナリ PostgreSQL COPY 形式。 | |
text | xml | json |
1 つのテキスト値を含むファイル。 |
圧縮
text
圧縮の種類の指定。 次のいずれかの値に設定できます。
形式 | デフォルト | 説明 |
---|---|---|
auto |
true |
BLOB の名前に割り当てられた最後の一連の文字に基づいて値を推論します。 BLOB 名が .gz で終わる場合は、 gzip と見なされます。 それ以外の場合は、 none が想定されます。 |
gzip |
gzip デコーダーを使用して BLOB を展開します。 | |
none |
強制的に、圧縮解除を必要としない BLOB として扱います。 |
拡張機能は、他の圧縮の種類をサポートしていません。
オプション
jsonb
カスタム ヘッダー、カスタム区切り記号、エスケープ文字などの処理を定義する設定 options
は、PostgreSQL の COPY
コマンドに渡すことができるオプションがその動作に与える影響と同様の方法で、この関数の動作に影響します。
戻り値の型
SETOF record
SETOF anyelement
azure_storage.blob_put
Azure Storage アカウント内の BLOB コンテナーにファイルをアップロードして、データをエクスポートできるようにする関数。 ファイルの内容は、PostgreSQL の行から生成されます。
注
参照先のストレージ アカウントのコンテナーにアクセスする前に、この関数は、Azure ストレージ アカウントに課される名前付け検証規則に従って、引数として渡されたストレージ アカウントとコンテナーの名前が有効かどうかを確認します。 いずれかが無効な場合は、エラーが発生します。
azure_storage.blob_put(account_name text, container_name text, path text, tuple record)
RETURNS VOID;
オーバーロードされたバージョンの関数があり、 encoder
パラメーターが含まれており、 path
パラメーターの拡張から推論できない場合、または推論されたエンコーダーをオーバーライドするときに使用するエンコーダーを指定できます。
azure_storage.blob_put(account_name text, container_name text, path text, tuple record, encoder text)
RETURNS VOID;
オーバーロードされたバージョンの関数には、 compression
パラメーターも含まれています。これにより、 path
パラメーターの拡張から推論できない場合、または推論された圧縮をオーバーライドするときに使用する圧縮を指定できます。
azure_storage.blob_put(account_name text, container_name text, path text, tuple record, encoder text, compression text)
RETURNS VOID;
オーバーロードされたバージョンの関数には、カスタム ヘッダー、カスタム区切り記号、エスケープ文字などを処理するための options
パラメーターも含まれています。 options
は、PostgreSQL の COPY
コマンドに渡すことができるオプションと同様に機能します。
azure_storage.blob_put(account_name text, container_name text, path text, tuple record, encoder text, compression text, options jsonb)
RETURNS VOID;
権限
この関数を呼び出すユーザーまたはロールは、account_name
を実行して、参照されるの許可リストに追加する必要があります。
azure_storage_admin
のメンバーは、azure_storage.account_add を使用して参照が追加されたすべての Azure Storage アカウントを自動的に参照できます。
論争
account_name
text
BLOB、ファイル、キュー、テーブルなど、すべてのオブジェクトを含む Azure BLOB ストレージ アカウントの名前。 ストレージ アカウントには、HTTPS 経由で世界中のどこからでもアクセスできる一意の名前空間が用意されています。
コンテナ名
text
コンテナーの名前。 コンテナーは、ファイル システム内のディレクトリと同様に、BLOB のセットを整理します。 ストレージ アカウントには無制限の数のコンテナーを含めることができます。また、コンテナーには無制限の数の BLOB を格納できます。
コンテナー名は、コンテナーまたはその BLOB のアドレス指定に使用される一意の URI の一部であるため、有効なドメイン ネーム システム (DNS) 名である必要があります。
コンテナーに名前を付ける場合は、必ず 次の規則に従ってください。
コンテナーの URI は次のようになります。 https://myaccount.blob.core.windows.net/mycontainer
パス
text
BLOB の完全な名前。
タプル
record
レコード出力構造の定義。
エンコーダ
text
BLOB 形式の仕様。 次のいずれかの値に設定できます。
形式 | デフォルト | 説明 |
---|---|---|
auto |
true |
BLOB の名前に割り当てられた最後の一連の文字に基づいて値を推論します。 BLOB 名が .csv または .csv.gz で終わる場合は、 csv と見なされます。
.tsv または.tsv.gz で終わる場合は、tsv と見なされます。
.json 、.json.gz 、.xml 、.xml.gz 、.txt 、または.txt.gz で終わる場合は、text が想定されます。 |
csv |
PostgreSQL COPY で使用されるコンマ区切り値の形式。 | |
tsv |
タブ区切りの値。既定の PostgreSQL COPY 形式です。 | |
binary |
バイナリ PostgreSQL COPY 形式。 | |
text | xml | json |
1 つのテキスト値を含むファイル。 |
圧縮
text
圧縮の種類の指定。 次のいずれかの値に設定できます。
形式 | デフォルト | 説明 |
---|---|---|
auto |
true |
BLOB の名前に割り当てられた最後の一連の文字に基づいて値を推論します。 BLOB 名が .gz で終わる場合は、 gzip と見なされます。 それ以外の場合は、 none が想定されます。 |
gzip |
gzip デコーダーを使用して BLOB を展開します。 | |
none |
強制的に、圧縮解除を必要としない BLOB として扱います。 |
拡張機能は、他の圧縮の種類をサポートしていません。
オプション
jsonb
カスタム ヘッダー、カスタム区切り記号、エスケープ文字などの処理を定義する設定 options
は、PostgreSQL の COPY
コマンドに渡すことができるオプションがその動作に与える影響と同様の方法で、この関数の動作に影響します。
戻り値の型
VOID
azure_storage.options_csv_get
ユーティリティ関数として機能し、 blob_get
内のパラメーターとして呼び出すことができる関数で、csv ファイルの内容をデコードするのに役立ちます。
azure_storage.options_csv_get(delimiter text DEFAULT NULL::text, null_string text DEFAULT NULL::text, header boolean DEFAULT NULL::boolean, quote text DEFAULT NULL::text, escape text DEFAULT NULL::text, force_not_null text[] DEFAULT NULL::text[], force_null text[] DEFAULT NULL::text[], content_encoding text DEFAULT NULL::text);
権限
任意のユーザーまたはロールがこの関数を呼び出すことができます。
論争
区切り記号
text
ファイルの各行 (行) 内の列を区切る文字。 1 バイト文字にする必要があります。 この関数は任意の数の文字の区切り記号をサポートしていますが、1 バイト文字を超える文字を使用しようとすると、PostgreSQL は COPY delimiter must be a single one-byte character
エラーを報告します。
null_string
text
null 値を表す文字列。 既定値はテキスト形式の \N (円記号 -N)、CSV 形式の引用符で囲まれていない空の文字列です。 null と空の文字列を区別しない場合は、テキスト形式でも空の文字列を使用できます。
ヘッダー
boolean
ファイル内の各列の名前を含むヘッダー行がファイルに含まれているかどうかを示すフラグ。 出力時に、最初の行にはテーブルの列名が含まれます。
クォート
text
データ値が引用符で囲まれるときに使用される引用符文字。 既定値は二重引用符です。 1 バイト文字にする必要があります。 この関数は任意の数の文字の区切り記号をサポートしていますが、1 バイト文字を超える文字を使用しようとすると、PostgreSQL は COPY quote must be a single one-byte character
エラーを報告します。
エスケープ
text
QUOTE 値と一致するデータ文字の前に表示される文字。 既定値は QUOTE 値と同じです (したがって、引用符文字がデータに表示される場合は 2 倍になります)。 1 バイト文字にする必要があります。 この関数は任意の数の文字の区切り記号をサポートしていますが、1 バイト文字を超える文字を使用しようとすると、PostgreSQL は COPY escape must be a single one-byte character
エラーを報告します。
force_not_null
text[]
指定した列の値が null 文字列と一致しません。 null 文字列が空の既定のケースでは、空の値は引用符で囲まれていない場合でも、null ではなく長さ 0 の文字列として読み取られます。
force_null
text[]
引用符で囲まれた場合でも、指定した列の値を null 文字列と照合し、一致が見つかった場合は、値を NULL に設定します。 null 文字列が空の既定のケースでは、引用符で囲まれた空の文字列を NULL に変換します。
content_encoding
text
ファイルのエンコードに使用するエンコードの名前。 このオプションを省略すると、現在のクライアント エンコードが使用されます。
戻り値の型
jsonb
azure_storage.options_copy
ユーティリティ関数として機能する関数。これは、 blob_get
内のパラメーターとして呼び出すことができます。
これは、options_csv_get、options_tsv、およびoptions_binaryのヘルパー関数として機能します。
azure_storage.options_copy(delimiter text DEFAULT NULL::text, null_string text DEFAULT NULL::text, header boolean DEFAULT NULL::boolean, quote text DEFAULT NULL::text, escape text DEFAULT NULL::text, force_quote text[] DEFAULT NULL::text[], force_not_null text[] DEFAULT NULL::text[], force_null text[] DEFAULT NULL::text[], content_encoding text DEFAULT NULL::text);
権限
任意のユーザーまたはロールがこの関数を呼び出すことができます。
論争
区切り記号
text
ファイルの各行 (行) 内の列を区切る文字。 1 バイト文字にする必要があります。 この関数は任意の数の文字の区切り記号をサポートしていますが、1 バイト文字を超える文字を使用しようとすると、PostgreSQL は COPY delimiter must be a single one-byte character
エラーを報告します。
null_string
text
null 値を表す文字列。 既定値はテキスト形式の \N (円記号 -N)、CSV 形式の引用符で囲まれていない空の文字列です。 null と空の文字列を区別しない場合は、テキスト形式でも空の文字列を使用できます。
ヘッダー
boolean
ファイル内の各列の名前を含むヘッダー行がファイルに含まれているかどうかを示すフラグ。 出力時に、最初の行にはテーブルの列名が含まれます。
クォート
text
データ値が引用符で囲まれるときに使用される引用符文字。 既定値は二重引用符です。 1 バイト文字にする必要があります。 この関数は任意の数の文字の区切り記号をサポートしていますが、1 バイト文字を超える文字を使用しようとすると、PostgreSQL は COPY quote must be a single one-byte character
エラーを報告します。
エスケープ
text
QUOTE 値と一致するデータ文字の前に表示される文字。 既定値は QUOTE 値と同じです (したがって、引用符文字がデータに表示される場合は 2 倍になります)。 1 バイト文字にする必要があります。 この関数は任意の数の文字の区切り記号をサポートしていますが、1 バイト文字を超える文字を使用しようとすると、PostgreSQL は COPY escape must be a single one-byte character
エラーを報告します。
force_quote
text[]
は、指定された各列のすべての NULL 以外の値に対して引用符が使用されるように強制します。 NULL 出力は引用符で囲まれることはありません。 * を指定すると、NULL 以外の値はすべての列で引用符で囲まれます。
force_not_null
text[]
指定した列の値が null 文字列と一致しません。 null 文字列が空の既定のケースでは、空の値は引用符で囲まれていない場合でも、null ではなく長さ 0 の文字列として読み取られます。
force_null
text[]
引用符で囲まれた場合でも、指定した列の値を null 文字列と照合し、一致が見つかった場合は、値を NULL に設定します。 null 文字列が空の既定のケースでは、引用符で囲まれた空の文字列を NULL に変換します。
content_encoding
text
ファイルのエンコードに使用するエンコードの名前。 このオプションを省略すると、現在のクライアント エンコードが使用されます。
戻り値の型
jsonb
azure_storage.options_tsv
ユーティリティ関数として機能し、 blob_get
内のパラメーターとして呼び出すことができます。tsv ファイルの内容をデコードする場合に便利です。
azure_storage.options_tsv(delimiter text DEFAULT NULL::text, null_string text DEFAULT NULL::text, content_encoding text DEFAULT NULL::text);
権限
任意のユーザーまたはロールがこの関数を呼び出すことができます。
論争
区切り記号
text
ファイルの各行 (行) 内の列を区切る文字。 1 バイト文字にする必要があります。 この関数は任意の数の文字の区切り記号をサポートしていますが、1 バイト文字を超える文字を使用しようとすると、PostgreSQL は COPY delimiter must be a single one-byte character
エラーを報告します。
null_string
text
null 値を表す文字列。 既定値はテキスト形式の \N (円記号 -N)、CSV 形式の引用符で囲まれていない空の文字列です。 null と空の文字列を区別しない場合は、テキスト形式でも空の文字列を使用できます。
content_encoding
text
ファイルのエンコードに使用するエンコードの名前。 このオプションを省略すると、現在のクライアント エンコードが使用されます。
戻り値の型
jsonb
azure_storage.options_binary
ユーティリティ関数として機能する関数。 blob_get
内でパラメーターとして呼び出すことができます。バイナリ ファイルの内容をデコードする場合に便利です。
azure_storage.options_binary(content_encoding text DEFAULT NULL::text);
権限
任意のユーザーまたはロールがこの関数を呼び出すことができます。
論争
content_encoding
text
ファイルのエンコードに使用するエンコードの名前。 このオプションを省略すると、現在のクライアント エンコードが使用されます。
戻り値の型
jsonb