Documentação do Oracle Cloud Infrastructure

DBMS_CLOUD Opções de Formato do Pacote para EXPORT_DATA

Descreve as opções de parâmetro de formato válidas para DBMS_CLOUD.EXPORT_DATA com formatos de arquivo de texto, CSV, JSON, Parquet ou XML e para o Oracle Data Pump.

Estes são os parâmetros format válidos para uso com DBMS_CLOUD.EXPORT_DATA. Você especifica a saída do arquivo de texto ao usar a opção format type e o valor é um dos seguintes: csv, json, parquet ou xml. Isso também mostra as opções format quando o format type é datapump.

As duas maneiras de especificar o argumento de formato são:

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

E:

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

Exemplos de:

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

Para especificar várias opções de formato, separe os valores com uma vírgula (",").

Por exemplo:

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

Esta tabela abrange as opções de formato para DBMS_CLOUD.EXPORT_DATA quando a opção type do parâmetro format é uma das seguintes: CSV, JSON, Parquet ou XML. Para obter outros procedimentos e outros tipos de saída, consulte DBMS_CLOUD Opções de Formato do Pacote para obter a lista de opções de formato.

Opção de Formato Descrição Sintaxe

compression

Especifica o tipo de compactação do arquivo de origem.

Observação: O formato de arquivamento ZIP não é suportado.

Quando format type é csv, json ou xml, a compactação padrão é Nula, o que significa que não há compactação.

Quando format type é parquet, a compactação padrão é snappy.

Quando format type é datapump, você pode especificar parâmetros de acesso suportados do Oracle Data Pump:

  • compression: Os valores válidos são: BASIC, LOW, MEDIUM e HIGH.

  • version: Os valores válidos são: COMPATIBLE, LATEST e um version_number especificado.

Quando o type é:csv | json | xml

compression:gzip | zlib | zstd | bzip2

Valor padrão: O valor nulo significa sem compactação.

Quando type é parquet

compression: gzip | snappy

Valor padrão: snappy

Quando o tipo é datapump

compression: BASIC|LOW|MEDIUM|HIGH

delimiter

Especifica um delimitador de campo personalizado.

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

O valor do delimitador não pode ser um código ASCII ou um caractere de escape.

Observação

Essa opção só se aplica a csv type.

delimiter : caracteres

Valor padrão , ( vírgula)

endquote

Especifica que os campos podem ser colocados entre dois delimitadores, com quote e endquote. Se endquote não for especificado, o caractere quote será usado por padrão como caractere endquote.

Por exemplo:

format => JSON_OBJECT(‘quote’ value ‘(’, ‘endquote’ value ‘)’)
Observação

Essa opção só se aplica a csv type.

endquote: caracteres

Valor padrão: Nulo, o que significa que não há endquote.

escape

Especifica a ocorrência do caractere de aspas no valor do campo usando o caractere "\".

Observação

Essa opção só se aplica a csv type.

escape : true

Valor padrão: false

encryption

A opção de formato encryption especifica as opções de criptografia e decriptografia para exportar e importar dados de/para o Armazenamento de Objetos.

Use encryption para especificar os seguintes parâmetros para criptografar e decriptografar:

  • user_defined_function: Especifica uma função definida pelo usuário totalmente qualificada para decriptografar ou criptografar o BLOB especificado (objeto binário grande). Ele retorna um BLOB descriptografado ou criptografado. Esse parâmetro é mutuamente exclusivo com outros parâmetros para encryption.

    Por exemplo, ADMIN.DECRYPTION_CALLBACK.

  • type: Especifica o algoritmo de criptografia incorporado para decriptografar ou criptografar. user_defined_function e type são mutuamente exclusivos.

    type aceita valores no formato Algoritmos de Cifragem de Bloco + Modificadores de Encadeamento de Cifragem de Bloco + Modificadores de Preenchimento de Cifragem de Bloco.

    Os Algoritmos de Cifragem de Bloco Suportados são:

    • DBMS_CRYPTO.ENCRYPT_AES256

    Os Modificadores de Encadeamento de Cifras de Bloco Suportados são:

    • DBMS_CRYPTO.CHAIN_CBC

    • DBMS_CRYPTO.CHAIN_CFB

    • DBMS_CRYPTO.CHAIN_ECB

    • DBMS_CRYPTO.CHAIN_OFB

    Os Modificadores de Preenchimento de Cifragem de Bloco Suportados são:

    • DBMS_CRYPTO.PAD_PKCS5

    • DBMS_CRYPTO.PAD_NONE

    • DBMS_CRYPTO.PAD_ZERO

    • DBMS_CRYPTO.PAD_ORCL

  • credential_name: Especifica a credencial usada para armazenar a chave de criptografia.

Os valores dos Modificadores de Encadeamento de Cifragem de Bloco e Modificadores de Preenchimento de Cifragem de Bloco assumem como padrão DBMS_CRYPTO.CHAIN_CBC e DBMS_CRYPTO.PAD_PKCS5, se você não especificar valores para esses parâmetros.

