Documentación de Oracle Cloud Infrastructure

Opciones del formato del paquete DBMS_CLOUD para EXPORT_DATA

Describe las opciones de parámetro de formato válidas para DBMS_CLOUD.EXPORT_DATA con formatos de archivo de texto, CSV, JSON, Parquet o XML y para Oracle Data Pump.

Estos son los parámetros format válidos para su uso con DBMS_CLOUD.EXPORT_DATA. Especifique la salida del archivo de texto al utilizar la opción format type y el valor es uno de los siguientes: csv, json, parquet o xml. Esto también muestra las opciones format cuando format type es datapump.

Las dos formas de especificar el argumento de formato son las siguientes:

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

Y:

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

Ejemplos:

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

Para especificar varias opciones de formato, separe los valores con una ",".

Por ejemplo:

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

En esta tabla se tratan las opciones de formato para DBMS_CLOUD.EXPORT_DATA cuando la opción type del parámetro format es una de las siguientes: CSV, JSON, Parquet o XML. Para conocer otros procedimientos y otros tipos de salida, consulte DBMS_CLOUD Package Format Options para ver la lista de opciones de formato.

Opción de formato Descripción Sintaxis

compression

Especifica el tipo de compresión del archivo de origen.

Nota: El formato de archivado ZIP no está soportado.

Cuando format type es csv, json o xml, la compresión por defecto es Null, lo que significa que no hay compresión.

Cuando format type es parquet, la compresión por defecto es snappy.

Cuando format type es datapump, puede especificar los parámetros de acceso soportados de Oracle Data Pump:

  • compression: los valores válido son: BASIC, LOW, MEDIUM y HIGH.

  • version: los valores válidos son: COMPATIBLE, LATEST y un version_number especificado.

Cuando type es:csv | json | xml

compression:gzip | zlib | zstd | bzip2

Valor predeterminado: valor nulo que no significa compresión.

Cuando type es parquet

compression: gzip | snappy

Valor por defecto: snappy

Cuando el tipo es datapump

compression: BASIC|LOW|MEDIUM|HIGH

delimiter

Especifica un delimitador de campo personalizado.

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

El valor delimitador no puede ser un código ASCII ni un carácter de escape.

Nota

Esta opción solo se aplica con csv type.

delimiter: carácter

Valor por defecto , (coma)

endquote

Especifica que los campos se pueden incluir entre dos delimitadores, con quote y endquote. Si no se especifica endquote, el carácter quote se utilizará por defecto como el carácter endquote.

Por ejemplo:

format => JSON_OBJECT(‘quote’ value ‘(’, ‘endquote’ value ‘)’)
Nota

Esta opción solo se aplica con csv type.

endquote:carácter

Valor predeterminado: nulo, lo que significa que no hay endquote.

escape

Especifica la ocurrencia del carácter de comillas en el valor del campo mediante el carácter "\".

Nota

Esta opción solo se aplica con csv type.

escape : true

Valor por defecto: false

encryption

La opción de formato encryption especifica las opciones de cifrado y descifrado para exportar e importar datos desde y hacia el almacén de objetos.

Utilice encryption para especificar los siguientes parámetros para cifrar y descifrar:

  • user_defined_function: especifica una función definida por el usuario totalmente cualificada para descifrar o cifrar el BLOB especificado (objeto grande binario). Devuelve un BLOB descifrado o cifrado. Este parámetro se excluye mutuamente con otros parámetros para encryption.

    Por ejemplo, ADMIN.DECRYPTION_CALLBACK.

  • type: especifica el algoritmo de cifrado incorporado que se va a descifrar o cifrar. user_defined_function y type se excluyen mutuamente.

    type acepta valores en el formato Algoritmos de cifrado de bloque + Modificadores de encadenamiento de cifrado de bloque + Modificadores de relleno de cifrado de bloque.

    Los algoritmos de cifrado de bloques soportados son:

    • DBMS_CRYPTO.ENCRYPT_AES256

    Los modificadores de encadenamiento de cifrado de bloques soportados son:

    • DBMS_CRYPTO.CHAIN_CBC

    • DBMS_CRYPTO.CHAIN_CFB

    • DBMS_CRYPTO.CHAIN_ECB

    • DBMS_CRYPTO.CHAIN_OFB

    Los modificadores de relleno de cifrado de bloque soportados son:

    • DBMS_CRYPTO.PAD_PKCS5

    • DBMS_CRYPTO.PAD_NONE

    • DBMS_CRYPTO.PAD_ZERO

    • DBMS_CRYPTO.PAD_ORCL

  • credential_name: especifica la credencial utilizada para almacenar la clave de cifrado.

Los valores de Modificadores de Encadenamiento de Cifrado de Bloques y Modificadores de Relleno de Cifrado de Bloques se definen por defecto en DBMS_CRYPTO.CHAIN_CBC y DBMS_CRYPTO.PAD_PKCS5, si no especifica valores para estos parámetros.

