Referência de funções fornecida pela extensão Armazenamento do Azure no Base de Dados do Azure para PostgreSQL flexible server

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

azure_storage.account_add

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

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

Uma versão sobrecarregada desta função aceita um account_config parâmetro que encapsula o nome da conta Armazenamento do Azure referenciada e todas as definiçõ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 membro do azure_storage_admin.

Arguments

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 único ao qual pode aceder de qualquer parte do mundo através de 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 numa tabela a que só o superutilizador pode aceder. Os utilizadores que recebem a azure_storage_admin função podem interagir com esta tabela através 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 utilitárias 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 deve passar como este argumento.

Tipo de retorno

VOID

azure_storage.account_encrypt_existing_credentials

Função que analisa uma lista de contas de armazenamento existentes que adicionaste usando azure_storage.account_add em versões mais antigas da extensão. Essas versões armazenam credenciais não encriptadas. Esta função encripta todas as credenciais usando a chave armazenada em azure_storage.credential_encryption_key. O valor de azure_storage.credential_encryption_key é definido ao nível do servidor. Portanto, se criar a extensão Armazenamento do Azure em várias bases de dados no mesmo servidor, a mesma chave de encriptação encripta todas as credenciais sensíveis armazenadas pela extensão, independentemente da base de dados onde estão armazenadas.

Importante

Se criar a extensão Armazenamento do Azure em várias bases de dados do mesmo servidor, deve executar a azure_storage.account_encrypt_existing_credentials função em cada uma dessas bases de dados.

azure_storage.account_encrypt_existing_credentials();

Permissions

Deve ser membro do azure_storage_admin.

Arguments

Esta função não aceita quaisquer argumentos.

Tipo de retorno

bigint O número de credenciais de conta de armazenamento existentes que não estavam encriptadas antes da execução da função e que agora são encriptadas usando a chave armazenada em azure_storage.credential_encryption_key.

azure_storage.account_options_managed_identity

Função que atua como função de utilidade. Chame-o como parâmetro em azure_storage.account_add. Ajuda-te a criar um valor válido para o account_config argumento quando usas uma identidade gerida atribuída por sistema para interagir com a conta do Armazenamento do Azure.

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

Permissions

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

Arguments

nome

tipo

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

Tipo de retorno

jsonb

azure_storage.account_options_credentials

Função utilitária que podes chamar como parâmetro em azure_storage.account_add. Ajuda-te a criar um valor válido para o account_config argumento quando usas uma chave de acesso do Armazenamento do Azure para interagir com a conta do Armazenamento do Azure.

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

Permissions

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

Arguments

nome

credenciais

tipo

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

Tipo de retorno

jsonb

azure_storage.account_options

Função utilitária que podes chamar como parâmetro em azure_storage.account_add. Ajuda-te a criar um valor válido para o account_config argumento quando usas uma chave de acesso do Armazenamento do Azure ou uma identidade gerida atribuída ao sistema para interagir com a conta do 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);

Permissions

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

Arguments

nome

auth_type

azure_storage.auth_type O valor de um dos tipos de armazenamento suportados. 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. O valor suportado é blob.

credenciais

Tipo de retorno

jsonb

azure_storage.account_remove

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

azure_storage.account_remove(account_name_p text);

Permissions

Deve ser membro do azure_storage_admin.

Arguments

account_name_p

Tipo de retorno

VOID

azure_storage.account_user_add

Função que concede a um utilizador 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 desta função só tem sucesso se a conta de armazenamento, cujo nome passa como primeiro argumento, já foi criada usando azure_storage.account_add, e se o utilizador ou papel, cujo nome passa como segundo argumento, já existir.

azure_storage.account_add(account_name_p text, user_p regrole);

Permissions

Deve ser membro do 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 o acesso de um utilizador ou função PostgreSQL a uma conta de armazenamento através das funções fornecidas pela azure_storage extensão.

Observação

