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

A seguir está a lista de funções fornecidas pela extensão de Armazenamento do Azure:

azure_storage.account_add

Função que permite adicionar 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 desta função já adicionou a referência a esta conta de armazenamento, ela não adiciona uma nova entrada, mas atualiza a chave de acesso da entrada existente.

Observação

Esta função não valida se o nome da conta referida existe ou se está acessível com a chave de acesso fornecida. No entanto, ele valida se 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);

Há uma versão sobrecarregada dessa função, que 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);

Permissões

Deve ser membro do azure_storage_admin.

Argumentos

account_name_p

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

account_key_p

text O valor de uma das chaves de acesso para a conta de armazenamento. Suas chaves de acesso de armazenamento de blob do Azure são semelhantes a uma senha de root para sua conta de armazenamento. Tenha sempre o cuidado de proteger as suas chaves de acesso. Use o Azure Key Vault para gerenciar e girar suas chaves com segurança. A chave da conta é armazenada em uma tabela acessível apenas pelo superusuário. 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. Recomendamos o uso das funções do 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 devem ser passados como esse argumento.

Tipo de retorno

VOID

azure_storage.account_options_managed_identity

Função que atua como uma função utilitária, que pode ser chamada como um parâmetro dentro de azure_storage.account_add, e é útil para produzir um valor válido para o account_config argumento, ao usar uma identidade gerenciada atribuída ao sistema para interagir com a conta de Armazenamento do Azure.

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

Permissões

Qualquer utilizador ou função pode invocar esta função.

Argumentos

nome

tipo

azure_storage.storage_type O valor de um dos tipos de armazenamento suportados. Apenas o valor suportado é blob.

Tipo de retorno

jsonb

azure_storage.account_options_credentials

Função que atua como uma função utilitária, que pode ser chamada como um parâmetro dentro de azure_storage.account_add, e é útil para produzir um valor válido para o account_config argumento, ao usar uma chave de acesso do Armazenamento do Azure para interagir com a conta de Armazenamento do Azure.

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

Permissões

Qualquer utilizador ou função pode invocar esta função.

Argumentos

nome

credenciais

tipo

azure_storage.storage_type O valor de um dos tipos de armazenamento suportados. Apenas o valor suportado é blob.

Tipo de retorno

jsonb

azure_storage.account_options

Função que atua como uma função utilitária, que pode ser chamada como um parâmetro dentro de azure_storage.account_add, e é útil para produzir um valor válido para o argumento, ao usar uma chave de acesso do account_config Armazenamento do Azure ou uma identidade gerenciada atribuída ao sistema para interagir com a conta de Armazenamento do Azure.

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

Permissões

Qualquer utilizador ou função pode invocar esta função.

Argumentos

nome

auth_type

azure_storage.auth_type O valor de um dos tipos de armazenamento suportados. Apenas os valores suportados são access-key, e managed-identity.

storage_type

azure_storage.storage_type O valor de um dos tipos de armazenamento suportados. Apenas o valor suportado é blob.

credenciais

Tipo de retorno

jsonb

azure_storage.account_remove

Função que permite remover 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);

Permissões

Deve ser membro do azure_storage_admin.

Argumentos

account_name_p

Tipo de retorno

VOID

azure_storage.account_user_add

Função que permite conceder a um usuário ou função PostgreSQL acesso a uma conta de armazenamento através das funções fornecidas pela azure_storage extensão.

Observação

A execução dessa função só será bem-sucedida se a conta de armazenamento, cujo nome está sendo passado como o primeiro argumento, já tiver sido criada usando azure_storage.account_add e se o usuário ou função, cujo nome é passado como o segundo argumento, já existir.

azure_storage.account_add(account_name_p text, user_p regrole);

Permissões

Deve ser membro do azure_storage_admin.

Argumentos

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 permite revogar o acesso de um usuário ou função PostgreSQL a uma conta de armazenamento através das azure_storage funções fornecidas pela extensão.

Observação

A execução dessa função só terá êxito se a conta de armazenamento cujo nome está sendo passado como o primeiro argumento já tiver sido criada usando azure_storage.account_add e se o usuário ou função cujo nome é passado como o segundo argumento ainda existir. Quando um usuário ou função é descartado do servidor, ao executar DROP USER | ROLE, as permissões concedidas em qualquer referência às contas de Armazenamento do Azure também são eliminadas automaticamente.

azure_storage.account_user_remove(account_name_p text, user_p regrole);

Permissões

Deve ser membro do azure_storage_admin.

Argumentos

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

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

azure_storage.account_list();

Permissões

Deve ser membro do azure_storage_admin.

Argumentos

Esta função não aceita quaisquer 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 de 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 aos quais é concedido acesso a ela.

azure_storage.blob_list

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

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

Permissões

O usuário ou função que invoca essa função deve ser adicionado à lista de permissões para o account_name referenciado, executando azure_storage.account_user_add. Os membros de têm permissão automática para fazer referência a todas as contas de Armazenamento do Azure cujas referências foram adicionadas azure_storage_admin usando azure_storage.account_add.

