Referência de funções fornecidas pela extensão Armazenamento do Azure no servidor Banco de Dados do Azure para PostgreSQL flexível

A lista a seguir mostra as funções fornecidas pela extensão Armazenamento do Azure:

azure_storage.account_add

Função que adiciona uma conta de armazenamento e sua chave de acesso associada à lista de contas de armazenamento que a azure_storage extensão pode acessar.

Se uma invocação anterior dessa função já tiver adicionado a referência a essa conta de armazenamento, ela não adicionará uma nova entrada, mas atualizará a chave de acesso da entrada existente.

Observação

Essa função não valida se o nome da conta referenciada existe ou se está acessível com a chave de acesso fornecida. No entanto, ele valida que o nome da conta de armazenamento é válido, de acordo com as regras de validação de nomenclatura impostas às contas de armazenamento do Azure.

azure_storage.account_add(account_name_p text, account_key_p text);

Uma versão sobrecarregada dessa função aceita um account_config parâmetro que encapsula o nome da conta de Armazenamento do Azure referenciada e todas as configurações necessárias, como tipo de autenticação, tipo de conta ou credenciais de armazenamento.

azure_storage.account_add(account_config jsonb);

Permissions

Deve ser um membro de azure_storage_admin.

Arguments

account_name_p

text o nome da conta de armazenamento de blobs do Azure que contém todos os seus objetos: blobs, arquivos, filas e tabelas. A conta de armazenamento fornece um namespace exclusivo que você pode acessar de qualquer lugar do mundo por HTTPS.

account_key_p

text o valor de uma das chaves de acesso da conta de armazenamento. As chaves de acesso do armazenamento de blobs do Azure são semelhantes a uma senha raiz para sua conta de armazenamento. Sempre tenha cuidado para proteger as suas chaves de acesso. Utilize o Azure Key Vault para gerenciar e girar suas chaves com segurança. A chave da conta é armazenada em uma tabela que somente o superusuário pode acessar. Os usuários que receberam a azure_storage_admin função podem interagir com essa tabela por meio de funções. Para ver quais contas de armazenamento são adicionadas, use a função azure_storage.account_list.

account_config

jsonb o nome da conta de Armazenamento do Azure e todas as configurações necessárias, como tipo de autenticação, tipo de conta ou credenciais de armazenamento. Use as funções de utilitário azure_storage.account_options_managed_identity, azure_storage.account_options_credentials ou azure_storage.account_options para criar qualquer um dos valores válidos que você deve passar como esse argumento.

Tipo de retorno

VOID

azure_storage.account_encrypt_existing_credentials

Função que verifica uma lista de contas de armazenamento existentes que você adicionou usando azure_storage.account_add em versões mais antigas da extensão. Essas versões armazenam credenciais não criptografadas. Essa função criptografa todas as credenciais usando a chave armazenada em azure_storage.credential_encryption_key. O valor de azure_storage.credential_encryption_key é escopo no nível do servidor. Portanto, se você criar a extensão Armazenamento do Azure em vários bancos de dados no mesmo servidor, a mesma chave de criptografia criptografará todas as credenciais confidenciais armazenadas pela extensão, independentemente do banco de dados no qual elas são armazenadas.

Importante

Se você criar a extensão Armazenamento do Azure em vários bancos de dados do mesmo servidor, deverá executar a azure_storage.account_encrypt_existing_credentials função em cada um desses bancos de dados.

azure_storage.account_encrypt_existing_credentials();

Permissions

Deve ser um membro de azure_storage_admin.

Arguments

Essa função não aceita argumentos.

Tipo de retorno

bigint O número de credenciais de conta de armazenamento existentes que não foram criptografadas antes de executar a função e agora são criptografadas usando a chave armazenada em azure_storage.credential_encryption_key.

azure_storage.account_options_managed_identity

Função que atua como uma função de utilitário. Chame-o como um parâmetro em azure_storage.account_add. Ele ajuda você a criar um valor válido para o account_config argumento quando você usa uma identidade gerenciada atribuída pelo sistema para interagir com a conta Armazenamento do Azure.

azure_storage.account_options_managed_identity(name text, type azure_storage.storage_type);

