DBMS_CLOUD Package Format Options for EXPORT_DATA
DBMS_CLOUD.EXPORT_DATA
with text file formats, CSV, JSON, Parquet, or XML, and for Oracle Data Pump.
These are the valid format
parameters for use with DBMS_CLOUD.EXPORT_DATA
. You specify text file output when you use the format
type
option and the value is one of: csv
,
json
, parquet
, or
xml
. This also shows the format
options when the format
type
is datapump
.
The two ways to specify the format argument are:
format => '{"format_option" : “format_value” }'
And:
format => json_object('format_option' value 'format_value'))
Examples:
format => json_object('type' VALUE 'json')
To specify multiple format options, separate the values with a
",
".
For example:
format => json_object('compression' value 'gzip', 'type' value 'json')
This table covers the format options for DBMS_CLOUD.EXPORT_DATA
when the format
parameter type
option is one of: CSV, JSON, Parquet, or XML. For other procedures and other output types, see DBMS_CLOUD Package Format Options for the list of format options.
Format Option | Description | Syntax |
---|---|---|
|
Specifies the compression type of the source file. Note: ZIP archiving format is not supported. When the When the When the
|
When the
Default value: Null value meaning no compression. When the
Default value: When the type is
|
|
Specifies a custom field delimiter. format => json_object('delimiter' value
'|') The delimiter value cannot be an ASCII code or an escape character. Note
This option only applies with csv
type .
|
Default value |
|
Specifies that fields can be enclosed
between two delimiters, with For example: format =>
JSON_OBJECT(‘quote’ value ‘(’, ‘endquote’ value
‘)’) Note
This option only applies with csv
type .
|
Default value: Null, meaning no
|
|
Specifies the occurrence of quote character in the field
value using Note
This option only applies with csv
type .
|
Default value: |
|
The format option Use
The Block Cipher Chaining Modifiers and Block Cipher Padding Modifiers values defaults to The format option
encryption is used with the following DBMS_CLOUD procedures:
For example: 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 Where value is a JSON string that provides additional parameters for encryption:
Specifies the encryption type.
Specifies the credential used to store the encryption key. user_defined_function:
value Specifies a fully qualified user-defined function to decrypt or encrypt the specified BLOB (binary large object). |
|
Writes column names as the first line in output files of
The
The valid values are:
For example: format =>
JSON_OBJECT('type' value 'csv', 'delimiter' value '|', 'compression'
value 'gzip', 'header' value true) Note
This option only applies with csv
type .
|
Default value: |
|
Custom file extension to override the default choice for the format type. This applies to text formats with If the specified string does not start with period (dot), then a dot is automatically inserted before the file extension in the final file name. If no file extension is desired, use the value:
|
Valid values: Any file extension. Default value: Depends on the
format
type option:
|
|
Number in bytes for maximum size of output generated. This applies to text based formats for exporting data
with Note: This option is not valid when the |
Minimum value: Maximum value: 1 GB Default value: |
|
In CSV format, fields can be enclosed between two
delimiters. Specify the delimiters with Note
This option only applies with csv
type .
|
Default value: Null meaning do not enclose fields with quotes. |
|
Specifies how the leading and trailing spaces of the
fields are trimmed for CSV format. Trim spaces is applied before
quoting the field, if the See the description of trim_spec. Note
This option only applies with csv
type .
|
Default value: |
|
Specifies the output file type.
The query result is automatically transformed into XML format using XMLFOREST SQL function. Use Column Aliases to customize the XML tag names for columns. When the
See access_parameters Clause for more information. |
|
Parent topic: DBMS_CLOUD Package