EXPORT_DATAのDBMS_CLOUDパッケージ形式オプション

テキスト・ファイル形式、CSV、JSON、ParquetまたはXML、およびOracle Data PumpのDBMS_CLOUD.EXPORT_DATAの有効なフォーマット・パラメータ・オプションについて説明します。

これらは、DBMS_CLOUD.EXPORT_DATAで使用する有効なformatパラメータです。format typeオプションを使用し、値が csv、json、parquet、または xmlのいずれかである場合は、テキストファイルの出力を指定します。また、format typeがdatapumpの場合のformatオプションも表示されます。

format引数を指定するには、次の2つの方法があります。

format => '{"format_option" : "format_value" }'

および:

format => json_object('format_option' value 'format_value'))

例:

format => json_object('type' VALUE 'json')

複数のフォーマット・オプションを指定するには、値を","で区切ります。

たとえば:

format => json_object('compression' value 'gzip', 'type' value 'json')

この表は、formatパラメータのtypeオプションがCSV、JSON、ParquetまたはXMLのいずれかの場合のDBMS_CLOUD.EXPORT_DATAのフォーマット・オプションについて説明しています。その他のプロシージャおよびその他の出力タイプについては、DBMS_CLOUDパッケージのフォーマット・オプションでフォーマット・オプションのリストを参照してください。

フォーマット・オプション摘要構文