Permissions

Qualquer usuário ou função pode invocar essa função.

Arguments

nome

tipo

azure_storage.storage_type o valor de um dos tipos de armazenamento com suporte. O valor com suporte é blob.

Tipo de retorno

jsonb

azure_storage.account_options_credentials

Função de utilitário que você pode chamar como um parâmetro em azure_storage.account_add. Ele ajuda você a criar um valor válido para o account_config argumento quando você usa uma chave de acesso Armazenamento do Azure para interagir com a conta Armazenamento do Azure.

azure_storage.account_options_credentials(name text, credentials text, type azure_storage.storage_type);

Permissions

Qualquer usuário ou função pode invocar essa função.

Arguments

nome

credenciais

tipo

azure_storage.storage_type o valor de um dos tipos de armazenamento com suporte. O valor com suporte é blob.

Tipo de retorno

jsonb

azure_storage.account_options

azure_storage.account_options(name text, auth_type azure_storage.auth_type, storage_type azure_storage.storage_type, credentials text DEFAULT NULL);

Permissions

Qualquer usuário ou função pode invocar essa função.

Arguments

nome

auth_type

azure_storage.auth_type o valor de um dos tipos de armazenamento com suporte. Os valores com suporte são access-key e managed-identity.

storage_type

azure_storage.storage_type o valor de um dos tipos de armazenamento com suporte. O valor com suporte é blob.

credenciais

Tipo de retorno

jsonb

azure_storage.account_remove

Função que remove uma conta de armazenamento e sua chave de acesso associada da lista de contas de armazenamento que a azure_storage extensão pode acessar.

azure_storage.account_remove(account_name_p text);

Permissions

Deve ser um membro de azure_storage_admin.

Arguments

account_name_p

Tipo de retorno

VOID

azure_storage.account_user_add

Função que concede a um usuário do PostgreSQL ou acesso de função a uma conta de armazenamento por meio das funções fornecidas pela azure_storage extensão.

Observação

A execução dessa função só terá êxito se a conta de armazenamento, cujo nome você passar como o primeiro argumento, já tiver sido criada usando azure_storage.account_add e se o usuário ou a função, cujo nome você passar como o segundo argumento, já existir.

azure_storage.account_add(account_name_p text, user_p regrole);

Permissions

Deve ser um membro de azure_storage_admin.

Arguments

account_name_p

user_p

regrole o nome de um usuário ou função postgreSQL disponível no servidor.

Tipo de retorno

VOID

azure_storage.account_user_remove

Função que revoga um usuário do PostgreSQL ou acesso de função a uma conta de armazenamento por meio das funções fornecidas pela azure_storage extensão.

Observação

A execução dessa função só terá êxito se a conta de armazenamento cujo nome você passar como o primeiro argumento já existir e tiver sido criada usando azure_storage.account_add. O usuário ou a função cujo nome você passa como o segundo argumento também deve existir. Quando você remove um usuário ou função do servidor executandoDROP USER | ROLE, as permissões concedidas em qualquer referência a contas Armazenamento do Azure também são removidas automaticamente.

azure_storage.account_user_remove(account_name_p text, user_p regrole);

Permissions

Deve ser um membro de azure_storage_admin.

Arguments

account_name_p

user_p

regrole o nome de um usuário ou função postgreSQL disponível no servidor.

Tipo de retorno

VOID

azure_storage.account_list

Função que lista os nomes das contas de armazenamento que você configurou por meio da função azure_storage.account_add , juntamente com os usuários ou funções do PostgreSQL que têm permissões para interagir com essa conta de armazenamento por meio das funções fornecidas pela azure_storage extensão.

azure_storage.account_list();

Permissions

Deve ser um membro de azure_storage_admin.

Arguments

Essa função não aceita argumentos.

Tipo de retorno

TABLE(account_name text, auth_type azure_storage.auth_type, azure_storage_type azure_storage.storage_type, allowed_users regrole[])uma tabela de quatro colunas com a lista de contas Armazenamento do Azure adicionadas, o tipo de autenticação usado para interagir com cada conta, o tipo de armazenamento e a lista de usuários ou funções do PostgreSQL que têm acesso a ela.