A opção de formato encryption é usada com os seguintes procedimentos DBMS_CLOUD:

  • Usado para passar parâmetros para descriptografar para estes procedimentos:

    • DBMS_CLOUD.COPY_DATA

    • DBMS_CLOUD.CREATE_EXTERNAL_TABLE

    • DBMS_CLOUD.CREATE_HYBRID_TABLE

    • DBMS_CLOUD.COPY_COLLECTION

  • Usado para especificar parâmetros para criptografar para este procedimento:

    • DBMS_CLOUD.EXPORT_DATA

Por exemplo:

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

Em que valor é uma string JSON que fornece parâmetros adicionais para criptografia:

type: valor

Especifica o tipo de criptografia.

credential_name: value

Especifica a credencial usada para armazenar a chave de criptografia.

user_defined_function: value

Especifica uma função totalmente qualificada definida pelo usuário para decriptografar ou criptografar o BLOB (objeto binário grande) especificado.

header

Grava os nomes de coluna como primeira linha nos arquivos de saída do tipo csv.

A opção header pode aceitar um valor boolean ou string.

Os valores válidos são:

  • false: Ignora a linha do cabeçalho.

  • true: Inclui a linha do cabeçalho. Os nomes de coluna se baseiam na instrução SELECT do parâmetro query. Especifique aliases de coluna na instrução SELECT ao usar colunas ou expressões virtuais.

  • String to define custom header names: Permite definir linhas de cabeçalho com nomes personalizados. O número de colunas e delimitadores no valor da string deve corresponder ao número de colunas e delimitadores na instrução SELECT. O delimitador padrão é a vírgula (,).

Por exemplo:

format => JSON_OBJECT('type' value 'csv', 'delimiter' value '|', 'compression' value 'gzip', 'header' value true)
Observação

Essa opção só se aplica a csv type.

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

Valor padrão: false

fileextension

Extensão de arquivo personalizada para substituir a opção padrão do tipo de formato. Isso se aplica a formatos de texto com DBMS_CLOUD.EXPORT_DATA: CSV, JSON, Parquet ou XML.

Se a string especificada não começar com ponto, um ponto será inserido automaticamente antes da extensão de arquivo no nome do arquivo final.

Se nenhuma extensão de arquivo for desejada, use o valor: fileextension ='none'

Valores válidos: Qualquer extensão de arquivo.

Valor padrão: Depende da opção format type:
  • Formato CSV: .csv
  • Formato JSON: .json
  • Formato PARQUET: .parquet
  • Formato XML: .xml

maxfilesize

Número em bytes para obter o tamanho máximo da saída gerada.

Isso se aplica a formatos baseados em texto para exportar dados com DBMS_CLOUD.EXPORT_DATA quando a opção format type está definida como csv, json ou xml.

Observação: Esta opção não é válida quando a opção format type é parquet.

Valor mínimo: 10485760 (10 MB )

Valor máximo: 1 GB

Valor padrão: 10485760 (10 MB)

quote

No formato CSV, os campos podem ser colocados entre dois delimitadores. Especifique os delimitadores com quote e endquote. Se endquote não for especificado, o caractere quote será usado por padrão como caractere endquote.

Observação

Essa opção só se aplica a csv type.

quote: character

Valor padrão: Nulo significa não colocar campos entre aspas.

trimspaces

Especifica como os espaços à esquerda e à direita dos campos são cortados para formato CSV. A remoção de espaços será aplicada antes de colocar o campo entre aspas, se o parâmetro quote for especificado.

Consulte a descrição de trim_spec.

Observação

Essa opção só se aplica a csv type.

trimspaces: rtrim| ltrim| notrim| lrtrim| ldrtrim

Valor padrão: notrim

type

Especifica o tipo de arquivo de saída.

csv: especifica o formato CSV (Valores Separados por Caracteres) que permite exportar resultados de consulta como conjunto de valores de coluna separados por qualquer caractere personalizado.

json: especifica para exportar os resultados da consulta como arquivos JSON.

parquet: especifica para exportar os resultados da consulta como arquivos Parquet.

xml: especifica para exportar resultados da consulta como linhas de documentos XML válidos. Cada linha é encapsulada em uma tag XML raiz de <RECORD> </RECORD>.

O resultado da consulta é transformado automaticamente em formato XML usando a função SQL XMLFOREST. Use Aliases de Coluna para personalizar os nomes de tag XML das colunas.

Quando format type é datapump, você pode especificar parâmetros de acesso suportados do Oracle Data Pump:

  • compression: Os valores válidos são: BASIC, LOW, MEDIUM e HIGH.

  • version: Os valores válidos são: COMPATIBLE, LATEST e um version_number especificado.

Consulte Cláusula access_parameters para obter mais informações.

type: csv|datapump|json|parquet|xml

Tópico principal: DBMS_CLOUD Pacote