フォーマット・オプション	摘要	構文
`compression`	ソース・ファイルの圧縮タイプを指定します。ノート: ZIPアーカイブ・フォーマットはサポートされていません。 `format` `type`が`csv`、`json`または`xml`の場合、デフォルトの圧縮はNullで、圧縮は行われません。 `format` `type`が`parquet`の場合、デフォルトの圧縮は`snappy`です。 `format` `type`が`datapump`の場合、サポートされているOracle Data Pumpアクセス・パラメータを指定できます。 `compression`: 有効値は、`BASIC`、`LOW`、`MEDIUM`および`HIGH`です。 `version`: 有効な値は、`COMPATIBLE`、`LATEST`および指定した`version_number`です。	`type`が`csv` \| `json` \| `xml`の場合圧縮: `gzip`\| `zlib` \| `zstd` \| `bzip2` デフォルト値: NULL値は圧縮なしを示します。 `type`が`parquet`の場合 `compression:` `gzip` \| `snappy` デフォルト値: `snappy` 型が`datapump`の場合圧縮:`BASIC`\| `LOW` \| `MEDIUM` \| `HIGH`
`delimiter`	カスタム・フィールド・デリミタを指定します。 `format => json_object('delimiter' value` '\|' `)` デリミタ値は、ASCIIコードまたはエスケープ文字にできません。ノートこのオプションは、`csv` `type`でのみ適用されます。	`delimiter` : 文字デフォルト値、(カンマ)
`endquote`	`quote`および`endquote`を使用して、フィールドを2つのデリミタで囲むことができることを指定します。`endquote`を指定しない場合、`quote`文字がデフォルトで`endquote`文字として使用されます。たとえば: `format => JSON_OBJECT('quote' value '(', 'endquote' value ')')` ノートこのオプションは、`csv` `type`でのみ適用されます。	`endquote`: 文字デフォルト値: `endquote`がないことを意味するNull。
`escape`	`""`文字を使用して、フィールド値の引用符文字の出現を指定します。ノートこのオプションは、`csv` `type`でのみ適用されます。	`escape` `: true` デフォルト値: `false`
`encryption`	フォーマット・オプション`encryption`は、オブジェクト・ストアとの間でデータをエクスポートおよびインポートするための暗号化および復号化オプションを指定します。 `encryption`を使用して、次のパラメータを指定して暗号化および復号化します。 `user_defined_function`: 指定されたBLOB (バイナリ・ラージ・オブジェクト)を復号化または暗号化するための完全修飾ユーザー定義関数を指定します。復号化または暗号化されたBLOBを返します。このパラメータは、`encryption`の他のパラメータと相互に排他的です。たとえば、`ADMIN.DECRYPTION_CALLBACK`です。 `type`: 復号化または暗号化する組込み暗号化アルゴリズムを指定します。`user_defined_function`と`type`は相互に排他的です。 `type`は、Block Cipher Algorithms + Block Cipher Chaining Modifiers + Block Cipher Padding Modifiers形式の値を受け入れます。サポートされているブロック暗号アルゴリズムは次のとおりです。 `DBMS_CRYPTO.ENCRYPT_AES256` サポートされているブロック暗号連鎖修飾子は次のとおりです。 `DBMS_CRYPTO.CHAIN_CBC` `DBMS_CRYPTO.CHAIN_CFB` `DBMS_CRYPTO.CHAIN_ECB` `DBMS_CRYPTO.CHAIN_OFB` サポートされているブロック暗号パディング修飾子は次のとおりです。 `DBMS_CRYPTO.PAD_PKCS5` `DBMS_CRYPTO.PAD_NONE` `DBMS_CRYPTO.PAD_ZERO` `DBMS_CRYPTO.PAD_ORCL` `credential_name`: 暗号化キーを格納するために使用される資格証明を指定します。これらのパラメータに値を指定しない場合、ブロック暗号連鎖修飾子およびブロック暗号パディング修飾子の値は、デフォルトで`DBMS_CRYPTO.CHAIN_CBC`および`DBMS_CRYPTO.PAD_PKCS5`に設定されます。フォーマット・オプション`encryption`は、次の`DBMS_CLOUD`プロシージャとともに使用されます。次のプロシージャの復号化のためにパラメータを渡すために使用されます。 `DBMS_CLOUD.COPY_DATA` `DBMS_CLOUD.CREATE_EXTERNAL_TABLE` `DBMS_CLOUD.CREATE_HYBRID_TABLE` `DBMS_CLOUD.COPY_COLLECTION` 次のプロシージャを暗号化するためのパラメータを渡すために使用します。 `DBMS_CLOUD.EXPORT_DATA` たとえば: `format => JSON_OBJECT('encryption' value json_object ('type' value DBMS_CRYPTO.ENCRYPT_AES256 + DBMS_CRYPTO.CHAIN_CBC + DBMS_CRYPTO.PAD_PKCS5, 'credential_name' value 'ENCRYPTION_CRED'))`	`encryption:value` valueは、暗号化のための追加パラメータを提供するJSON文字列です。 `type`: 値暗号化タイプを指定します。 `credential_name`: `value` 暗号化キーの格納に使用される資格証明を指定します。 `user_defined_function: value` 指定されたBLOB (バイナリ・ラージ・オブジェクト)を復号化または暗号化するための完全修飾ユーザー定義関数を指定します。
`header`	`csv`型の出力ファイルの最初の行として列名を書き込みます。 `header`オプションには、`boolean`または `string`値を指定できます。有効な値は次のとおりです。 `false`: ヘッダー行をスキップします。 `true`: ヘッダー行を含みます。列名は、`query`パラメータの`SELECT`文に基づいています。仮想列または仮想式を使用する場合は、`SELECT`文で列の別名を指定する必要があります。 `String to define custom header names`: カスタム名でヘッダー行を定義できます。文字列値の列およびデリミタの数は、`SELECT`文の列およびデリミタの数と一致する必要があります。デフォルトのデリミタはカンマ(、)です。たとえば: `format => JSON_OBJECT('type' value 'csv', 'delimiter' value '\\|', 'compression' value 'gzip', 'header' value true)` ノートこのオプションは、`csv` `type`でのみ適用されます。 OracleのDBMS_CLOUDパッケージの`SKIPHEADERS`パラメータを使用すると、データ・ファイルからヘッダー行をスキップできます。この場合、`SKIPHEADERS=1`はインポート中に最初の行をスキップします。`HEADERS=TRUE`オプションは、`SKIPHEADERS=1`と同様に機能し、最初の行を列ヘッダーとして処理し、データ・ロードから除外します。	`header: true\\| false\\| String to define custom header names` デフォルト値: `false`
`fileextension`	フォーマット・タイプのデフォルトの選択を上書きするカスタム・ファイル拡張子。これは、`DBMS_CLOUD.EXPORT_DATA` (CSV、JSON、ParquetまたはXML)を含むテキスト形式に適用されます。指定された文字列がピリオド(ドット)で始まらない場合、最後のファイル名でファイル拡張子の前にドットが自動的に挿入されます。ファイル拡張子が不要な場合は、値`fileextension` =`'none'`を使用します。	有効な値: 任意のファイル拡張子。デフォルト値: `format` `type`オプションによって異なります。 CSV形式: `.csv` JSON形式: `.json` PARQUET形式: `.parquet` XML形式: `.xml`
`maxfilesize`	生成される出力の最大サイズのバイト数。これは、`format` `type`オプションが`csv`、`json`または`xml`に設定されている場合に、`DBMS_CLOUD.EXPORT_DATA`を使用してデータをエクスポートするためのテキスト・ベースの形式に適用されます。ノート: `format` `type`オプションが`parquet`の場合、このオプションは無効です。	最小値: `10485760` (10 MB) 最大値: 1 GB デフォルト値: `10485760` (10MB)
`quote`	CSV形式では、フィールドを2つのデリミタで囲むことができます。`quote`および`endquote`でデリミタを指定します。`endquote`を指定しない場合、`quote`文字がデフォルトで`endquote`文字として使用されます。ノートこのオプションは、`csv` `type`でのみ適用されます。	`quote`: 文字デフォルト値: NULLは、フィールドを引用符で囲まないことを意味します。
`trimspaces`	CSV形式の場合、フィールドの先頭と末尾のスペースをどのようにトリミングするかを指定します。`quote`パラメータが指定されている場合は、フィールドを引用符で囲む前にトリム・スペースが適用されます。 trim_specの説明を参照してください。ノートこのオプションは、`csv` `type`でのみ適用されます。	`trimspaces`: `rtrim\\| ltrim\\| notrim\\| lrtrim\\| ldrtrim` デフォルト値: `notrim`
`type`	出力ファイルの種類を指定します。 `csv`: 問合せ結果を任意のカスタム文字で区切られた列値のセットとしてエクスポートできる、文字区切り値(CSV)形式を指定します。 `json`: 問合せ結果をJSONファイルとしてエクスポートすることを指定します。 `parquet`: 問合せ結果をParquetファイルとしてエクスポートすることを指定します。 `xml`: 問合せ結果を有効なXML文書の行としてエクスポートすることを指定します。各行は、のルートXMLタグにカプセル化されます。問合せ結果は、XMLFOREST SQL関数を使用してXML形式に自動的に変換されます。列のXMLタグ名をカスタマイズするには、列の別名を使用します。 `format` `type`が`datapump`の場合、サポートされているOracle Data Pumpアクセス・パラメータを指定できます。 `compression`: 有効値は、`BASIC`、`LOW`、`MEDIUM`および`HIGH`です。 `version`: 有効な値は、`COMPATIBLE`、`LATEST`および指定した`version_number`です。詳細は、「access_parameters句」を参照してください。	`type`: `csv\\|datapump\\|json\\|parquet\\|xml`

