Referencia de funciones proporcionadas por la extensión Azure Storage en Azure Database for PostgreSQL servidor flexible

En la lista siguiente se muestran las funciones proporcionadas por la extensión Azure Storage:

azure_storage.account_add

Función que agrega una cuenta de almacenamiento y su clave de acceso asociada a la lista de cuentas de almacenamiento a las que puede acceder la azure_storage extensión.

Si una invocación anterior de esta función ya ha agregado la referencia a esta cuenta de almacenamiento, no agrega una nueva entrada, sino que actualiza la clave de acceso de la entrada existente.

Nota:

Esta función no valida si el nombre de cuenta al que se hace referencia existe o si es accesible con la clave de acceso proporcionada. Sin embargo, valida que el nombre de la cuenta de almacenamiento es válido, según las reglas de validación de nomenclatura impuestas en las cuentas de almacenamiento de Azure.

azure_storage.account_add(account_name_p text, account_key_p text);

Una versión sobrecargada de esta función acepta un account_config parámetro que encapsula el nombre de la cuenta de Azure Storage a la que se hace referencia y todos los valores necesarios, como el tipo de autenticación, el tipo de cuenta o las credenciales de almacenamiento.

azure_storage.account_add(account_config jsonb);

Permissions

Debe ser miembro de azure_storage_admin.

Arguments

account_name_p

text el nombre de la cuenta de Azure Blob Storage que contiene todos los objetos: blobs, archivos, colas y tablas. La cuenta de almacenamiento proporciona un espacio de nombres único al que puede acceder desde cualquier lugar del mundo a través de HTTPS.

account_key_p

text el valor de una de las claves de acceso de la cuenta de almacenamiento. Las claves de acceso de Azure Blob Storage son similares a una contraseña raíz para la cuenta de almacenamiento. Siempre debe tener cuidado de proteger las claves de acceso. Use Azure Key Vault para administrar y rotar las claves de forma segura. La clave de cuenta se almacena en una tabla a la que solo puede acceder el superusuario. Los usuarios concedidos al azure_storage_admin rol pueden interactuar con esta tabla a través de funciones. Para ver qué cuentas de almacenamiento se agregan, use la función azure_storage.account_list.

account_config

jsonb el nombre de la cuenta de Azure Storage y todos los valores necesarios, como el tipo de autenticación, el tipo de cuenta o las credenciales de almacenamiento. Use las funciones de utilidad azure_storage.account_options_managed_identity, azure_storage.account_options_credentials o azure_storage.account_options para crear cualquiera de los valores válidos que debe pasar como este argumento.

Tipo de retorno

VOID

azure_storage.account_encrypt_existing_credentials

Función que examina una lista de las cuentas de almacenamiento existentes que agregó mediante azure_storage.account_add en versiones anteriores de la extensión. Esas versiones almacenan credenciales sin cifrar. Esta función cifra todas las credenciales mediante la clave almacenada en azure_storage.credential_encryption_key. El valor de azure_storage.credential_encryption_key está en el ámbito en el nivel de servidor. Por lo tanto, si crea la extensión Azure Storage en varias bases de datos del mismo servidor, la misma clave de cifrado cifra todas las credenciales confidenciales almacenadas por la extensión, independientemente de la base de datos en la que se almacenen.

Importante

Si crea la extensión Azure Storage en varias bases de datos del mismo servidor, debe ejecutar la azure_storage.account_encrypt_existing_credentials función en cada una de esas bases de datos.

azure_storage.account_encrypt_existing_credentials();

Permissions

Debe ser miembro de azure_storage_admin.

Arguments

Esta función no toma ningún argumento.

Tipo de retorno

bigint Número de credenciales de cuenta de almacenamiento existentes sin cifrar antes de ejecutar la función y ahora se cifran mediante la clave almacenada en azure_storage.credential_encryption_key.

azure_storage.account_options_managed_identity

Función que actúa como una función de utilidad. Llámalo como parámetro dentro de azure_storage.account_add. Le ayuda a crear un valor válido para el account_config argumento cuando se usa una identidad administrada asignada por el sistema para interactuar con la cuenta de Azure Storage.

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

Permissions

Cualquier usuario o rol puede invocar esta función.

Arguments

nombre

type

azure_storage.storage_type valor de uno de los tipos de almacenamiento admitidos. El valor admitido es blob.

Tipo de retorno

jsonb

azure_storage.account_options_credentials

