Documentation Oracle Cloud Infrastructure

Options de format de package 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 indiquez la sortie du fichier texte lorsque vous utilisez l'option format type et que la valeur est csv, json, parquet ou xml. Elle affiche également les options format lorsque format type est datapump.

Les deux méthodes de spécification de l'argument de format sont les suivantes :

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

Et :

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

Exemples :

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

Pour indiquer plusieurs options de format, séparez les valeurs par une virgule ",".

Exemple :

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

Ce tableau couvre 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 types de sortie, reportez-vous à DBMS_CLOUD Package Format Options pour obtenir la liste des options de format.

Option de formatage Description Syntaxe

compression

Spécifie le type de compression du fichier source.

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

Lorsque la valeur de format type est csv, json ou xml, la compression par défaut est NULL, ce qui signifie qu'aucune compression n'est effectuée.

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

Lorsque format type est datapump, vous pouvez indiquer 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 une valeur version_number indiquée.

Lorsque type est :csv | json | xml

compression:gzip | zlib | zstd | bzip2

Valeur par défaut : NULL signifiant l'absence de compression.

Lorsque type est parquet

compression: gzip | snappy

Valeur par défaut : snappy

Lorsque le type est datapump

compression: BASIC|LOW|MEDIUM|HIGH

delimiter

Indique un séparateur de champ personnalisé.

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

La valeur de séparateur ne peut pas être un code ASCII ni un caractère d'échappement.

Remarque

Cette option s'applique uniquement avec csv comme type.

delimiter : caractère

Valeur par défaut , (virgule)

endquote

Indique que les champs peuvent être placés entre deux séparateurs, avec quote et endquote. Si endquote n'est pas indiqué, le caractère quote est utilisé par défaut en tant que caractère endquote.

Exemple :

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

Cette option s'applique uniquement avec csv comme type.

endquote : caractère

Valeur par défaut : NULL, signifiant l'absence d'élément endquote.

escape

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

Remarque

Cette option s'applique uniquement avec csv comme type.

escape : true

Valeur par défaut : false

encryption

L'option de format encryption indique les options de cryptage et de décryptage permettant d'exporter et d'importer des données vers et depuis la banque d'objets.

Utilisez encryption pour indiquer les paramètres suivants pour le cryptage et le décryptage :

  • user_defined_function : indique une fonction entièrement qualifiée définie par l'utilisateur pour décrypter ou crypter le BLOB indiqué (objet LOB binaire). Il renvoie un objet BLOB déchiffré ou chiffré. Ce paramètre s'exclut mutuellement avec d'autres paramètres pour encryption.

    Par exemple, ADMIN.DECRYPTION_CALLBACK.

  • type : indique l'algorithme de cryptage intégré à décrypter ou à crypter. user_defined_function et type s'excluent mutuellement.

    type accepte les valeurs au format Algorithmes de cryptage de bloc + Modificateurs de chaînage de bloc + Modificateurs de remplissage de cryptage de bloc.

    Les algorithmes de cryptage de bloc pris en charge sont les suivants :

    • DBMS_CRYPTO.ENCRYPT_AES256

    Modificateurs de chaînage de chiffrement de bloc pris en charge :

    • DBMS_CRYPTO.CHAIN_CBC

    • DBMS_CRYPTO.CHAIN_CFB

    • DBMS_CRYPTO.CHAIN_ECB

    • DBMS_CRYPTO.CHAIN_OFB

    Modificateurs de remplissage de cryptage de bloc pris en charge :

    • DBMS_CRYPTO.PAD_PKCS5

    • DBMS_CRYPTO.PAD_NONE

    • DBMS_CRYPTO.PAD_ZERO

    • DBMS_CRYPTO.PAD_ORCL

  • credential_name : indique les informations d'identification utilisées pour stocker la clé de cryptage.

Les valeurs par défaut des modificateurs de chaînage de bloc et des modificateurs de remplissage de bloc sont DBMS_CRYPTO.CHAIN_CBC et DBMS_CRYPTO.PAD_PKCS5, si vous n'indiquez 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écrypter pour les procédures suivantes :

    • DBMS_CLOUD.COPY_DATA

    • DBMS_CLOUD.CREATE_EXTERNAL_TABLE

    • DBMS_CLOUD.CREATE_HYBRID_TABLE

    • DBMS_CLOUD.COPY_COLLECTION

  • Utilisé pour transmettre les paramètres à crypter 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 cryptage :

type : value

Spécifie le type de chiffrement.

credential_name: value

Indique les informations d'identification utilisées pour stocker la clé de cryptage.

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 LOB binaire).

header

Ecrit 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 valides sont les suivantes :

  • false : ignore la ligne d'en-tête.

  • true : inclut la ligne d'en-tête. Les noms de colonne sont basés sur l'instruction SELECT du paramètre query. Vous devez indiquer des alias de colonne dans l'instruction SELECT lorsque vous utilisez des expressions ou des colonnes virtuelles.

  • String to define custom header names : permet de définir des lignes d'en-tête avec des noms personnalisés. Le nombre de colonnes et de séparateurs dans la valeur de chaîne doit correspondre au nombre de colonnes et de séparateurs dans l'instruction 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)
Remarque

Cette option s'applique uniquement avec csv comme type.

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

Valeur par défaut : false

fileextension

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

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

Si vous ne voulez utiliser aucune extension de fichier, indiquez la valeur : fileextension ='none'

Valeurs valides : n'importe quelle extension de fichier.

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

maxfilesize

Nombre en octets indiquant la taille maximale de la sortie générée.

Il s'applique aux formats texte pour l'export de données avec DBMS_CLOUD.EXPORT_DATA lorsque l'option de format type est définie sur csv, json ou xml.

Remarque : 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 placés entre deux séparateurs. Renseignez les délimiteurs avec quote et endquote. Si endquote n'est pas indiqué, le caractère quote est utilisé par défaut en tant que caractère endquote.

Remarque

Cette option s'applique uniquement avec csv comme type.

quote : caractère

Valeur par défaut : NULL, ce qui signifie qu'il ne faut pas inclure les champs entre apostrophes.

trimspaces

Indique la façon dont sont tronqués les espaces de début et de fin des champs pour le format CSV. La troncature d'espaces est appliquée avant de placer le champ entre apostrophes, si le paramètre quote est indiqué.

Reportez-vous à la description de trim_spec.

Remarque

Cette option s'applique uniquement avec csv comme type.

trimspaces : rtrim| ltrim| notrim| lrtrim| ldrtrim

Valeur par défaut : notrim.

type

Spécifie le type de fichier de sortie.

csv : indique le format CSV ( valeurs séparées par un caractère) qui permet d'exporter les résultats de requête sous forme d'un ensemble de valeurs de colonne séparées par un caractère personnalisé.

json : indique l'export des résultats de requête sous forme de fichiers JSON.

parquet : indique d'exporter les résultats de requête en tant que fichiers Parquet.

xml : indique l'export des résultats de requête sous forme de lignes de documents XML valides. Chaque ligne est encapsulée dans une balise XML racine de <RECORD> </RECORD>.

Le résultat de requête est automatiquement converti au 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 est datapump, vous pouvez indiquer 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 une valeur version_number indiquée.

Pour plus d'informations, reportez-vous à access_parameters Clause.

type: csv|datapump|json|parquet|xml

Thème parent : Package DBMS_CLOUD