compression

ソース・ファイルの圧縮タイプを指定します。

ノート: ZIPアーカイブ・フォーマットはサポートされていません。

format typeがcsv、jsonまたはxmlの場合、デフォルトの圧縮はNullで、圧縮は行われません。

format typeがparquetの場合、デフォルトの圧縮はsnappyです。

format typeがdatapumpの場合、サポートされているOracle Data Pumpアクセス・パラメータを指定できます。

compression: 有効値は、BASIC、LOW、MEDIUMおよびHIGHです。
version: 有効な値は、COMPATIBLE、LATESTおよび指定したversion_numberです。

typeがcsv | json | xmlの場合

圧縮: gzip| zlib | zstd | bzip2

デフォルト値: NULL値は圧縮なしを示します。

typeがparquetの場合

compression: gzip | snappy

デフォルト値: snappy

型がdatapumpの場合

圧縮:BASIC| LOW | MEDIUM | HIGH

delimiter

カスタム・フィールド・デリミタを指定します。

format => json_object('delimiter' value '|' )

デリミタ値は、ASCIIコードまたはエスケープ文字にできません。

ノート

このオプションは、csv typeでのみ適用されます。

delimiter : 文字

デフォルト値、(カンマ)

endquote

quoteおよびendquoteを使用して、フィールドを2つのデリミタで囲むことができることを指定します。endquoteを指定しない場合、quote文字がデフォルトでendquote文字として使用されます。