Función de utilidad que puede llamar como parámetro dentro de azure_storage.account_add. Ayuda a crear un valor válido para el account_config argumento cuando se usa una clave de acceso Azure Storage para interactuar con la cuenta de Azure Storage.

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

Permissions

Cualquier usuario o rol puede invocar esta función.

Arguments

nombre

credentials

type

azure_storage.storage_type valor de uno de los tipos de almacenamiento admitidos. El valor admitido es 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

Cualquier usuario o rol puede invocar esta función.

Arguments

nombre

auth_type

azure_storage.auth_type valor de uno de los tipos de almacenamiento admitidos. Los valores admitidos son access-key y managed-identity.

storage_type

azure_storage.storage_type valor de uno de los tipos de almacenamiento admitidos. El valor admitido es blob.

credentials

Tipo de retorno

jsonb

azure_storage.account_remove

Función que quita una cuenta de almacenamiento y su clave de acceso asociada de la lista de cuentas de almacenamiento a las que puede acceder la azure_storage extensión.

azure_storage.account_remove(account_name_p text);

Permissions

Debe ser miembro de azure_storage_admin.

Arguments

account_name_p

Tipo de retorno

VOID

azure_storage.account_user_add

Función que concede a un usuario o rol de PostgreSQL acceso a una cuenta de almacenamiento a través de las funciones proporcionadas por la azure_storage extensión.

Nota:

La ejecución de esta función solo se realiza correctamente si la cuenta de almacenamiento, cuyo nombre se pasa como primer argumento, ya se creó mediante azure_storage.account_add y si el usuario o rol, cuyo nombre pasa como segundo argumento, ya existe.

azure_storage.account_add(account_name_p text, user_p regrole);

Permissions

Debe ser miembro de azure_storage_admin.

Arguments

account_name_p

user_p

regrole el nombre de un usuario o rol de PostgreSQL disponible en el servidor.

Tipo de retorno

VOID

azure_storage.account_user_remove

Función que revoca el acceso de un usuario o rol de PostgreSQL a una cuenta de almacenamiento a través de las funciones proporcionadas por la azure_storage extensión.

Nota:

La ejecución de esta función solo se realiza correctamente si la cuenta de almacenamiento cuyo nombre pasa como primer argumento ya existe y se creó mediante azure_storage.account_add. El usuario o el rol cuyo nombre se pasa como segundo argumento también debe existir. Al quitar un usuario o rol del servidor ejecutando DROP USER | ROLE, los permisos concedidos en cualquier referencia a las cuentas de Azure Storage también se quitan automáticamente.

azure_storage.account_user_remove(account_name_p text, user_p regrole);

Permissions

Debe ser miembro de azure_storage_admin.

Arguments

account_name_p

user_p

regrole el nombre de un usuario o rol de PostgreSQL disponible en el servidor.

Tipo de retorno

VOID

azure_storage.account_list

Función que enumera los nombres de las cuentas de almacenamiento que configuró a través de la función azure_storage.account_add , junto con los usuarios o roles de PostgreSQL que tienen permisos para interactuar con esa cuenta de almacenamiento a través de las funciones proporcionadas por la azure_storage extensión.

azure_storage.account_list();

Permissions

Debe ser miembro de azure_storage_admin.

Arguments

Esta función no toma ningún argumento.

Tipo de retorno

TABLE(account_name text, auth_type azure_storage.auth_type, azure_storage_type azure_storage.storage_type, allowed_users regrole[])una tabla de cuatro columnas con la lista de cuentas de Azure Storage agregadas, el tipo de autenticación que se usa para interactuar con cada cuenta, el tipo de almacenamiento y la lista de usuarios o roles de PostgreSQL que tienen acceso a ella.

azure_storage.blob_list

Función que enumera los nombres y otras propiedades (size, lastModified, eTag, contentType, contentEncoding y contentHash) de blobs almacenados en el contenedor especificado de la cuenta de almacenamiento a la que se hace referencia.

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

Permissions

Agregue el usuario o rol que invoca esta función a la lista de permitidos para account_name mediante la ejecución de azure_storage.account_user_add. Los miembros de azure_storage_admin pueden hacer referencia automáticamente a todas las cuentas de Azure Storage cuyas referencias se agregaron mediante azure_storage.account_add.

Arguments

account_name

nombre_del_contenedor