A execução desta função só tem sucesso se a conta de armazenamento cujo nome passa como primeiro argumento já existir e ter sido criada usando azure_storage.account_add. O utilizador ou função cujo nome usas como segundo argumento também deve existir. Quando elimina um utilizador ou função do servidor ao executar DROP USER | ROLE, as permissões concedidas a qualquer referência a contas do Armazenamento do Azure também são automaticamente removidas.

azure_storage.account_user_remove(account_name_p text, user_p regrole);

Permissions

Deve ser membro do 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.lista_de_contas

Função que lista os nomes das contas de armazenamento que configuraste através da função azure_storage.account_add , juntamente com os utilizadores ou funções PostgreSQL que têm permissões para interagir com essa conta de armazenamento através das funções fornecidas pela azure_storage extensão.

azure_storage.account_list();

Permissions

Deve ser membro do azure_storage_admin.

Arguments

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 do Armazenamento do Azure adicionada, o tipo de autenticação usada para interagir com cada conta, o tipo de armazenamento e a lista de utilizadores ou funções PostgreSQL que têm 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);

Permissions

Adicione o utilizador ou função que invoca esta função à lista de permitir para o account_name executando azure_storage.account_user_add. Os membros de azure_storage_admin podem automaticamente referenciar todas as contas Armazenamento do Azure cujas referências foram adicionadas usando azure_storage.account_add.

Arguments

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 contentor, 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 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 zone a data e hora em que a mancha foi modificada 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 especifica este cabeçalho, o serviço de armazenamento verifica o hash fornecido com um que calcula a partir do conteúdo. Se os dois hashes não coincidirem, a operação falha e devolve o código de erro 400 (Pedido Mau).

azure_storage.blob_get