azure_storage.blob_list

Função que lista os nomes e outras propriedades (tamanho, lastModified, eTag, contentType, contentEncoding e contentHash) de blobs armazenados no contêiner fornecido da conta de armazenamento referida.

azure_storage.blob_list(account_name text, container_name text, prefix text DEFAULT ''::text);

Permissions

Adicione o usuário ou a função que invoca essa função à lista de permissões para a account_name execução de azure_storage.account_user_add. Os membros têm azure_storage_admin permissão automaticamente para fazer referência a todas as contas Armazenamento do Azure cujas referências foram adicionadas usando azure_storage.account_add.

Arguments

account_name

nome_do_container

text o nome de um contêiner. Um contêiner organiza um conjunto de blobs, semelhante a um diretório em um sistema de arquivos. Uma conta de armazenamento pode incluir um número ilimitado de contêineres e um contêiner pode armazenar um número ilimitado de blobs. Um nome de contêiner deve ser um nome DNS (Sistema de Nomes de Domínio) válido, pois ele faz parte do URI exclusivo usado para endereçar o contêiner ou seus blobs. Ao nomear um contêiner, siga estas regras.

O URI de um contêiner é semelhante a: https://myaccount.blob.core.windows.net/mycontainer

prefix

text quando especificada, a função retorna os blobs cujos nomes começam com o valor fornecido neste parâmetro. O padrão é uma cadeia de caracteres vazia.

Tipo de retorno

TABLE(path text, bytes bigint, last_modified timestamp with time zone, etag text, content_type text, content_encoding text, content_hash text) uma tabela com um registro por blob retornado, incluindo o nome completo do blob e algumas outras propriedades.

caminho

text o nome completo do blob.

bytes

bigint o tamanho do blob em bytes.

last_modified

timestamp with time zone a data e a hora em que o blob foi modificado pela última vez. Qualquer operação que modifique o blob, incluindo uma atualização dos metadados ou das propriedades do blob, altera a hora da última modificação do blob.

etag

text a propriedade ETag é usada para simultaneidade otimista durante as atualizações. Não é um carimbo de data/hora, pois há outra propriedade chamada Timestamp que armazena a última vez que um registro foi atualizado. Por exemplo, se você carregar uma entidade e quiser atualizá-la, a ETag deverá corresponder ao que está armazenado no momento. Definir a ETag apropriada é importante porque se você tiver vários usuários editando o mesmo item, não deseja que eles substituam as alterações uns dos outros.

content_type

text o tipo de conteúdo especificado para o blob. O tipo de conteúdo padrão é application/octet-stream.

content_encoding

text a propriedade Content-Encoding de um blob que o Armazenamento do Azure permite definir. Para conteúdo compactado, você pode definir a propriedade como Gzip. Quando o navegador acessa o conteúdo, ele descompacta automaticamente o conteúdo.

content_hash

text o hash usado para verificar a integridade do blob durante o transporte. Quando você especifica esse cabeçalho, o serviço de armazenamento verifica o hash fornecido em relação a um que ele computa do conteúdo. Se os dois hashes não corresponderem, a operação falhará e retornará o código de erro 400 (Solicitação Incorreta).

azure_storage.blob_get

Função que importa dados baixando um arquivo de um contêiner de blob em uma conta de Armazenamento do Azure. Ele converte o conteúdo em linhas, que você pode consumir e processar usando constructos de linguagem SQL. Essa função adiciona suporte para filtrar e manipular os dados buscados do contêiner de blob antes de importá-lo.

Observação

Antes de tentar acessar o contêiner para a conta de armazenamento referida, essa função verifica se os nomes da conta de armazenamento e do contêiner que você passa como argumentos são válidos de acordo com as regras de validação de nomenclatura impostas às contas de armazenamento Azure. Se um dos nomes for inválido, a função retornará um erro.

azure_storage.blob_get(account_name text, container_name text, path text, decoder text DEFAULT 'auto'::text, compression text DEFAULT 'auto'::text, options jsonb DEFAULT NULL::jsonb);

Uma versão sobrecarregada dessa função aceita um rec parâmetro que você pode usar para definir convenientemente o registro de formato de saída.