text el nombre de un contenedor. Un contenedor organiza un conjunto de blobs, similar a un directorio de un sistema de archivos. Una cuenta de almacenamiento puede incluir un número ilimitado de contenedores y un contenedor puede almacenar un número ilimitado de blobs. Un nombre de contenedor debe ser un nombre válido del sistema de nombres de dominio (DNS), ya que forma parte del URI único que se usa para abordar el contenedor o sus blobs. Al asignar un nombre a un contenedor, siga estas reglas.

El URI de un contenedor es similar a: https://myaccount.blob.core.windows.net/mycontainer

prefix

text cuando se especifica, la función devuelve los blobs cuyos nombres comienzan por el valor proporcionado en este parámetro. El valor predeterminado es una cadena vacía.

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) una tabla con un registro por blob devuelto, incluido el nombre completo del blob y otras propiedades.

camino

text el nombre completo del blob.

bytes

bigint el tamaño del blob en bytes.

last_modified

timestamp with time zone fecha y hora en que se modificó por última vez el blob. Cualquier operación que modifique el blob, incluida una actualización de los metadatos o las propiedades del blob, cambia la hora de la última modificación del blob.

etag

text La propiedad ETag se usa para la simultaneidad optimista durante las actualizaciones. No es una marca de tiempo, ya que hay otra propiedad denominada Marca de tiempo que almacena la última vez que se actualizó un registro. Por ejemplo, si carga una entidad y quiere actualizarla, la ETag debe coincidir con lo que se almacena actualmente. Establecer la ETag adecuada es importante porque si tiene varios usuarios editando el mismo elemento, no quiere que sobrescriban los cambios entre sí.

content_type

text el tipo de contenido especificado para el blob. El tipo de contenido predeterminado es application/octet-stream.

content_encoding

text la propiedad Content-Encoding de un blob que Azure Storage permite definir. En el caso del contenido comprimido, podría establecer la propiedad como Gzip. Cuando el explorador accede al contenido, descomprime automáticamente el contenido.

content_hash

text hash usado para comprobar la integridad del blob durante el transporte. Al especificar este encabezado, el servicio de almacenamiento comprueba el hash proporcionado en uno que calcula desde el contenido. Si los dos hash no coinciden, se produce un error en la operación y se devuelve el código de error 400 (solicitud incorrecta).

azure_storage.blob_get

Función que importa datos descargando un archivo de un contenedor de blobs en una cuenta de Azure Storage. Convierte el contenido en filas, que puede consumir y procesar mediante construcciones de lenguaje SQL. Esta función agrega compatibilidad para filtrar y manipular los datos capturados desde el contenedor de blobs antes de importarlos.

Nota:

Antes de intentar acceder al contenedor de la cuenta de almacenamiento a la que se hace referencia, esta función comprueba si los nombres de la cuenta de almacenamiento y el contenedor que se pasan como argumentos son válidos según las reglas de validación de nomenclatura impuestas en Azure cuentas de almacenamiento. Si cualquiera de los nombres no es válido, la función devuelve un 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);

Una versión sobrecargada de esta función acepta un rec parámetro que puede usar para definir convenientemente el registro de formato de salida.

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

nombre_del_contenedor

El URI de un contenedor es similar a: https://myaccount.blob.core.windows.net/mycontainer

camino

text el nombre completo del blob.

Rec

anyelement la definición de la estructura de salida del registro.

descodificador

text la especificación del formato de blob. Establezca en cualquiera de los valores siguientes:

Formato	Predeterminado	Descripción
`auto`	`true`	Deduce el valor en función de la última serie de caracteres asignados al nombre del blob. Si el nombre del blob termina con `.parquet`, se supone `parquet`que . Si termina con `.csv` o `.csv.gz`, se supone `csv`que . Si termina con `.tsv` o `.tsv.gz`, se supone `tsv`que . Si termina con `.json`, `.json.gz`, `.xml`, `.xml.gz`, `.txt`o `.txt.gz`, asume `text`.
`binary`		Formato COPY de PostgreSQL binario.
`csv`		Formato de valores separados por comas usado por POSTGRESQL COPY.
`parquet`		Formato Parquet.
`text` \| `xml` \| `json`		Un archivo que contiene un valor de texto único.
`tsv`		Valores separados por tabulaciones, el formato COPY predeterminado de PostgreSQL.

compression

text la especificación del tipo de compresión. Establezca en cualquiera de los valores siguientes:

Formato	Predeterminado	Descripción
`auto`	`true`	Deduce el valor en función de la última serie de caracteres asignados al nombre del blob. Si el nombre del blob termina con `.gz`, se supone `gzip`que . De lo contrario, se supone `none`que .
`brotli`		Usa el algoritmo de compresión brotli para comprimir el blob. Solo es compatible con `parquet` el codificador.
`gzip`		Fuerza el uso del algoritmo de compresión gzip para comprimir el blob.
`lz4`		Usa el algoritmo de compresión lz4 para comprimir el blob. El `parquet` codificador es el único codificador que admite este algoritmo.
`none`		No comprime el blob.
`snappy`		Usa el algoritmo de compresión snappy para comprimir el blob. El `parquet` codificador es el único codificador que admite este algoritmo.
`zstd`		Usa el algoritmo de compresión zstd para comprimir el blob. El `parquet` codificador es el único codificador que admite este algoritmo.

La extensión no admite ningún otro tipo de compresión.

options

jsonb la configuración que define el control de encabezados personalizados, separadores personalizados, caracteres de escape y otras opciones. options afecta al comportamiento de esta función de forma similar a la forma en que las opciones que puede pasar al COPY comando en PostgreSQL afectan a su comportamiento.

Tipo de retorno

SETOF record SETOF anyelement

azure_storage.blob_put

Función que exporta datos mediante la carga de archivos en un contenedor de blobs en una cuenta de Azure Storage. La función crea el contenido del archivo a partir de filas de PostgreSQL.

Nota:

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

Una versión sobrecargada de la función incluye el encoder parámetro . Use este parámetro para especificar el codificador cuando no se pueda deducir de la extensión del path parámetro o cuando desee invalidar el codificador inferido.

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

Una versión sobrecargada de la función incluye el compression parámetro . Use este parámetro para especificar la compresión cuando no se pueda deducir de la extensión del path parámetro o cuando desee invalidar la compresión inferida.

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

Una versión sobrecargada de la función incluye el options parámetro para controlar encabezados personalizados, separadores personalizados, caracteres de escape y otras opciones. El options parámetro funciona de forma similar a las opciones que puede pasar al COPY comando en 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

nombre_del_contenedor

El URI de un contenedor es similar a: https://myaccount.blob.core.windows.net/mycontainer

camino

text el nombre completo del blob.

tupla

record la definición de la estructura de salida del registro.

codificador

text la especificación del formato de blob. Establezca en cualquiera de los valores siguientes:

Formato	Predeterminado	Descripción
`auto`	`true`	Deduce el valor en función de la última serie de caracteres asignados al nombre del blob. Si el nombre del blob termina con `.csv` o `.csv.gz`, se supone `csv`que . Si termina con `.tsv` o `.tsv.gz`, se supone `tsv`que . Si termina con `.json`, `.json.gz`, `.xml`, `.xml.gz`, `.txt`o `.txt.gz`, asume `text`.
`binary`		Formato COPY de PostgreSQL binario.
`csv`		Formato de valores separados por comas usado por POSTGRESQL COPY.
`parquet`		Formato Parquet.
`text` \| `xml` \| `json`		Un archivo que contiene un valor de texto único.
`tsv`		Valores separados por tabulaciones, el formato COPY predeterminado de PostgreSQL.

compression

text la especificación del tipo de compresión. Establezca en cualquiera de los valores siguientes:

Formato	Predeterminado	Descripción
`auto`	`true`	Deduce el valor en función de la última serie de caracteres asignados al nombre del blob. Si el nombre del blob termina con `.gz`, se supone `gzip`que . De lo contrario, se supone `none`que .
`brotli`		Usa el algoritmo de compresión brotli para comprimir el blob. Solo es compatible con `parquet` el codificador.
`gzip`		Fuerza el uso del algoritmo de compresión gzip para comprimir el blob.
`lz4`		Usa el algoritmo de compresión lz4 para comprimir el blob. El `parquet` codificador es el único codificador que admite este algoritmo.
`none`		No comprime el blob.
`snappy`		Usa el algoritmo de compresión snappy para comprimir el blob. El `parquet` codificador es el único codificador que admite este algoritmo.
`zstd`		Usa el algoritmo de compresión zstd para comprimir el blob. El `parquet` codificador es el único codificador que admite este algoritmo.

La extensión no admite ningún otro tipo de compresión.

options

Tipo de retorno

VOID

azure_storage.options_copy

Función de utilidad a la que puede llamar como parámetro dentro de blob_get. Actúa como una función auxiliar para options_parquet, options_csv_get, options_tsv y 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