たとえば:

format => JSON_OBJECT('quote' value '(', 'endquote' value ')')

ノート

このオプションは、csv typeでのみ適用されます。

endquote: 文字

デフォルト値: endquoteがないことを意味するNull。

escape

""文字を使用して、フィールド値の引用符文字の出現を指定します。

ノート

このオプションは、csv typeでのみ適用されます。

escape : true

デフォルト値: false

encryption

フォーマット・オプションencryptionは、オブジェクト・ストアとの間でデータをエクスポートおよびインポートするための暗号化および復号化オプションを指定します。

encryptionを使用して、次のパラメータを指定して暗号化および復号化します。

user_defined_function: 指定されたBLOB (バイナリ・ラージ・オブジェクト)を復号化または暗号化するための完全修飾ユーザー定義関数を指定します。復号化または暗号化されたBLOBを返します。このパラメータは、encryptionの他のパラメータと相互に排他的です。
たとえば、ADMIN.DECRYPTION_CALLBACKです。
type: 復号化または暗号化する組込み暗号化アルゴリズムを指定します。user_defined_functionとtypeは相互に排他的です。
typeは、Block Cipher Algorithms + Block Cipher Chaining Modifiers + Block Cipher Padding Modifiers形式の値を受け入れます。
サポートされているブロック暗号アルゴリズムは次のとおりです。
- DBMS_CRYPTO.ENCRYPT_AES256
サポートされているブロック暗号連鎖修飾子は次のとおりです。
- DBMS_CRYPTO.CHAIN_CBC
- DBMS_CRYPTO.CHAIN_CFB
- DBMS_CRYPTO.CHAIN_ECB
- DBMS_CRYPTO.CHAIN_OFB
サポートされているブロック暗号パディング修飾子は次のとおりです。
- DBMS_CRYPTO.PAD_PKCS5
- DBMS_CRYPTO.PAD_NONE
- DBMS_CRYPTO.PAD_ZERO
- DBMS_CRYPTO.PAD_ORCL

credential_name: 暗号化キーを格納するために使用される資格証明を指定します。

これらのパラメータに値を指定しない場合、ブロック暗号連鎖修飾子およびブロック暗号パディング修飾子の値は、デフォルトでDBMS_CRYPTO.CHAIN_CBCおよびDBMS_CRYPTO.PAD_PKCS5に設定されます。

フォーマット・オプションencryptionは、次のDBMS_CLOUDプロシージャとともに使用されます。

次のプロシージャの復号化のためにパラメータを渡すために使用されます。
- DBMS_CLOUD.COPY_DATA
- DBMS_CLOUD.CREATE_EXTERNAL_TABLE
- DBMS_CLOUD.CREATE_HYBRID_TABLE
- DBMS_CLOUD.COPY_COLLECTION
次のプロシージャを暗号化するためのパラメータを渡すために使用します。
- DBMS_CLOUD.EXPORT_DATA

たとえば:

format => JSON_OBJECT('encryption' value json_object ('type' value DBMS_CRYPTO.ENCRYPT_AES256 + DBMS_CRYPTO.CHAIN_CBC + DBMS_CRYPTO.PAD_PKCS5, 'credential_name' value 'ENCRYPTION_CRED'))

encryption:value

valueは、暗号化のための追加パラメータを提供するJSON文字列です。

type: 値

暗号化タイプを指定します。

credential_name: value

暗号化キーの格納に使用される資格証明を指定します。

user_defined_function: value

指定されたBLOB (バイナリ・ラージ・オブジェクト)を復号化または暗号化するための完全修飾ユーザー定義関数を指定します。

header

csv型の出力ファイルの最初の行として列名を書き込みます。

headerオプションには、booleanまたは string値を指定できます。

有効な値は次のとおりです。