azure_storage.blob_get(account_name text, container_name text, path text, rec anyelement, decoder text DEFAULT 'auto'::text, compression text DEFAULT 'auto'::text, options jsonb DEFAULT NULL::jsonb);

Permissions

Arguments

account_name

nome_do_container

O URI de um contêiner é semelhante a: https://myaccount.blob.core.windows.net/mycontainer

caminho

text o nome completo do blob.

Rec

anyelement a definição da estrutura de saída do registro.

decodificador

text a especificação do formato de blob. Defina como qualquer um dos seguintes valores:

Formato	Default	Descrição
`auto`	`true`	Infere o valor com base na última série de caracteres atribuídos ao nome do blob. Se o nome do blob terminar, `.parquet`ele pressupõe `parquet`. Se terminar com `.csv` ou `.csv.gz`, ele pressupõe `csv`. Se terminar com `.tsv` ou `.tsv.gz`, ele pressupõe `tsv`. Se terminar com `.json`, `.json.gz`, , `.xml`, `.xml.gz.txt`ou `.txt.gz`, ele pressupõe `text`.
`binary`		Formato copy do PostgreSQL binário.
`csv`		Formato de valores separados por vírgulas usado pelo PostgreSQL COPY.
`parquet`		Formato Parquet.
`text` \| `xml` \| `json`		Um arquivo que contém um único valor de texto.
`tsv`		Valores separados por tabulação, o formato padrão postgreSQL COPY.

compactação

text a especificação do tipo de compactação. Defina como qualquer um dos seguintes valores:

Formato	Default	Descrição
`auto`	`true`	Infere o valor com base na última série de caracteres atribuídos ao nome do blob. Se o nome do blob terminar, `.gz`ele pressupõe `gzip`. Caso contrário, ele pressupõe `none`.
`brotli`		Usa o algoritmo de compactação brotli para compactar o blob. Compatível apenas com `parquet` o codificador.
`gzip`		Força o uso do algoritmo de compactação gzip para compactar o blob.
`lz4`		Usa o algoritmo de compactação lz4 para compactar o blob. O `parquet` codificador é o único codificador que dá suporte a esse algoritmo.
`none`		Não compacta o blob.
`snappy`		Usa o algoritmo de compactação rápida para compactar o blob. O `parquet` codificador é o único codificador que dá suporte a esse algoritmo.
`zstd`		Usa o algoritmo de compactação zstd para compactar o blob. O `parquet` codificador é o único codificador que dá suporte a esse algoritmo.

A extensão não dá suporte a nenhum outro tipo de compactação.

Opções

jsonb as configurações que definem o tratamento de cabeçalhos personalizados, separadores personalizados, caracteres de escape e outras opções. options afeta o comportamento dessa função de forma semelhante à forma como as opções que você pode passar para o COPY comando no PostgreSQL afetam seu comportamento.

Tipo de retorno

SETOF record SETOF anyelement

azure_storage.blob_put

Função que exporta dados carregando arquivos em um contêiner de blob em uma conta de Armazenamento do Azure. A função cria o conteúdo do arquivo a partir de linhas no PostgreSQL.

Observação

azure_storage.blob_put(account_name text, container_name text, path text, tuple record)
RETURNS VOID;

Uma versão sobrecarregada da função inclui o encoder parâmetro. Use esse parâmetro para especificar o codificador quando ele não puder ser inferido da extensão do path parâmetro ou quando você quiser substituir o codificador inferido.

azure_storage.blob_put(account_name text, container_name text, path text, tuple record, encoder text)
RETURNS VOID;

Uma versão sobrecarregada da função inclui o compression parâmetro. Use esse parâmetro para especificar a compactação quando ela não puder ser inferida da extensão do path parâmetro ou quando você quiser substituir a compactação inferida.

azure_storage.blob_put(account_name text, container_name text, path text, tuple record, encoder text, compression text)
RETURNS VOID;

Uma versão sobrecarregada da função inclui o options parâmetro para lidar com cabeçalhos personalizados, separadores personalizados, caracteres de escape e outras opções. O options parâmetro funciona de maneira semelhante às opções que você pode passar para o COPY comando no PostgreSQL.

