Documentation sur Oracle Cloud Infrastructure

Options de format de l'ensemble DBMS_CLOUD pour EXPORT_DATA

Décrit les options de paramètre de format valides pour DBMS_CLOUD.EXPORT_DATA avec les formats de fichier texte, CSV, JSON, Parquet ou XML et pour Oracle Data Pump.

Il s'agit des paramètres format valides à utiliser avec DBMS_CLOUD.EXPORT_DATA. Vous spécifiez la sortie du fichier texte lorsque vous utilisez l'option format type et que la valeur est l'une des suivantes : csv, json, parquet ou xml. Cela affiche également les options format lorsque format type est datapump.

Les deux façons de spécifier l'argument de format sont :

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

Et :

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

Exemples :

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

Pour spécifier plusieurs options de format, séparez les valeurs par une ",".

Exemple :

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

Ce tableau présente les options de format pour DBMS_CLOUD.EXPORT_DATA lorsque l'option type du paramètre format est l'une des suivantes : CSV, JSON, Parquet ou XML. Pour les autres procédures et autres types de sortie, voir Options de format d'ensemble DBMS_CLOUD pour la liste des options de format.

Option de format Description Syntaxe

compression

Indique le type de compression du fichier source.

Note : Le format d'archivage ZIP n'est pas pris en charge.

Lorsque format type est csv, json ou xml, la compression par défaut est nulle, ce qui signifie qu'il n'y a pas de compression.

Lorsque format type est parquet, la compression par défaut est snappy.

Lorsque format type a la valeur datapump, vous pouvez spécifier les paramètres d'accès Oracle Data Pump pris en charge :

  • compression : Les valeurs valides sont : BASIC, LOW, MEDIUM et HIGH.

  • version : Les valeurs valides sont : COMPATIBLE, LATEST et version_number spécifié.

Lorsque type est :csv | json | xml

compression:gzip | zlib | zstd | bzip2

Valeur par défaut : Valeur nulle signifiant qu'aucune compression n'est effectuée.

Lorsque type est parquet

compression: gzip | snappy

Valeur par défaut : snappy

Lorsque le type est datapump

compression: BASIC|LOW|MEDIUM|HIGH

delimiter

Spécifie un délimiteur de champ personnalisé.

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

La valeur du délimiteur ne peut pas être un code ASCII ou un caractère d'échappement.

Note

Cette option s'applique uniquement à csv type.

delimiter : caractère

Valeur par défaut , (virgule)

endquote

Spécifie que les champs peuvent être délimités entre deux délimiteurs, avec quote et endquote. Si endquote n'est pas spécifié, le caractère quote sera utilisé par défaut en tant que caractère endquote.

Exemple :

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

Cette option s'applique uniquement à csv type.

endquote :caractère

Valeur par défaut : Nul, ce qui signifie qu'il n'y a pas de endquote.

escape

Spécifie l'occurrence du caractère de guillemet dans la valeur du champ à l'aide du caractère "\".

Note

Cette option s'applique uniquement à csv type.

escape : true

Valeur par défaut : false

encryption

L'option de format encryption spécifie les options de chiffrement et de déchiffrement pour exporter et importer des données vers et depuis le magasin d'objets.

Utilisez encryption pour spécifier les paramètres suivants pour chiffrer et déchiffrer :

  • user_defined_function : Spécifie une fonction entièrement qualifiée définie par l'utilisateur pour déchiffrer ou chiffrer le BLOB spécifié (objet volumineux binaire). Il renvoie un objet BLOB déchiffré ou chiffré. Ce paramètre est mutuellement exclusif avec d'autres paramètres pour encryption.

    Par exemple, ADMIN.DECRYPTION_CALLBACK.

  • type : Spécifie l'algorithme de chiffrement intégré à déchiffrer ou à chiffrer. user_defined_function et type s'excluent mutuellement.

    type accepte les valeurs au format Algorithmes de chiffrement par blocs + Modificateurs d'enchaînement de chiffrement par blocs + Modificateurs d'empilement de chiffrement par blocs.

    Les algorithmes de chiffrement par blocs pris en charge sont les suivants :

    • DBMS_CRYPTO.ENCRYPT_AES256

    Les modificateurs d'enchaînement de chiffrement par blocs pris en charge sont les suivants :

    • DBMS_CRYPTO.CHAIN_CBC

    • DBMS_CRYPTO.CHAIN_CFB

    • DBMS_CRYPTO.CHAIN_ECB

    • DBMS_CRYPTO.CHAIN_OFB

    Les modificateurs de remplissage de chiffrement de bloc pris en charge sont les suivants :

    • DBMS_CRYPTO.PAD_PKCS5

    • DBMS_CRYPTO.PAD_NONE

    • DBMS_CRYPTO.PAD_ZERO

    • DBMS_CRYPTO.PAD_ORCL

  • credential_name : Spécifie les données d'identification utilisées pour stocker la clé de chiffrement.

Les valeurs par défaut des modificateurs d'enchaînement de chiffrement par blocs et des modificateurs de remplissage de chiffrement par blocs sont DBMS_CRYPTO.CHAIN_CBC et DBMS_CRYPTO.PAD_PKCS5, si vous ne spécifiez pas de valeurs pour ces paramètres.

