Références de fonctions

aws_s3.query_export_to_s3

Exporte un résultat de requête PostgreSQL vers un compartiment Amazon S3. L’extension aws_s3 fournit la fonction aws_s3.query_export_to_s3.

Les deux paramètres requis sont query et s3_info. Ils définissent la requête à exporter et identifient le compartiment Amazon S3 vers lequel effectuer l’exportation. Un paramètre facultatif appelé options permet de définir différents paramètres d’exportation. Pour obtenir des exemples d’utilisation de la fonction aws_s3.query_export_to_s3, consultez Exportation de données de requête à l’aide de la fonction aws_s3.query_export_to_s3.

Syntaxe

aws_s3.query_export_to_s3(
    query text,    
    s3_info aws_commons._s3_uri_1,    
    options text,
    kms_key text
)

Paramètres d’entrée

query

Chaîne de texte obligatoire contenant une requête SQL exécutée par le moteur PostgreSQL. Les résultats de cette requête sont copiés dans un compartiment S3 identifié dans le paramètre s3_info.

s3_info

Type composite aws_commons._s3_uri_1 contenant les informations suivantes sur l’objet S3 :

• bucket – Nom du compartiment Amazon S3 contenant le fichier.

• file_path – Nom du fichier Amazon S3 et chemin d’accès à celui-ci.

• region – Région AWS dans laquelle se trouve le compartiment. Pour obtenir la liste des noms de régions AWS et les valeurs associées, consultez Régions et zones de disponibilité.

  Actuellement, cette valeur doit être la même région AWS que celle du cluster de bases de données à l’origine de l’exportation. La valeur par défaut est la région AWS du cluster de bases de données à l’origine de l’exportation.

Pour créer une structure composite aws_commons._s3_uri_1, consultez aws_commons.create_s3_uri fonction.

options

Chaîne de texte facultative contenant les arguments de la commande COPY de PostgreSQL. Ces arguments spécifient la façon dont les données doivent être copiées lors de l’exportation. Pour plus d’informations, consultez la documentation sur la commande COPY de PostgreSQL.

kms_key text

Chaîne de texte facultative contenant la clé KMS gérée par le client du compartiment S3 vers lequel exporter les données.

Autres paramètres d’entrée

Pour faciliter le test, vous pouvez utiliser un ensemble étendu de paramètres au lieu du paramètre s3_info. Plusieurs variations de syntaxe supplémentaires pour la fonction aws_s3.query_export_to_s3 sont fournies ci-dessous.

Au lieu d’utiliser le paramètre s3_info pour identifier un fichier Amazon S3, utilisez la combinaison des paramètres bucket, file_path et region.

aws_s3.query_export_to_s3(
    query text,    
    bucket text,    
    file_path text,    
    region text,    
    options text,
    kms_key text
)

query

Chaîne de texte obligatoire contenant une requête SQL exécutée par le moteur PostgreSQL. Les résultats de cette requête sont copiés dans un compartiment S3 identifié dans le paramètre s3_info.

bucket

Chaîne de texte obligatoire comportant le nom du compartiment Amazon S3 qui contient le fichier.

file_path

Chaîne de texte obligatoire contenant le nom du fichier Amazon S3, avec le chemin d’accès à celui-ci.

region

Chaîne de texte facultative contenant la région AWS dans laquelle se trouve le compartiment. Pour obtenir la liste des noms de régions AWS et les valeurs associées, consultez Régions et zones de disponibilité.

Actuellement, cette valeur doit être la même région AWS que celle du cluster de bases de données à l’origine de l’exportation. La valeur par défaut est la région AWS du cluster de bases de données à l’origine de l’exportation.

options

Chaîne de texte facultative contenant les arguments de la commande COPY de PostgreSQL. Ces arguments spécifient la façon dont les données doivent être copiées lors de l’exportation. Pour plus d’informations, consultez la documentation sur la commande COPY de PostgreSQL.

kms_key text

Chaîne de texte facultative contenant la clé KMS gérée par le client du compartiment S3 vers lequel exporter les données.

Paramètres de sortie

aws_s3.query_export_to_s3(
    OUT rows_uploaded bigint,
    OUT files_uploaded bigint,
    OUT bytes_uploaded bigint
)

rows_uploaded

Nombre de lignes de table qui ont été téléchargées avec succès vers Amazon S3 pour la requête donnée.

files_uploaded

Nombre de fichiers téléchargés vers Amazon S3. Les fichiers sont créés avec des tailles d’environ 6 Go. Chaque fichier supplémentaire créé voit l’élément _partXX ajouté à son nom. XX représente 2, puis 3, et ainsi de suite.

bytes_uploaded

Nombre total d’octets téléchargés vers Amazon S3.

Exemples

psql=> SELECT * from aws_s3.query_export_to_s3('select * from sample_table', 'amzn-s3-demo-bucket', 'sample-filepath');
psql=> SELECT * from aws_s3.query_export_to_s3('select * from sample_table', 'amzn-s3-demo-bucket', 'sample-filepath','us-west-2');
psql=> SELECT * from aws_s3.query_export_to_s3('select * from sample_table', 'amzn-s3-demo-bucket', 'sample-filepath','us-west-2','format text');

aws_commons.create_s3_uri

Crée une structure aws_commons._s3_uri_1 pour contenir les informations relatives au fichier Amazon S3. Vous utilisez les résultats de la fonction aws_commons.create_s3_uri dans le paramètre s3_info de la fonction aws_s3.query_export_to_s3. Pour obtenir un exemple d’utilisation de la fonction aws_commons.create_s3_uri, consultez Spécification du chemin d’accès au fichier Amazon S3 vers lequel effectuer l’exportation.

Syntaxe

aws_commons.create_s3_uri(
   bucket text,
   file_path text,
   region text
)

Paramètres d’entrée

bucket

Chaîne de texte obligatoire contenant le nom du compartiment Amazon S3 pour le fichier.

file_path

Chaîne de texte obligatoire contenant le nom du fichier Amazon S3, avec le chemin d’accès à celui-ci.

region

Chaîne de texte obligatoire contenant la région AWS dans laquelle se trouve le fichier. Pour obtenir la liste des noms de régions AWS et les valeurs associées, consultez Régions et zones de disponibilité.