azure_storage.blob_put(account_name text, container_name text, path text, tuple record, encoder text, compression text, options jsonb)
RETURNS VOID;

Permissions

Arguments

account_name

nome_do_container

O URI de um contêiner é semelhante a: https://myaccount.blob.core.windows.net/mycontainer

caminho

text o nome completo do blob.

tupla

record a definição da estrutura de saída do registro.

codificador

text a especificação do formato de blob. Defina como qualquer um dos seguintes valores:

Formato	Default	Descrição
`auto`	`true`	Infere o valor com base na última série de caracteres atribuídos ao nome do blob. Se o nome do blob terminar com `.csv` ou `.csv.gz`, ele pressupõe `csv`. Se terminar com `.tsv` ou `.tsv.gz`, ele pressupõe `tsv`. Se terminar com `.json`, , , `.xml`, `.xml.gz`ou `.txt.txt.gz`, ele pressupõe `text.json.gz`.
`binary`		Formato copy do PostgreSQL binário.
`csv`		Formato de valores separados por vírgulas usado pelo PostgreSQL COPY.
`parquet`		Formato Parquet.
`text` \| `xml` \| `json`		Um arquivo que contém um único valor de texto.
`tsv`		Valores separados por tabulação, o formato padrão postgreSQL COPY.

compactação

text a especificação do tipo de compactação. Defina como qualquer um dos seguintes valores:

Formato	Default	Descrição
`auto`	`true`	Infere o valor com base na última série de caracteres atribuídos ao nome do blob. Se o nome do blob terminar, `.gz`ele pressupõe `gzip`. Caso contrário, ele pressupõe `none`.
`brotli`		Usa o algoritmo de compactação brotli para compactar o blob. Compatível apenas com `parquet` o codificador.
`gzip`		Força o uso do algoritmo de compactação gzip para compactar o blob.
`lz4`		Usa o algoritmo de compactação lz4 para compactar o blob. O `parquet` codificador é o único codificador que dá suporte a esse algoritmo.
`none`		Não compacta o blob.
`snappy`		Usa o algoritmo de compactação rápida para compactar o blob. O `parquet` codificador é o único codificador que dá suporte a esse algoritmo.
`zstd`		Usa o algoritmo de compactação zstd para compactar o blob. O `parquet` codificador é o único codificador que dá suporte a esse algoritmo.

A extensão não dá suporte a nenhum outro tipo de compactação.

Opções

Tipo de retorno

VOID

azure_storage.options_copy

Função do utilitário que você pode chamar como um parâmetro dentro blob_get. Ele atua como uma função auxiliar para options_parquet, options_csv_get, options_tsv e options_binary.

azure_storage.options_copy(delimiter text DEFAULT NULL::text, null_string text DEFAULT NULL::text, header boolean DEFAULT NULL::boolean, quote text DEFAULT NULL::text, escape text DEFAULT NULL::text, force_quote text[] DEFAULT NULL::text[], force_not_null text[] DEFAULT NULL::text[], force_null text[] DEFAULT NULL::text[], content_encoding text DEFAULT NULL::text);

Permissions

Qualquer usuário ou função pode invocar essa função.

Arguments

delimitador

text O caractere que separa colunas em cada linha (linha) do arquivo. Deve ser um único caractere de 1 byte. Embora essa função dê suporte a delimitadores de qualquer número de caracteres, se você tentar usar mais de um único caractere de 1 byte, o PostgreSQL retornará um COPY delimiter must be a single one-byte character erro.

null_string

text A cadeia de caracteres que representa um valor nulo. O padrão é \N (backslash-N) no formato de texto e uma cadeia de caracteres vazia sem aspas no formato CSV. Você pode preferir uma cadeia de caracteres vazia mesmo no formato de texto para casos em que você não deseja distinguir nulos de cadeias de caracteres vazias.

boolean Sinalizador que indica se o arquivo contém uma linha de cabeçalho com os nomes de cada coluna no arquivo. Na saída, a linha inicial contém os nomes de coluna da tabela.

cota