Cualquier usuario o rol puede invocar esta función.

Arguments

delimiter

text Carácter que separa las columnas dentro de cada fila (línea) del archivo. Debe ser un solo carácter de 1 byte. Aunque esta función admite delimitadores de cualquier número de caracteres, si intenta usar más de un solo carácter de 1 byte, PostgreSQL devuelve un COPY delimiter must be a single one-byte character error.

null_string

text Cadena que representa un valor NULL. El valor predeterminado es \N (barra diagonal inversa-N) en formato de texto y una cadena vacía sin comillas en formato CSV. Es posible que prefiera una cadena vacía incluso en formato de texto para los casos en los que no desea distinguir valores NULL de cadenas vacías.

boolean Marca que indica si el archivo contiene una línea de encabezado con los nombres de cada columna del archivo. En la salida, la línea inicial contiene los nombres de columna de la tabla.

oferta

text Carácter de comillas que se va a usar cuando se cita un valor de datos. El valor predeterminado es comillas dobles. Debe ser un solo carácter de 1 byte. Aunque esta función admite delimitadores de cualquier número de caracteres, si intenta usar más de un solo carácter de 1 byte, PostgreSQL devuelve un COPY quote must be a single one-byte character error.

escapar

text Carácter que debe aparecer antes de un carácter de datos que coincida con el valor QUOTE. El valor predeterminado es el mismo que el valor QUOTE (de modo que el carácter de comillas se duplica si aparece en los datos). Debe ser un solo carácter de 1 byte. Aunque esta función admite delimitadores de cualquier número de caracteres, si intenta usar más de un solo carácter de 1 byte, PostgreSQL devuelve un COPY escape must be a single one-byte character error.

force_quote

text[] obliga a que se usen comillas para todos los valores que no sean NULL en cada columna especificada. La salida NULL nunca está entre comillas. Si se especifica *, los valores que no son NULL se citan en todas las columnas.

force_not_null

text[] No coincida con los valores de las columnas especificadas en la cadena null. En el caso predeterminado en el que la cadena null está vacía, significa que los valores vacíos se leen como cadenas de longitud cero en lugar de valores NULL, incluso cuando no están entre comillas.

force_null

text[] Coincide con los valores de las columnas especificadas con la cadena null, incluso si está entre comillas. Si se encuentra una coincidencia, establezca el valor en NULL. En el caso predeterminado en el que la cadena null está vacía, convierte una cadena vacía entre comillas en NULL.

content_encoding

text Nombre de la codificación con la que se codifica el archivo. Si omite esta opción, se usa la codificación del cliente actual.

Tipo de retorno

jsonb

azure_storage.options_parquet

Función de utilidad para descodificar el contenido de un archivo Parquet. Úselo como parámetro en blob_get.

azure_storage.options_parquet();

Permissions

Cualquier usuario o rol puede invocar esta función.

Arguments

Tipo de retorno

jsonb

azure_storage.options_csv_get

Función de utilidad para descodificar el contenido de un archivo CSV. Llame a esta función como parámetro dentro de 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

Cualquier usuario o rol puede invocar esta función.

Arguments

delimiter

null_string

encabezado

boolean Marca que indica si el archivo contiene una línea de encabezado con los nombres de cada columna del archivo. En la salida, la línea inicial contiene los nombres de columna de la tabla.

oferta

escapar

force_not_null

force_null

content_encoding

text Nombre de la codificación con la que se codifica el archivo. Si omite esta opción, se usa la codificación del cliente actual.

Tipo de retorno

jsonb

azure_storage.options_tsv

Función de utilidad para descodificar el contenido de un archivo TSV. Llame a esta función como parámetro dentro de blob_get.

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

Permissions

Cualquier usuario o rol puede invocar esta función.

Arguments

delimiter

null_string

content_encoding

text Nombre de la codificación con la que se codifica el archivo. Si omite esta opción, se usa la codificación del cliente actual.

Tipo de retorno

jsonb

azure_storage.options_binary

Función de utilidad a la que puede llamar como parámetro dentro de blob_get. Ayuda a descodificar el contenido de un archivo binario.

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

Permissions

Cualquier usuario o rol puede invocar esta función.

Arguments

content_encoding

text Nombre de la codificación con la que se codifica el archivo. Si omite esta opción, se usa la codificación del cliente actual.

Tipo de retorno

jsonb

Comentarios

¿Le ha resultado útil esta página?

Se actualizó por última vez el 2026-07-14