Reference of functions provided by the Azure Storage extension in Azure Database for PostgreSQL flexible server

The following list shows the functions provided by the Azure Storage extension:

azure_storage.account_add

Function that adds a storage account and its associated access key to the list of storage accounts that the azure_storage extension can access.

If a previous invocation of this function already added the reference to this storage account, it doesn't add a new entry but instead updates the access key of the existing entry.

Note

This function doesn't validate if the referred account name exists or if it's accessible with the access key provided. However, it validates that the name of the storage account is valid, according to the naming validation rules imposed on Azure storage accounts.

azure_storage.account_add(account_name_p text, account_key_p text);

An overloaded version of this function accepts an account_config parameter that encapsulates the name of the referenced Azure Storage account, and all the required settings like authentication type, account type, or storage credentials.

azure_storage.account_add(account_config jsonb);

Permissions

Must be a member of azure_storage_admin.

Arguments

account_name_p

text the name of the Azure blob storage account that contains all of your objects: blobs, files, queues, and tables. The storage account provides a unique namespace that you can access from anywhere in the world over HTTPS.

account_key_p

text the value of one of the access keys for the storage account. Your Azure blob storage access keys are similar to a root password for your storage account. Always be careful to protect your access keys. Use Azure Key Vault to manage and rotate your keys securely. The account key is stored in a table that only the superuser can access. Users granted the azure_storage_admin role can interact with this table through functions. To see which storage accounts are added, use the function azure_storage.account_list.

account_config

jsonb the name of the Azure Storage account and all the required settings like authentication type, account type, or storage credentials. Use the utility functions azure_storage.account_options_managed_identity, azure_storage.account_options_credentials, or azure_storage.account_options to create any of the valid values that you must pass as this argument.

Return type

VOID

azure_storage.account_encrypt_existing_credentials

Function that scans a list of existing storage accounts that you added by using azure_storage.account_add in older versions of the extension. Those versions store unencrypted credentials. This function encrypts all credentials by using the key stored in azure_storage.credential_encryption_key. The value of azure_storage.credential_encryption_key is scoped at the server level. Therefore, if you create the Azure Storage extension in multiple databases in the same server, the same encryption key encrypts all sensitive credentials stored by the extension, regardless of the database in which they are stored.

Important

If you create the Azure Storage extension in multiple databases of the same server, you must execute the azure_storage.account_encrypt_existing_credentials function in each of those databases.

azure_storage.account_encrypt_existing_credentials();

Permissions

Must be a member of azure_storage_admin.

Arguments

This function doesn't take any arguments.

Return type

bigint The number of existing storage account credentials that were unencrypted before executing the function and are now encrypted by using the key stored in azure_storage.credential_encryption_key.

azure_storage.account_options_managed_identity

Function that acts as a utility function. Call it as a parameter within azure_storage.account_add. It helps you create a valid value for the account_config argument when you use a system assigned managed identity to interact with the Azure Storage account.

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

Permissions

Any user or role can invoke this function.

Arguments

name

type

azure_storage.storage_type the value of one of the types of storage supported. Supported value is blob.

Return type

jsonb

azure_storage.account_options_credentials

Utility function that you can call as a parameter within azure_storage.account_add. It helps you create a valid value for the account_config argument when you use an Azure Storage access key to interact with the Azure Storage account.

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

Permissions

Any user or role can invoke this function.

Arguments

name

credentials

type

azure_storage.storage_type the value of one of the types of storage supported. Supported value is blob.

Return type

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

Any user or role can invoke this function.

Arguments

name

auth_type

azure_storage.auth_type the value of one of the types of storage supported. Supported values are access-key and managed-identity.

storage_type

azure_storage.storage_type the value of one of the types of storage supported. Supported value is blob.

credentials

Return type

jsonb

azure_storage.account_remove

Function that removes a storage account and its associated access key from the list of storage accounts that the azure_storage extension can access.

azure_storage.account_remove(account_name_p text);

Permissions

Must be a member of azure_storage_admin.

Arguments

account_name_p

Return type

VOID

azure_storage.account_user_add

Function that grants a PostgreSQL user or role access to a storage account through the functions provided by the azure_storage extension.