text O caractere de aspas a ser usado quando um valor de dados é citado. O padrão é aspas duplas. Deve ser um único caractere de 1 byte. Embora essa função dê suporte a delimitadores de qualquer número de caracteres, se você tentar usar mais de um único caractere de 1 byte, o PostgreSQL retornará um COPY quote must be a single one-byte character erro.

escapar

text O caractere que deve aparecer antes de um caractere de dados que corresponde ao valor QUOTE. O padrão é o mesmo que o valor QUOTE (de modo que o caractere de aspas seja duplicado se ele aparecer nos dados). Deve ser um único caractere de 1 byte. Embora essa função dê suporte a delimitadores de qualquer número de caracteres, se você tentar usar mais de um único caractere de 1 byte, o PostgreSQL retornará um COPY escape must be a single one-byte character erro.

force_quote

text[] força as aspas a serem usadas para todos os valores não NULL em cada coluna especificada. A saída NULL nunca é entre aspas. Se * for especificado, valores não NULL serão citados em todas as colunas.

force_not_null

text[] Não corresponda aos valores das colunas especificadas com a cadeia de caracteres nula. No caso padrão em que a cadeia de caracteres nula está vazia, isso significa que os valores vazios são lidos como cadeias de caracteres de comprimento zero em vez de nulos, mesmo quando não são citados.

force_null

text[] Corresponda aos valores das colunas especificadas com a cadeia de caracteres nula, mesmo que entre aspas. Se uma correspondência for encontrada, defina o valor como NULL. No caso padrão em que a cadeia de caracteres nula está vazia, ela converte uma cadeia de caracteres vazia entre aspas em NULL.

content_encoding

text Nome da codificação com a qual o arquivo é codificado. Se você omitir essa opção, a codificação atual do cliente será usada.

Tipo de retorno

jsonb

azure_storage.options_parquet

Função utilitário para decodificar o conteúdo de um arquivo Parquet. Use-o como um parâmetro em blob_get.

azure_storage.options_parquet();

Permissions

Qualquer usuário ou função pode invocar essa função.

Arguments

Tipo de retorno

jsonb

azure_storage.options_csv_get

Função utilitário para decodificar o conteúdo de um arquivo CSV. Chame essa função como um parâmetro dentro blob_get.

azure_storage.options_csv_get(delimiter text DEFAULT NULL::text, null_string text DEFAULT NULL::text, header boolean DEFAULT NULL::boolean, quote text DEFAULT NULL::text, escape text DEFAULT NULL::text, force_not_null text[] DEFAULT NULL::text[], force_null text[] DEFAULT NULL::text[], content_encoding text DEFAULT NULL::text);

Permissions

Qualquer usuário ou função pode invocar essa função.

Arguments

delimitador

null_string

cabeçalho

boolean Sinalizador que indica se o arquivo contém uma linha de cabeçalho com os nomes de cada coluna no arquivo. Na saída, a linha inicial contém os nomes de coluna da tabela.

cota

escapar

force_not_null

force_null

content_encoding

text Nome da codificação com a qual o arquivo é codificado. Se você omitir essa opção, a codificação atual do cliente será usada.

Tipo de retorno

jsonb

azure_storage.options_tsv

Função do utilitário para decodificar o conteúdo de um arquivo TSV. Chame essa função como um parâmetro dentro blob_get.

azure_storage.options_tsv(delimiter text DEFAULT NULL::text, null_string text DEFAULT NULL::text, content_encoding text DEFAULT NULL::text);

Permissions

Qualquer usuário ou função pode invocar essa função.

Arguments

delimitador

null_string

content_encoding

text Nome da codificação com a qual o arquivo é codificado. Se você omitir essa opção, a codificação atual do cliente será usada.

Tipo de retorno

jsonb

azure_storage.options_binary

Função do utilitário que você pode chamar como um parâmetro dentro blob_get. Ele ajuda a decodificar o conteúdo de um arquivo binário.

azure_storage.options_binary(content_encoding text DEFAULT NULL::text);

Permissions

Qualquer usuário ou função pode invocar essa função.

Arguments

content_encoding

text Nome da codificação com a qual o arquivo é codificado. Se você omitir essa opção, a codificação atual do cliente será usada.

Tipo de retorno

jsonb

Comentários

Esta página foi útil?

Última atualização em 2026-07-14