La opción de formato encryption se utiliza con los siguientes procedimientos DBMS_CLOUD:

  • Se utiliza para transferir parámetros para descifrar para estos procedimientos:

    • DBMS_CLOUD.COPY_DATA

    • DBMS_CLOUD.CREATE_EXTERNAL_TABLE

    • DBMS_CLOUD.CREATE_HYBRID_TABLE

    • DBMS_CLOUD.COPY_COLLECTION

  • Se utiliza para transferir parámetros para cifrar para este procedimiento:

    • DBMS_CLOUD.EXPORT_DATA

Por ejemplo:

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

Donde valor es una cadena JSON que proporciona parámetros adicionales para el cifrado:

type: valor

Especifica el tipo de cifrado.

credential_name: value

Especifica la credencial utilizada para almacenar la clave de cifrado.

user_defined_function: value

Especifica una función definida por el usuario totalmente cualificada para descifrar o cifrar el BLOB especificado (objeto grande binario).

header

Escribe los nombres de columna como la primera línea en los archivos de salida del tipo csv.

La opción header puede aceptar un valor boolean o string.

Los valores válidos son:

  • false: omite la fila de cabecera.

  • true: incluye la fila de cabecera. Los nombres de columna se basan en la sentencia SELECT del parámetro query. Debe especificar alias de columna en la sentencia SELECT al utilizar columnas o expresiones virtuales.

  • String to define custom header names: permite definir filas de cabecera con nombres personalizados. El número de columnas y delimitadores del valor de cadena debe coincidir con el número de columnas y delimitadores de la sentencia SELECT. El delimitador predeterminado es el coma (,).

Por ejemplo:

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

Esta opción solo se aplica con csv type.

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

Valor por defecto: false

fileextension

Extensión de archivo personalizada para sustituir la opción por defecto para el tipo de formato. Esto se aplica a formatos de texto con DBMS_CLOUD.EXPORT_DATA: CSV, JSON, Parquet o XML.

Si la cadena especificada no empieza por punto (punto), se inserta automáticamente un punto antes de la extensión de archivo en el nombre de archivo final.

Si no se desea ninguna extensión de archivo, utilice el valor: fileextension ='none'

Valores válidos: Cualquier extensión de archivo.

Valor por defecto: depende de la opción format type:
  • Formato CSV: .csv
  • Formato JSON: .json
  • Formato PARQUET: .parquet
  • Formato XML: .xml

maxfilesize

Número en bytes para el tamaño máximo de salida generada.

Esto se aplica a los formatos basados en texto para exportar datos con DBMS_CLOUD.EXPORT_DATA cuando la opción format type se define en csv, json o xml.

Nota: Esta opción no es válida cuando la opción format type es parquet.

Valor mínimo: 10485760 (10 MB)

Valor máximo: 1 GB

Valor por defecto: 10485760 (10 MB)

quote

En formato CSV, los campos se pueden incluir entre dos delimitadores. Especifique los delimitadores con quote y endquote. Si no se especifica endquote, el carácter quote se utilizará por defecto como el carácter endquote.

Nota

Esta opción solo se aplica con csv type.

quote: carácter

Valor predeterminado: el significado nulo no delimita los campos con comillas.

trimspaces

Especifica cómo se recortan los espacios iniciales y últimos de los campos para el formato CSV. Los espacios de recorte se aplican antes de citar el campo, si se especifica el parámetro quote.

Consulte la descripción de trim_spec.

Nota

Esta opción solo se aplica con csv type.

trimspaces: rtrim| ltrim| notrim| lrtrim| ldrtrim

Valor por defecto: notrim

type

Especifica el tipo de archivo de salida.

csv: especifica el formato de valores separados por caracteres (CSV) que permite exportar los resultados de la consulta como un juego de valores de columna separados por cualquier carácter personalizado.

json: especifica exportar los resultados de la consulta como archivos JSON.

parquet: especifica exportar los resultados de la consulta como archivos de Parquet.

xml: especifica exportar los resultados de la consulta como filas de documentos XML válidos. Cada fila se encapsula en una etiqueta XML raíz de <RECORD> </RECORD>.

El resultado de la consulta se transforma automáticamente en formato XML mediante la función SQL XMLFOREST. Utilice alias de columna para personalizar los nombres de etiqueta XML para las columnas.

Cuando format type es datapump, puede especificar los parámetros de acceso soportados de Oracle Data Pump:

  • compression: los valores válido son: BASIC, LOW, MEDIUM y HIGH.

  • version: los valores válidos son: COMPATIBLE, LATEST y un version_number especificado.

Consulte Cláusula access_parameters para obtener más información.

type: csv|datapump|json|parquet|xml

Tema principal: Paquete DBMS_CLOUD