Note

The execution of this function only succeeds if the storage account, whose name you pass as the first argument, was already created by using azure_storage.account_add, and if the user or role, whose name you pass as the second argument, already exists.

azure_storage.account_add(account_name_p text, user_p regrole);

Permissions

Must be a member of azure_storage_admin.

Arguments

account_name_p

user_p

regrole the name of a PostgreSQL user or role available on the server.

Return type

VOID

azure_storage.account_user_remove

Function that revokes a PostgreSQL user or role access to a storage account through the functions provided by the azure_storage extension.

Note

The execution of this function only succeeds if the storage account whose name you pass as the first argument already exists and was created by using azure_storage.account_add. The user or role whose name you pass as the second argument must also exist. When you drop a user or role from the server by executing DROP USER | ROLE, the permissions that were granted on any reference to Azure Storage accounts are also automatically removed.

azure_storage.account_user_remove(account_name_p text, user_p regrole);

Permissions

Must be a member of azure_storage_admin.

Arguments

account_name_p

user_p

regrole the name of a PostgreSQL user or role available on the server.

Return type

VOID

azure_storage.account_list

Function that lists the names of the storage accounts that you configured through the azure_storage.account_add function, along with the PostgreSQL users or roles that have permissions to interact with that storage account through the functions provided by the azure_storage extension.

azure_storage.account_list();

Permissions

Must be a member of azure_storage_admin.

Arguments

This function doesn't take any arguments.

Return type

TABLE(account_name text, auth_type azure_storage.auth_type, azure_storage_type azure_storage.storage_type, allowed_users regrole[]) a four-column table with the list of Azure Storage accounts added, the type of authentication used to interact with each account, the type of storage, and the list of PostgreSQL users or roles that have access to it.

azure_storage.blob_list

Function that lists the names and other properties (size, lastModified, eTag, contentType, contentEncoding, and contentHash) of blobs stored in the given container of the referred storage account.

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

Permissions

Add the user or role that invokes this function to the allow list for the account_name by executing azure_storage.account_user_add. Members of azure_storage_admin are automatically allowed to reference all Azure Storage accounts whose references were added by using azure_storage.account_add.

Arguments

account_name

container_name

text the name of a container. A container organizes a set of blobs, similar to a directory in a file system. A storage account can include an unlimited number of containers, and a container can store an unlimited number of blobs. A container name must be a valid Domain Name System (DNS) name, as it forms part of the unique URI used to address the container or its blobs. When naming a container, follow these rules.

The URI for a container is similar to: https://myaccount.blob.core.windows.net/mycontainer

prefix

text when specified, the function returns the blobs whose names begin with the value provided in this parameter. Defaults to an empty string.

Return type

TABLE(path text, bytes bigint, last_modified timestamp with time zone, etag text, content_type text, content_encoding text, content_hash text) a table with one record per blob returned, including the full name of the blob, and some other properties.

path

text the full name of the blob.

bytes

bigint the size of blob in bytes.

last_modified

timestamp with time zone the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

etag

text the ETag property is used for optimistic concurrency during updates. It isn't a timestamp as there's another property called Timestamp that stores the last time a record was updated. For example, if you load an entity and want to update it, the ETag must match what is currently stored. Setting the appropriate ETag is important because if you have multiple users editing the same item, you don't want them overwriting each other's changes.

content_type

text the content type specified for the blob. The default content type is application/octet-stream.

content_encoding

text the Content-Encoding property of a blob that Azure Storage allows you to define. For compressed content, you could set the property to be Gzip. When the browser accesses the content, it automatically decompresses the content.

content_hash

text the hash used to verify the integrity of the blob during transport. When you specify this header, the storage service checks the provided hash against one it computes from the content. If the two hashes don't match, the operation fails and returns error code 400 (Bad Request).

azure_storage.blob_get

Function that imports data by downloading a file from a blob container in an Azure Storage account. It translates the contents into rows, which you can consume and process by using SQL language constructs. This function adds support to filter and manipulate the data fetched from the blob container before importing it.

Note