Argumentos

account_name

nome_do_conteiner

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 faz parte do URI exclusivo usado para endereçar o contêiner ou seus blobs. Ao nomear um contêiner, certifique-se de seguir estas regras.

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

prefixo

text Quando especificada, a função retorna os blobs cujos nomes começam com o valor fornecido nesse 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 zoneA 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 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, o 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 esse cabeçalho é especificado, o serviço de armazenamento verifica o hash fornecido com um calculado a partir do conteúdo. Se os dois hashes não corresponderem, a operação falhará com o código de erro 400 (Solicitação incorreta).

azure_storage.blob_get

Função que permite importar dados. Ele baixa um arquivo de um contêiner de blob em uma conta de Armazenamento do Azure. Em seguida, ele traduz o conteúdo em linhas, que podem ser consumidas e processadas com construções de linguagem SQL. Esta função adiciona suporte para filtrar e manipular os dados obtidos 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 passados como argumentos são válidos de acordo com as regras de validação de nomenclatura impostas às contas de armazenamento do Azure. Se qualquer um deles for inválido, um erro será gerado.

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);

Há uma versão sobrecarregada dessa função, que aceita um rec parâmetro que permite definir convenientemente o registro do 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);

Permissões

Argumentos

account_name

nome_do_conteiner

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 produção de registos.

descodificador

text A especificação do formato Blob. Pode ser definido como qualquer um dos seguintes valores:

Formato	Predefinição	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 `.parquet`, ele assume `parquet`. Se termina com `.csv` ou `.csv.gz`, assume `csv`. Se termina com `.tsv` ou `.tsv.gz`, assume `tsv`. Se termina com `.json`, `.json.gz`, , `.xml.xml.gz`, `.txt`, ou `.txt.gz`, assume `text`.
`binary`		Formato binário PostgreSQL COPY.
`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ções, o formato padrão PostgreSQL COPY.

compressão

text a especificação do tipo de compressão. Pode ser definido como qualquer um dos seguintes valores:

Formato	Predefinição	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 `.gz`, ele assume `gzip`. Caso contrário, assume `none`.
`brotli`		Forças usando o algoritmo de compressão de brotli para comprimir a bolha. Apenas suportado por `parquet` codificador.
`gzip`		Forças usando o algoritmo de compressão gzip para comprimir o blob.
`lz4`		Forças usando o algoritmo de compressão lz4 para comprimir o blob. Apenas suportado por `parquet` codificador.
`none`		Força para não comprimir a bolha.
`snappy`		Forças usando o algoritmo de compressão snappy para comprimir o blob. Apenas suportado por `parquet` codificador.
`zstd`		Forças usando o algoritmo de compressão zstd para comprimir o blob. Apenas suportado por `parquet` codificador.

A extensão não suporta outros tipos de compressão.

Opções

jsonb as configurações que definem a manipulação de cabeçalhos personalizados, separadores personalizados, caracteres de escape, etc. options afeta o comportamento dessa função de forma semelhante a 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 permite exportar dados, carregando arquivos em um contêiner de blob em uma conta de Armazenamento do Azure. O conteúdo dos arquivos é produzido a partir de linhas em PostgreSQL.

Observação

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

Há uma versão sobrecarregada da função, contendo encoder o parâmetro que permite especificar o codificador a ser usado quando ele não puder ser inferido a partir da extensão do path parâmetro ou quando você quiser substituir o inferido.

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

Há uma versão sobrecarregada da função que também contém um compression parâmetro que permite especificar a compactação a ser usada quando ela não puder ser inferida a partir da extensão do path parâmetro ou quando você quiser substituir a que foi inferida.

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

Há uma versão sobrecarregada da função que também contém um options parâmetro para lidar com cabeçalhos personalizados, separadores personalizados, caracteres de escape, etc. options funciona de forma semelhante às opções que podem ser passadas 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;

Permissões

Argumentos

account_name

nome_do_conteiner

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

caminho

text O nome completo do blob.

cadeia de identificação

record a definição da estrutura de produção de registos.

codificador

text A especificação do formato Blob. Pode ser definido como qualquer um dos seguintes valores:

Formato	Predefinição	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 assume `csv`. Se termina com `.tsv` ou `.tsv.gz`, assume `tsv`. Se termina com `.json`, `.json.gz`, , `.xml.xml.gz`, `.txt`, ou `.txt.gz`, assume `text`.
`binary`		Formato binário PostgreSQL COPY.
`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ções, o formato padrão PostgreSQL COPY.

compressão

text a especificação do tipo de compressão. Pode ser definido como qualquer um dos seguintes valores:

Formato	Predefinição	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 `.gz`, ele assume `gzip`. Caso contrário, assume `none`.
`brotli`		Forças usando o algoritmo de compressão de brotli para comprimir a bolha. Apenas suportado por `parquet` codificador.
`gzip`		Forças usando o algoritmo de compressão gzip para comprimir o blob.
`lz4`		Forças usando o algoritmo de compressão lz4 para comprimir o blob. Apenas suportado por `parquet` codificador.
`none`		Força para não comprimir a bolha.
`snappy`		Forças usando o algoritmo de compressão snappy para comprimir o blob. Apenas suportado por `parquet` codificador.
`zstd`		Forças usando o algoritmo de compressão zstd para comprimir o blob. Apenas suportado por `parquet` codificador.

A extensão não suporta outros tipos de compressão.

Opções

Tipo de retorno

VOID

azure_storage.options_copy

Função que atua como uma função de utilidade, que pode ser chamada como um parâmetro dentro de blob_get. Funciona como 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);

Permissões

Qualquer utilizador ou função pode invocar esta função.

Argumentos

delimitador

text O caractere que separa colunas dentro de cada linha (linha) do arquivo. Deve ser um único caractere de 1 byte. Embora essa função ofereça suporte a delimitadores de qualquer número de caracteres, se você tentar usar mais de um único caractere de 1 byte, o PostgreSQL relatará 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 (barra invertida-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 em formato de texto, para casos em que 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 das colunas da tabela.

asserção

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

fuga

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 (para que o caractere de cotação seja dobrado se aparecer nos dados). Deve ser um único caractere de 1 byte. Embora essa função ofereça suporte a delimitadores de qualquer número de caracteres, se você tentar usar mais de um único caractere de 1 byte, o PostgreSQL relatará um COPY escape must be a single one-byte character erro.

force_quote

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

force_not_null

text[] não correspondem aos valores das colunas especificadas em relação à 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 estão entre aspas.

force_null

text[] corresponder aos valores das colunas especificadas em relação à cadeia de caracteres nula, mesmo se citada, e 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 a opção for omitida, a codificação do cliente atual será usada.

Tipo de retorno

jsonb

azure_storage.options_parquet

Função que atua como função utilitária, que pode ser chamada como um parâmetro dentro de blob_get, e é útil para decodificar o conteúdo de um ficheiro de parquet.

azure_storage.options_parquet();

Permissões

Qualquer utilizador ou função pode invocar esta função.

Argumentos

Tipo de retorno

jsonb

azure_storage.options_csv_get

Função que atua como uma função utilitária, que pode ser chamada como um parâmetro dentro blob_getdo , e é útil para decodificar o conteúdo de um arquivo csv.

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);

Permissões

Qualquer utilizador ou função pode invocar esta função.

Argumentos

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 das colunas da tabela.

asserção

fuga

force_not_null

force_null

content_encoding

text Nome da codificação com a qual o arquivo é codificado. Se a opção for omitida, a codificação do cliente atual será usada.

Tipo de retorno

jsonb

azure_storage.options_tsv

Função que atua como uma função utilitária, que pode ser chamada como um parâmetro dentro blob_getdo , e é útil para decodificar o conteúdo de um arquivo tsv.

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

Permissões

Qualquer utilizador ou função pode invocar esta função.

Argumentos

delimitador

null_string

content_encoding

text Nome da codificação com a qual o arquivo é codificado. Se a opção for omitida, a codificação do cliente atual será usada.

Tipo de retorno

jsonb

azure_storage.options_binary

Função que atua como uma função utilitária, que pode ser chamada como um parâmetro dentro blob_getdo , e é útil para decodificar o conteúdo de um arquivo binário.

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

Permissões

Qualquer utilizador ou função pode invocar esta função.

Argumentos

content_encoding

text Nome da codificação com a qual o arquivo é codificado. Se a opção for omitida, a codificação do cliente atual será usada.

Tipo de retorno

jsonb

Comentários

Esta página foi útil?

Last updated on 2025-11-19

Partilhar via

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

azure_storage.account_add

Permissões

Argumentos

account_name_p

account_key_p

account_config

Tipo de retorno

azure_storage.account_options_managed_identity

Permissões

Argumentos

nome

tipo

Tipo de retorno

azure_storage.account_options_credentials

Permissões

Argumentos

nome

credenciais

tipo

Tipo de retorno

azure_storage.account_options

Permissões

Argumentos

nome

auth_type

storage_type

credenciais

Tipo de retorno

azure_storage.account_remove

Permissões

Argumentos

account_name_p

Tipo de retorno

azure_storage.account_user_add

Permissões

Argumentos

account_name_p

user_p

Tipo de retorno

azure_storage.account_user_remove

Permissões

Argumentos

account_name_p

user_p

Tipo de retorno

azure_storage.lista_de_contas

Permissões

Argumentos

Tipo de retorno

azure_storage.blob_list

Permissões

Argumentos

account_name

nome_do_conteiner

prefixo

Tipo de retorno

caminho

Bytes

last_modified

etag

content_type

content_encoding

content_hash

azure_storage.blob_get

Permissões

Argumentos

account_name

nome_do_conteiner

caminho

rec

descodificador

compressão

Opções

Tipo de retorno

azure_storage.blob_put

Permissões

Argumentos

account_name