false: ヘッダー行をスキップします。
true: ヘッダー行を含みます。列名は、queryパラメータのSELECT文に基づいています。仮想列または仮想式を使用する場合は、SELECT文で列の別名を指定する必要があります。
String to define custom header names: カスタム名でヘッダー行を定義できます。文字列値の列およびデリミタの数は、SELECT文の列およびデリミタの数と一致する必要があります。デフォルトのデリミタはカンマ(、)です。

たとえば:

format => JSON_OBJECT('type' value 'csv', 'delimiter' value '\|', 'compression' value 'gzip', 'header' value true)

ノート

このオプションは、csv typeでのみ適用されます。
OracleのDBMS_CLOUDパッケージのSKIPHEADERSパラメータを使用すると、データ・ファイルからヘッダー行をスキップできます。この場合、SKIPHEADERS=1はインポート中に最初の行をスキップします。HEADERS=TRUEオプションは、SKIPHEADERS=1と同様に機能し、最初の行を列ヘッダーとして処理し、データ・ロードから除外します。

header: true\| false\| String to define custom header names

デフォルト値: false

fileextension

フォーマット・タイプのデフォルトの選択を上書きするカスタム・ファイル拡張子。これは、DBMS_CLOUD.EXPORT_DATA (CSV、JSON、ParquetまたはXML)を含むテキスト形式に適用されます。

指定された文字列がピリオド(ドット)で始まらない場合、最後のファイル名でファイル拡張子の前にドットが自動的に挿入されます。

ファイル拡張子が不要な場合は、値fileextension ='none'を使用します。

有効な値: 任意のファイル拡張子。

デフォルト値: format typeオプションによって異なります。

CSV形式: .csv
JSON形式: .json
PARQUET形式: .parquet
XML形式: .xml

maxfilesize

生成される出力の最大サイズのバイト数。

これは、format typeオプションがcsv、jsonまたはxmlに設定されている場合に、DBMS_CLOUD.EXPORT_DATAを使用してデータをエクスポートするためのテキスト・ベースの形式に適用されます。

ノート: format typeオプションがparquetの場合、このオプションは無効です。

最小値: 10485760 (10 MB)

最大値: 1 GB

デフォルト値: 10485760 (10MB)

quote

CSV形式では、フィールドを2つのデリミタで囲むことができます。quoteおよびendquoteでデリミタを指定します。endquoteを指定しない場合、quote文字がデフォルトでendquote文字として使用されます。

ノート

このオプションは、csv typeでのみ適用されます。

quote: 文字

デフォルト値: NULLは、フィールドを引用符で囲まないことを意味します。

trimspaces

CSV形式の場合、フィールドの先頭と末尾のスペースをどのようにトリミングするかを指定します。quoteパラメータが指定されている場合は、フィールドを引用符で囲む前にトリム・スペースが適用されます。

trim_specの説明を参照してください。

ノート

このオプションは、csv typeでのみ適用されます。

trimspaces: rtrim\| ltrim\| notrim\| lrtrim\| ldrtrim

デフォルト値: notrim

type

出力ファイルの種類を指定します。

csv: 問合せ結果を任意のカスタム文字で区切られた列値のセットとしてエクスポートできる、文字区切り値(CSV)形式を指定します。

json: 問合せ結果をJSONファイルとしてエクスポートすることを指定します。

parquet: 問合せ結果をParquetファイルとしてエクスポートすることを指定します。

xml: 問合せ結果を有効なXML文書の行としてエクスポートすることを指定します。各行は、のルートXMLタグにカプセル化されます。

問合せ結果は、XMLFOREST SQL関数を使用してXML形式に自動的に変換されます。列のXMLタグ名をカスタマイズするには、列の別名を使用します。

format typeがdatapumpの場合、サポートされているOracle Data Pumpアクセス・パラメータを指定できます。

compression: 有効値は、BASIC、LOW、MEDIUMおよびHIGHです。
version: 有効な値は、COMPATIBLE、LATESTおよび指定したversion_numberです。

詳細は、「access_parameters句」を参照してください。

type: csv\|datapump\|json\|parquet\|xml

Oracle Cloud Infrastructureドキュメント

EXPORT_DATAのDBMS_CLOUDパッケージ形式オプション