Before trying to access the container for the referred storage account, this function checks if the names of the storage account and container that you pass as arguments are valid according to the naming validation rules imposed on Azure storage accounts. If either name is invalid, the function returns an error.

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

An overloaded version of this function accepts a rec parameter that you can use to conveniently define the output format record.

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

container_name

The URI for a container is similar to: https://myaccount.blob.core.windows.net/mycontainer

path

text the full name of the blob.

rec

anyelement the definition of the record output structure.

decoder

text the specification of the blob format. Set to any of the following values:

Format	Default	Description
`auto`	`true`	Infers the value based on the last series of characters assigned to the name of the blob. If the blob name ends with `.parquet`, it assumes `parquet`. If ends with `.csv` or `.csv.gz`, it assumes `csv`. If ends with `.tsv` or `.tsv.gz`, it assumes `tsv`. If ends with `.json`, `.json.gz`, `.xml`, `.xml.gz`, `.txt`, or `.txt.gz`, it assumes `text`.
`binary`		Binary PostgreSQL COPY format.
`csv`		Comma-separated values format used by PostgreSQL COPY.
`parquet`		Parquet format.
`text` \| `xml` \| `json`		A file containing a single text value.
`tsv`		Tab-separated values, the default PostgreSQL COPY format.

compression

text the specification of compression type. Set to any of the following values:

Format	Default	Description
`auto`	`true`	Infers the value based on the last series of characters assigned to the name of the blob. If the blob name ends with `.gz`, it assumes `gzip`. Otherwise, it assumes `none`.
`brotli`		Uses the brotli compression algorithm to compress the blob. Only supported by `parquet` encoder.
`gzip`		Forces using gzip compression algorithm to compress the blob.
`lz4`		Uses the lz4 compression algorithm to compress the blob. The `parquet` encoder is the only encoder that supports this algorithm.
`none`		Doesn't compress the blob.
`snappy`		Uses the snappy compression algorithm to compress the blob. The `parquet` encoder is the only encoder that supports this algorithm.
`zstd`		Uses the zstd compression algorithm to compress the blob. The `parquet` encoder is the only encoder that supports this algorithm.

The extension doesn't support any other compression types.

options

jsonb the settings that define handling of custom headers, custom separators, escape characters, and other options. options affects the behavior of this function in a way similar to how the options you can pass to the COPY command in PostgreSQL affect its behavior.

Return type

SETOF record SETOF anyelement

azure_storage.blob_put

Function that exports data by uploading files to a blob container in an Azure Storage account. The function creates the file content from rows in PostgreSQL.

Note

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

An overloaded version of the function includes the encoder parameter. Use this parameter to specify the encoder when it can't be inferred from the extension of the path parameter, or when you want to override the inferred encoder.

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

An overloaded version of the function includes the compression parameter. Use this parameter to specify the compression when it can't be inferred from the extension of the path parameter, or when you want to override the inferred compression.

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

An overloaded version of the function includes the options parameter for handling custom headers, custom separators, escape characters, and other options. The options parameter works in a similar fashion to the options that you can pass to the COPY command in 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

container_name

The URI for a container is similar to: https://myaccount.blob.core.windows.net/mycontainer

path

text the full name of the blob.

tuple

record the definition of the record output structure.

encoder

text the specification of the blob format. Set to any of the following values:

Format	Default	Description
`auto`	`true`	Infers the value based on the last series of characters assigned to the name of the blob. If the blob name ends with `.csv` or `.csv.gz`, it assumes `csv`. If it ends with `.tsv` or `.tsv.gz`, it assumes `tsv`. If it ends with `.json`, `.json.gz`, `.xml`, `.xml.gz`, `.txt`, or `.txt.gz`, it assumes `text`.
`binary`		Binary PostgreSQL COPY format.
`csv`		Comma-separated values format used by PostgreSQL COPY.
`parquet`		Parquet format.
`text` \| `xml` \| `json`		A file containing a single text value.
`tsv`		Tab-separated values, the default PostgreSQL COPY format.

compression

text the specification of compression type. Set to any of the following values:

Format	Default	Description
`auto`	`true`	Infers the value based on the last series of characters assigned to the name of the blob. If the blob name ends with `.gz`, it assumes `gzip`. Otherwise, it assumes `none`.
`brotli`		Uses the brotli compression algorithm to compress the blob. Only supported by `parquet` encoder.
`gzip`		Forces using gzip compression algorithm to compress the blob.
`lz4`		Uses the lz4 compression algorithm to compress the blob. The `parquet` encoder is the only encoder that supports this algorithm.
`none`		Doesn't compress the blob.
`snappy`		Uses the snappy compression algorithm to compress the blob. The `parquet` encoder is the only encoder that supports this algorithm.
`zstd`		Uses the zstd compression algorithm to compress the blob. The `parquet` encoder is the only encoder that supports this algorithm.

The extension doesn't support any other compression types.

options

Return type

VOID

azure_storage.options_copy

Utility function that you can call as a parameter within blob_get. It acts as a helper function for options_parquet, options_csv_get, options_tsv, and 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

Any user or role can invoke this function.

Arguments

delimiter

text The character that separates columns within each row (line) of the file. It must be a single 1-byte character. Although this function supports delimiters of any number of characters, if you try to use more than a single 1-byte character, PostgreSQL returns a COPY delimiter must be a single one-byte character error.

null_string

text The string that represents a null value. The default is \N (backslash-N) in text format, and an unquoted empty string in CSV format. You might prefer an empty string even in text format for cases where you don't want to distinguish nulls from empty strings.

boolean Flag that indicates if the file contains a header line with the names of each column in the file. On output, the initial line contains the column names from the table.

quote

text The quoting character to use when a data value is quoted. The default is double-quote. It must be a single 1-byte character. Although this function supports delimiters of any number of characters, if you try to use more than a single 1-byte character, PostgreSQL returns a COPY quote must be a single one-byte character error.

escape

text The character that should appear before a data character that matches the QUOTE value. The default is the same as the QUOTE value (so that the quoting character is doubled if it appears in the data). It must be a single 1-byte character. Although this function supports delimiters of any number of characters, if you try to use more than a single 1-byte character, PostgreSQL returns a COPY escape must be a single one-byte character error.

force_quote

text[] forces quoting to be used for all non-NULL values in each specified column. NULL output is never quoted. If * is specified, non-NULL values are quoted in all columns.

force_not_null

text[] Don't match the specified columns' values against the null string. In the default case where the null string is empty, it means that empty values are read as zero-length strings rather than nulls, even when they aren't quoted.

force_null

text[] Match the specified columns' values against the null string, even if quoted. If a match is found, set the value to NULL. In the default case where the null string is empty, it converts a quoted empty string into NULL.

content_encoding

text Name of the encoding with which the file is encoded. If you omit this option, the current client encoding is used.

Return type

jsonb

azure_storage.options_parquet

Utility function for decoding the content of a Parquet file. Use it as a parameter in blob_get.

azure_storage.options_parquet();

Permissions

Any user or role can invoke this function.

Arguments

Return type

jsonb

azure_storage.options_csv_get

Utility function for decoding the content of a CSV file. Call this function as a parameter within 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

Any user or role can invoke this function.

Arguments

delimiter

null_string

header

boolean Flag that indicates if the file contains a header line with the names of each column in the file. On output, the initial line contains the column names from the table.

quote

escape

force_not_null

force_null

content_encoding

text Name of the encoding with which the file is encoded. If you omit this option, the current client encoding is used.

Return type

jsonb

azure_storage.options_tsv

Utility function for decoding the content of a TSV file. Call this function as a parameter within blob_get.

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

Permissions

Any user or role can invoke this function.

Arguments

delimiter

null_string

content_encoding

text Name of the encoding with which the file is encoded. If you omit this option, the current client encoding is used.

Return type

jsonb

azure_storage.options_binary

Utility function that you can call as a parameter within blob_get. It helps decode the content of a binary file.

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

Permissions

Any user or role can invoke this function.

Arguments

content_encoding

text Name of the encoding with which the file is encoded. If you omit this option, the current client encoding is used.

Return type

jsonb

Povratne informacije

Je li ova stranica bila od pomoći?

Last updated on 2026-07-13