Função que importa dados descarregando um ficheiro de um contentor de blob numa conta do Armazenamento do Azure. Traduz o conteúdo em linhas, que pode consumir e processar usando construtos 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 aceder ao contentor da conta de armazenamento referida, esta função verifica se os nomes da conta de armazenamento e do contentor que passa como argumentos são válidos de acordo com as regras de validação de nomes impostas às contas de armazenamento do Azure. Se qualquer um dos nomes for inválido, a função devolve 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 desta função aceita um rec parâmetro que pode usar para definir convenientemente o registo 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_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. Definir para 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. Definir para 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`		Usa o algoritmo de compressão Brotli para comprimir o blob. Apenas suportado por `parquet` codificador.
`gzip`		Forças usando o algoritmo de compressão gzip para comprimir o blob.
`lz4`		Utiliza o algoritmo de compressão lz4 para comprimir o blob. O `parquet` codificador é o único que suporta este algoritmo.
`none`		Não comprime a bolha.
`snappy`		Usa o algoritmo de compressão snappy para comprimir o blob. O `parquet` codificador é o único que suporta este algoritmo.
`zstd`		Utiliza o algoritmo de compressão zstd para comprimir o blob. O `parquet` codificador é o único que suporta este algoritmo.

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

options

jsonb as definições que definem o tratamento de cabeçalhos personalizados, separadores personalizados, caracteres de escape e outras opções. options afeta o comportamento desta função de forma semelhante à forma como as opções que podes passar ao COPY comando no PostgreSQL afetam o seu comportamento.

Tipo de retorno

SETOF record SETOF anyelement

azure_storage.blob_put

Função que exporta dados carregando ficheiros para um contentor de blob numa conta do Armazenamento do Azure. A função cria o conteúdo do ficheiro 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 este parâmetro para especificar o codificador quando não possa ser inferido a partir da extensão do path parâmetro, ou quando quiser sobrescrever 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 este parâmetro para especificar a compressão quando não puder ser inferida a partir da extensão do path parâmetro, ou quando quiser sobrepor a compressã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 forma semelhante às opções que podes passar ao 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_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. Definir para 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 terminar em `.tsv` ou `.tsv.gz`, assume `tsv`. Se terminar em , , , , , ou `.txt.gz`, assume `text`. `.txt.xml.gz.xml.json.gz.json`
`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. Definir para 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`		Usa o algoritmo de compressão Brotli para comprimir o blob. Apenas suportado por `parquet` codificador.
`gzip`		Forças usando o algoritmo de compressão gzip para comprimir o blob.
`lz4`		Utiliza o algoritmo de compressão lz4 para comprimir o blob. O `parquet` codificador é o único que suporta este algoritmo.
`none`		Não comprime a bolha.
`snappy`		Usa o algoritmo de compressão snappy para comprimir o blob. O `parquet` codificador é o único que suporta este algoritmo.
`zstd`		Utiliza o algoritmo de compressão zstd para comprimir o blob. O `parquet` codificador é o único que suporta este algoritmo.

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

options

Tipo de retorno

VOID

azure_storage.options_copy

Função utilitária que pode chamar como 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);

Permissions

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

Arguments

delimitador

text O carácter que separa as colunas dentro de cada linha (linha) do ficheiro. Deve ser um único caractere de 1 byte. Embora esta função suporte delimitadores de qualquer número de caracteres, se tentar usar mais do que um único carácter de 1 byte, o PostgreSQL devolve um COPY delimiter must be a single one-byte character erro.

null_string

text A cadeia 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 Flag que indica se o ficheiro contém uma linha de cabeçalho com os nomes de cada coluna do ficheiro. Na saída, a linha inicial contém os nomes das colunas da tabela.

asserção

text O carácter de citação a usar quando um valor de dado é citado. O padrão é aspas duplas. Deve ser um único caractere de 1 byte. Embora esta função suporte delimitadores de qualquer número de caracteres, se tentar usar mais do que um único carácter de 1 byte, o PostgreSQL devolve um COPY quote must be a single one-byte character erro.

fuga

text O carácter que deve aparecer antes de um carácter de dados que corresponde ao valor QUOT. 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 esta função suporte delimitadores de qualquer número de caracteres, se tentar usar mais do que um único carácter de 1 byte, o PostgreSQL devolve 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 compares os valores das colunas especificadas com a cadeia 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[] Compare os valores das colunas especificadas com a cadeia nula, mesmo que esteja citada. Se for encontrada uma correspondência, defina o valor para 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 que o ficheiro é codificado. Se omitir esta opção, é usada a codificação atual do cliente.

Tipo de retorno

jsonb

azure_storage.options_parquet

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

azure_storage.options_parquet();

Permissions

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

Arguments

Tipo de retorno

jsonb

azure_storage.options_csv_get

Função utilitária para decodificar o conteúdo de um ficheiro CSV. Chame a esta função como um parâmetro dentro blob_getde .

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 utilizador ou função pode invocar esta função.

Arguments

delimitador

null_string

cabeçalho

boolean Flag que indica se o ficheiro contém uma linha de cabeçalho com os nomes de cada coluna do ficheiro. 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 que o ficheiro é codificado. Se omitir esta opção, é usada a codificação atual do cliente.

Tipo de retorno

jsonb

azure_storage.options_tsv

Função utilitária para decodificar o conteúdo de um ficheiro TSV. Chame a esta função como um parâmetro dentro blob_getde .

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

Permissions

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

Arguments

delimitador

null_string

content_encoding

text Nome da codificação com que o ficheiro é codificado. Se omitir esta opção, é usada a codificação atual do cliente.

Tipo de retorno

jsonb

azure_storage.options_binary

Função utilitária que pode chamar como parâmetro dentro de blob_get. Ajuda a decifrar o conteúdo de um ficheiro binário.

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

Permissions

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

Arguments

content_encoding

text Nome da codificação com que o ficheiro é codificado. Se omitir esta opção, é usada a codificação atual do cliente.

Tipo de retorno

jsonb

Comentários

Esta página foi útil?

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