Opções do Formato de Pacote DBMS_CLOUD para EXPORT_DATA

Descreve as opções de parâmetro de formato válido para DBMS_CLOUD.EXPORT_DATA com formatos de arquivo de texto, CSV, JSON ou XML.

Esses 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 de: csv, json, parquet ou xml.

As duas maneiras de especificar o argumento de formatação são:

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

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 um ",".

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 Opções de Formato de Pacote DBMS_CLOUD para obter a lista de opções de formato.

Opção de Formato Descrição Sintaxe

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 o `format type` é `csv`, `json` ou `xml`, a compactação padrão é Nula, o que significa que não há compactação. Quando a `format type` é `parquet`, a compactação padrão é `snappy`.	Quando o `type` for:`csv \| json \| xml` `compression: gzip` Valor padrão: Valor nulo que significa nenhuma compactação. Quando o `type` é `parquet` `compression: gzip \| snappy` Valor padrão: `snappy`
`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: Esta opção só se aplica a `csv type`.	`delimiter`: caractere Valor padrão , (vírgula)
`endquote`	Especifica que os campos podem ser delimitados entre dois delimitadores, com `quote` e `endquote`. Se `endquote` não for especificado, o caractere `quote` será usado por padrão como o caractere `endquote`. Por exemplo: `format => JSON_OBJECT('quote' value '(' , 'endquote' value ')')` Observação: Esta opção só se aplica a `csv type`.	`endquote`: caractere Valor padrão: Nulo, significando que não há `endquote`.
`escape`	Especifica a ocorrência do caractere de aspas no valor do campo usando o caractere `"\\"`. Observação: Esta 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 Object Store. Use `encryption` para especificar os seguintes parâmetros para criptografar e decriptografar: `user_defined_function`: Especifica uma função totalmente qualificada definida pelo usuário para decriptografar ou criptografar o BLOB especificado (objeto grande binário). 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 a ser decriptografado ou criptografado. `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 Cifragem 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 dos 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 transmitir parâmetros para decriptografar estes procedimentos: `DBMS_CLOUD.COPY_DATA` `DBMS_CLOUD.CREATE_EXTERNAL_TABLE` `DBMS_CLOUD.CREATE_HYBRID_TABLE` `DBMS_CLOUD.COPY_COLLECTION` Usado para transmitir parâmetros a serem criptografados 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` Onde o 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 especificado (objeto grande binário).
`header`	Grava nomes de coluna como a primeira linha em 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 das colunas se baseiam na instrução `SELECT` no 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 é vírgula (,). Por exemplo: `format => JSON_OBJECT('type' value 'csv', 'delimiter' value '\|', 'compression' value 'gzip', 'header' value true)` Observação: Esta 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 para o 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 (ponto), um ponto será automaticamente inserido antes da extensão do 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 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` é 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) de
`quote`	No formato CSV, os campos podem ser delimitados 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 o caractere `endquote`. Observação: Esta opção só se aplica a `csv type`.	`quote`: caractere Valor padrão: O significado nulo não inclui campos com aspas.
`trimspaces`	Especifica como os espaços iniciais e finais dos campos são aparados para o formato CSV. Os espaços de redução serão aplicados antes da cotação do campo, se o parâmetro `quote` for especificado. Consulte a descrição de trim_spec em Oracle Database 19c Utilities ou Oracle Database 26ai Utilities. Observação: Esta 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 os resultados da consulta como um 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 . O resultado da consulta é automaticamente transformado em formato XML usando a função SQL XMLFOREST. Use Aliases de coluna para personalizar os nomes de tag XML das colunas. Consulte access_parameters Clause em Oracle Database 19c Utilities ou Oracle Database 26ai Utilities para obter mais informações.	`type`: `csv\|datapump\|json\|parquet\|xml`

compression

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

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

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

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

Quando o type for:csv | json | xml

compression: gzip

Valor padrão: Valor nulo que significa nenhuma compactação.

Quando o type é parquet

compression: gzip | snappy

Valor padrão: snappy

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: Esta opção só se aplica a csv type.

delimiter: caractere

Valor padrão , (vírgula)

endquote

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

Por exemplo:

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

Observação: Esta opção só se aplica a csv type.

endquote: caractere

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

escape

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

Observação: Esta 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 Object Store.

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

user_defined_function: Especifica uma função totalmente qualificada definida pelo usuário para decriptografar ou criptografar o BLOB especificado (objeto grande binário). 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 a ser decriptografado ou criptografado. 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 Cifragem 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 dos 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 transmitir parâmetros para decriptografar estes procedimentos:
- DBMS_CLOUD.COPY_DATA
- DBMS_CLOUD.CREATE_EXTERNAL_TABLE
- DBMS_CLOUD.CREATE_HYBRID_TABLE
- DBMS_CLOUD.COPY_COLLECTION
Usado para transmitir parâmetros a serem criptografados 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

Onde o 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 especificado (objeto grande binário).

header

Grava nomes de coluna como a primeira linha em 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 das colunas se baseiam na instrução SELECT no 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 é vírgula (,).

Por exemplo:

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

Observação: Esta 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 para o 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 (ponto), um ponto será automaticamente inserido antes da extensão do 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 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 é 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) de

quote

No formato CSV, os campos podem ser delimitados 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 o caractere endquote.

Observação: Esta opção só se aplica a csv type.

quote: caractere

Valor padrão: O significado nulo não inclui campos com aspas.

trimspaces

Especifica como os espaços iniciais e finais dos campos são aparados para o formato CSV. Os espaços de redução serão aplicados antes da cotação do campo, se o parâmetro quote for especificado.

Consulte a descrição de trim_spec em Oracle Database 19c Utilities ou Oracle Database 26ai Utilities.

Observação: Esta 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 os resultados da consulta como um 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 .

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

Consulte access_parameters Clause em Oracle Database 19c Utilities ou Oracle Database 26ai Utilities para obter mais informações.

type: csv|datapump|json|parquet|xml

Conteúdo Relacionado

Procedimento EXPORT_DATA