L'option de format encryption est utilisée avec les procédures DBMS_CLOUD suivantes :

  • Utilisé pour transmettre les paramètres à déchiffrer pour ces procédures :

    • DBMS_CLOUD.COPY_DATA

    • DBMS_CLOUD.CREATE_EXTERNAL_TABLE

    • DBMS_CLOUD.CREATE_HYBRID_TABLE

    • DBMS_CLOUD.COPY_COLLECTION

  • Sert à transmettre des paramètres à chiffrer pour la procédure suivante :

    • DBMS_CLOUD.EXPORT_DATA

Exemple :

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

Où value est une chaîne JSON qui fournit des paramètres supplémentaires pour le chiffrement :

type : value

Spécifie le type de chiffrement.

credential_name: value

Spécifie les données d'identification utilisées pour stocker la clé de chiffrement.

user_defined_function: value

Spécifie une fonction entièrement qualifiée définie par l'utilisateur pour déchiffrer ou chiffrer le BLOB spécifié (objet volumineux binaire).

header

Écrit les noms de colonne en tant que première ligne dans les fichiers de sortie de type csv.

L'option header peut accepter une valeur boolean ou string.

Les valeurs possibles sont :

  • false : Ignore la rangée d'en-tête.

  • true : Inclut la rangée d'en-tête. Les noms de colonne sont basés sur l'énoncé SELECT du paramètre query. Vous devez spécifier des alias de colonne dans l'énoncé SELECT lors de l'utilisation de colonnes ou d'expressions virtuelles.

  • String to define custom header names : Permet de définir des rangées d'en-tête avec des noms personnalisés. Le nombre de colonnes et de délimiteurs dans la valeur de chaîne doit correspondre au nombre de colonnes et de délimiteurs dans l'énoncé SELECT. Le délimiteur par défaut est la virgule (,).

Exemple :

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

Cette option s'applique uniquement à csv type.

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

Valeur par défaut : false

fileextension

Extension de fichier personnalisée pour remplacer le choix par défaut pour le type de format. Cela s'applique aux formats de texte avec DBMS_CLOUD.EXPORT_DATA : CSV, JSON, Parquet ou XML.

Si la chaîne spécifiée ne commence pas par point (point), un point est automatiquement inséré avant l'extension de fichier dans le nom du fichier final.

Si aucune extension de fichier n'est souhaitée, utilisez la valeur : fileextension ='none'

Valeurs valides : Toute extension de fichier.

Valeur par défaut : Dépend de l'option format type :
  • Format CSV : .csv
  • Format JSON : .json
  • Format PARQUET : .parquet
  • Format XML : .xml

maxfilesize

Nombre d'octets pour la taille maximale de la sortie générée.

Cela s'applique aux formats basés sur du texte pour l'exportation de données avec DBMS_CLOUD.EXPORT_DATA lorsque l'option format type est réglée à,csv, json ou xml.

Note : Cette option n'est pas valide lorsque l'option format type est parquet.

Valeur minimale : 10485760 (10 Mo )

Valeur maximale : 1 Go

Valeur par défaut : 10485760 (10 Mo)

quote

Au format CSV, les champs peuvent être délimités entre deux délimiteurs. Spécifiez les délimiteurs avec quote et endquote. Si endquote n'est pas spécifié, le caractère quote sera utilisé par défaut en tant que caractère endquote.

Note

Cette option s'applique uniquement à csv type.

quote: character

Valeur par défaut : La signification nulle ne place pas les champs entre guillemets.

trimspaces

Indique comment les espaces de début et de fin des champs sont tronqués au format CSV. Les espaces de délimitation sont appliqués avant la soumission du champ, si le paramètre quote est spécifié.

Voir la description de trim_spec.

Note

Cette option s'applique uniquement à csv type.

trimspaces : rtrim| ltrim| notrim| lrtrim| ldrtrim

Valeur par défaut : notrim

type

Spécifie le type de fichier de sortie.

csv : Spécifie le format CSV (Valeurs séparées par des caractères) qui vous permet d'exporter les résultats d'interrogation sous la forme d'un jeu de valeurs de colonne séparées par un caractère personnalisé.

json : Spécifie d'exporter les résultats de l'interrogation sous forme de fichiers JSON.

parquet : Spécifie d'exporter les résultats de l'interrogation en tant que fichiers Parquet.

xml : Spécifie d'exporter les résultats d'interrogation en tant que rangées de documents XML valides. Chaque rangée est encapsulée dans une balise XML racine de <RECORD> </RECORD>.

Le résultat de l'interrogation est automatiquement transformé en format XML à l'aide de la fonction SQL XMLFOREST. Utilisez des alias de colonne pour personnaliser les noms de balise XML des colonnes.

Lorsque format type a la valeur datapump, vous pouvez spécifier les paramètres d'accès Oracle Data Pump pris en charge :

  • compression : Les valeurs valides sont : BASIC, LOW, MEDIUM et HIGH.

  • version : Les valeurs valides sont : COMPATIBLE, LATEST et version_number spécifié.

Pour plus d'informations, voir Clause access_parameters.

type: csv|datapump|json|parquet|xml

Rubrique parent : DBMS_CLOUD Ensemble