Referência de funções - Amazon Aurora
aws_s3.query_export_to_s3aws_commons.create_s3_uri

Referência de funções

aws_s3.query_export_to_s3

Exporta um resultado de consulta do PostgreSQL para um bucket do Amazon S3. A extensão aws_s3 fornece a função aws_s3.query_export_to_s3.

Os dois parâmetros necessários são query e s3_info. Eles definem a consulta a ser exportada e identificam o bucket do Amazon S3 para o qual exportar. Um parâmetro opcional chamado options fornece a definição de vários parâmetros de exportação. Para obter exemplos de como usar a função aws_s3.query_export_to_s3, consulte Exportar dados de consulta usando a função aws_s3.query_export_to_s3.

Sintaxe

aws_s3.query_export_to_s3(
    query text,    
    s3_info aws_commons._s3_uri_1,    
    options text,
    kms_key text
)
Parâmetros de entrada
query

Uma string de texto necessária que contém uma consulta SQL executada pelo mecanismo do PostgreSQL. Os resultados dessa consulta são copiados em um bucket do S3 identificado no parâmetro s3_info.

s3_info

Um tipo composto aws_commons._s3_uri_1 contendo as seguintes informações sobre o objeto do S3:

  • bucket – o nome do bucket do Amazon S3 que deve conter o arquivo.

  • file_path – o nome e o caminho do arquivo do Amazon S3.

  • region: a região da AWS na qual o bucket se encontra. Para obter uma listagem de nomes de regiões da AWS e os valores associados, consulte Regiões e zonas de disponibilidade.

    Atualmente, esse valor deve ser a mesma região da AWS que de exportação do cluster de banco de dados. O padrão é a região da AWS para exportação do cluster de banco de dados.

Para criar uma estrutura aws_commons._s3_uri_1 composta, consulte a função aws_commons.create_s3_uri.

options

Uma string de texto opcional que contém argumentos para o comando COPY do PostgreSQL. Esses argumentos especificam como os dados devem ser copiados quando exportados. Para obter mais detalhes, consulte Documentação de COPY do PostgreSQL.

kms_key text

Uma string de texto opcional contendo a chave do KMS gerenciada pelo cliente do bucket do S3 para o qual exportar os dados.

Parâmetros de entrada alternativos

Para ajudar nos testes, você pode usar um conjunto expandido de parâmetros em vez do parâmetro s3_info. Veja a seguir as variações adicionais de sintaxe da função aws_s3.query_export_to_s3.

Em vez de usar o parâmetro s3_info para identificar um arquivo do Amazon S3, use a combinação dos parâmetros bucket, file_path e region.

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

Uma string de texto necessária que contém uma consulta SQL executada pelo mecanismo do PostgreSQL. Os resultados dessa consulta são copiados em um bucket do S3 identificado no parâmetro s3_info.

bucket

Uma string de texto necessária que contém o nome do bucket do Amazon S3 que contém o arquivo.

file_path

Uma string de texto necessária contendo o nome do arquivo do Amazon S3, incluindo o caminho do arquivo.

região

Uma string de texto opcional que contém a região da AWS na qual o bucket se contra. Para obter uma listagem de nomes de regiões da AWS e os valores associados, consulte Regiões e zonas de disponibilidade.

Atualmente, esse valor deve ser a mesma região da AWS que de exportação do cluster de banco de dados. O padrão é a região da AWS para exportação do cluster de banco de dados.

options

Uma string de texto opcional que contém argumentos para o comando COPY do PostgreSQL. Esses argumentos especificam como os dados devem ser copiados quando exportados. Para obter mais detalhes, consulte Documentação de COPY do PostgreSQL.

kms_key text

Uma string de texto opcional contendo a chave do KMS gerenciada pelo cliente do bucket do S3 para o qual exportar os dados.

Parâmetros de saída

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

O número de linhas da tabela que foram carregadas com êxito no Amazon S3 para a determinada consulta.

files_uploaded

O número de arquivos carregados no Amazon S3. Os arquivos são criados em tamanhos de aproximadamente 6 GB. Cada arquivo adicional criado tem _partXX acrescentado ao nome. O XX representa 2, depois 3 e assim por diante, conforme necessário.

bytes_uploaded

O número total de bytes carregados no Amazon S3.

Exemplos

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

Cria uma estrutura aws_commons._s3_uri_1 para comportar informações do arquivo do Amazon S3. Use os resultados da função aws_commons.create_s3_uri no parâmetro s3_info da função aws_s3.query_export_to_s3. Para obter um exemplo de uso da função aws_commons.create_s3_uri, consulte Especificar o caminho do arquivo do Amazon S3 para o qual exportar.

Sintaxe

aws_commons.create_s3_uri(
   bucket text,
   file_path text,
   region text
)
Parâmetros de entrada
bucket

Uma string de texto necessária contendo o nome do bucket do Amazon S3 para o arquivo.

file_path

Uma string de texto necessária contendo o nome do arquivo do Amazon S3, incluindo o caminho do arquivo.

região

Uma string de texto necessária que contém a região da AWS na qual o arquivo se encontra. Para obter uma listagem de nomes de regiões da AWS e os valores associados, consulte Regiões e zonas de disponibilidade.