Referência de funções - Amazon Aurora

Referência de funções

aws_s3.table_import_from_s3

Importa dados do Amazon S3 para uma tabela do do Aurora PostgreSQL. A extensão aws_s3 fornece a função aws_s3.table_import_from_s3. O valor de retorno é texto.

Sintaxe

Os parâmetros necessários são table_name, column_list e options. Eles identificam a tabela do banco de dados e especificam como os dados são copiados nessa tabela.

Você também pode usar os seguintes parâmetros:

  • O parâmetro s3_info especifica o arquivo do Amazon S3 a ser importado. Quando você usa esse parâmetro, o acesso ao Amazon S3 é fornecido por uma função do IAM para a do cluster de banco de dados do PostgreSQL.

    aws_s3.table_import_from_s3 ( table_name text, column_list text, options text, s3_info aws_commons._s3_uri_1 )
  • O parâmetro credentials especifica as credenciais para acessar o Amazon S3. Ao usar esse parâmetro, você não usa uma função do IAM.

    aws_s3.table_import_from_s3 ( table_name text, column_list text, options text, s3_info aws_commons._s3_uri_1, credentials aws_commons._aws_credentials_1 )

Parâmetros

table_name

Uma string de texto necessária contendo o nome da tabela de banco de dados PostgreSQL para a qual importar os dados.

column_list

Uma string de texto necessária contendo uma lista opcional das colunas da tabela de banco de dados PostgreSQL para a qual copiar os dados. Se a string estiver vazia, todas as colunas da tabela serão usadas. Para ver um exemplo, consulte Importar um arquivo do Amazon S3 que usa um delimitador personalizado.

options

Uma string de texto necessária contendo argumentos para o comando PostgreSQL COPY. Esses argumentos especificam como os dados devem ser copiados para a tabela do PostgreSQL. Para obter mais detalhes, consulte Documentação de COPY do PostgreSQL.

s3_info

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

  • bucket – O nome do Amazon S3 bucket que contém o arquivo.

  • file_path – o nome do Amazon S3 arquivo, incluindo o caminho do arquivo.

  • region: a região da AWS em que 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.

credenciais

Um tipo composto aws_commons._aws_credentials_1 contendo as seguintes credenciais a serem usadas para a operação de importação:

  • Chave de acesso

  • Chave secreta

  • Token de sessão

Para obter informações sobre como criar uma estrutura aws_commons._aws_credentials_1 composta, consulte aws_commons.create_aws_credentials.

Sintaxe alternativa

Para ajudar nos testes, você pode usar um conjunto expandido de parâmetros em vez dos parâmetros s3_info e credentials. Veja a seguir as variações acionais da sintaxe da função aws_s3.table_import_from_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. Com essa forma da função, o acesso ao Amazon S3 é fornecido por uma função do IAM na instância de banco de dados do PostgreSQL.

    aws_s3.table_import_from_s3 ( table_name text, column_list text, options text, bucket text, file_path text, region text )
  • Em vez de usar o parâmetro credentials para especificar o acesso ao Amazon S3, use a combinação dos parâmetros access_key, session_key e session_token.

    aws_s3.table_import_from_s3 ( table_name text, column_list text, options text, bucket text, file_path text, region text, access_key text, secret_key text, session_token text )

Parâmetros alternativos

bucket

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

file_path

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

região

Uma string de texto que identifica a Região da AWS do arquivo. Para obter uma listagem de nomes de Região da AWS e os valores associados, consulte Regiões e zonas de disponibilidade.

access_key

Uma string de texto contendo a chave de acesso a ser usada para a operação de importação. O padrão é NULL.

secret_key

Uma string de texto contendo a chave secreta a ser usada para a operação de importação. O padrão é NULL.

session_token

(Opcional) Uma string de texto contendo a chave de sessão a ser usada para a operação de importação. O padrão é NULL.

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.table_import_from_s3.

Sintaxe

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

Parâmetros

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ão da AWS e os valores associados, consulte Regiões e zonas de disponibilidade.

aws_commons.create_aws_credentials

Define uma chave de acesso e uma chave secreta em uma estrutura aws_commons._aws_credentials_1. Use os resultados da função aws_commons.create_aws_credentials no parâmetro credentials da função aws_s3.table_import_from_s3.

Sintaxe

aws_commons.create_aws_credentials( access_key text, secret_key text, session_token text )

Parâmetros

access_key

Uma string de texto necessária contendo a chave de acesso a ser usada para importar um arquivo do Amazon S3. O padrão é NULL.

secret_key

Uma string de texto necessária contendo a chave secreta a ser usada para importar um arquivo do Amazon S3. O padrão é NULL.

session_token

Uma string de texto opcional contendo o token de sessão a ser usado para importar um arquivo do Amazon S3. O padrão é NULL. Se você fornecer um session_token opcional, poderá usar credenciais temporárias.