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

A continuación se muestra la lista de funciones proporcionadas por la extensión de Azure Storage:

azure_storage.account_add

Función que permite agregar 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);

Hay una versión sobrecargada de esta función, que 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);

Permisos

Debe ser miembro de azure_storage_admin.

Argumentos

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 se 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. Se recomienda usar 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 se deben pasar como este argumento.

Tipo de retorno

VOID

azure_storage.account_options_managed_identity

Función que actúa como una función de utilidad, a la que se puede llamar como parámetro dentro de azure_storage.account_add y resulta útil para generar un valor válido para el argumento, cuando se usa una identidad administrada asignada por el account_config sistema para interactuar con la cuenta de Azure Storage.

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

Permisos

Cualquier usuario o rol puede invocar esta función.

Argumentos

nombre

tipo

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

Tipo de retorno

jsonb

azure_storage.account_options_credentials

Función que actúa como una función de utilidad, que se puede llamar como parámetro dentro de azure_storage.account_add, y resulta útil para generar un valor válido para el account_config argumento, cuando se usa una clave de acceso de Azure Storage para interactuar con la cuenta de Azure Storage.

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

Permisos

Cualquier usuario o rol puede invocar esta función.

Argumentos

nombre

credenciales

tipo

azure_storage.storage_type valor de uno de los tipos de almacenamiento admitidos. Solo 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);

Permisos

Cualquier usuario o rol puede invocar esta función.

Argumentos

nombre

auth_type

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

storage_type

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

credenciales

Tipo de retorno

jsonb

azure_storage.account_remove

Función que permite quitar 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);

Permisos

Debe ser miembro de azure_storage_admin.

Argumentos

account_name_p

Tipo de retorno

VOID

azure_storage.account_user_add

Función que permite conceder 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ó con azure_storage.account_add y, si el usuario o rol, cuyo nombre se pasa como segundo argumento, ya existe.

azure_storage.account_add(account_name_p text, user_p regrole);

Permisos

Debe ser miembro de azure_storage_admin.

Argumentos

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 permite revocar un acceso de 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 se pasa como primer argumento ya se ha creado con azure_storage.account_add y si el usuario o rol cuyo nombre se pasa como segundo argumento todavía existe. Cuando se quita un usuario o rol del servidor, al ejecutar DROP USER | ROLE, también se eliminan automáticamente los permisos concedidos en cualquier referencia a cuentas de Azure Storage.

azure_storage.account_user_remove(account_name_p text, user_p regrole);

Permisos

Debe ser miembro de azure_storage_admin.

Argumentos

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 configuradas a través de la función azure_storage.account_add , junto con los usuarios o roles de PostgreSQL a los que se conceden 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();

Permisos

Debe ser miembro de azure_storage_admin.

Argumentos

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 a los que se le concede acceso.

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

Permisos

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

Argumentos

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, asegúrese de seguir estas reglas.

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

prefijo

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 zonefecha 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. Cuando se especifica este encabezado, el servicio de almacenamiento comprueba el hash proporcionado con un calculado a partir del contenido. Si los dos hash no coinciden, se produce un error en la operación con el código de error 400 (solicitud incorrecta).

azure_storage.blob_get

Función que permite importar datos. Descarga un archivo de un contenedor de blobs en una cuenta de Azure Storage. A continuación, traduce el contenido en filas, que se pueden consumir y procesar con 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 pasados como argumentos son válidos según las reglas de validación de nomenclatura impuestas en las cuentas de almacenamiento de Azure. Si alguno de ellos no es válido, se genera 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);

Hay una versión sobrecargada de esta función, que acepta un rec parámetro que permite 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);

Permisos

Argumentos

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. Se puede establecer 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.

compresión

text la especificación del tipo de compresión. Se puede establecer 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`		Fuerza el uso del 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`		Fuerza el uso del algoritmo de compresión lz4 para comprimir el blob. Solo es compatible con `parquet` el codificador.
`none`		Fuerza a no comprimir el blob.
`snappy`		Fuerza el uso del algoritmo de compresión snappy para comprimir el blob. Solo es compatible con `parquet` el codificador.
`zstd`		Fuerza el uso del algoritmo de compresión zstd para comprimir el blob. Solo es compatible con `parquet` el codificador.

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

opciones

jsonb la configuración que define el control de encabezados personalizados, separadores personalizados, caracteres de escape, etc. 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 permite exportar datos mediante la carga de archivos en un contenedor de blobs en una cuenta de Azure Storage. El contenido de los archivos se genera a partir de filas de PostgreSQL.

Nota:

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

Hay una versión sobrecargada de la función, que contiene encoder el parámetro que permite especificar el codificador que se va a usar cuando no se puede deducir de la extensión del path parámetro, o cuando se quiere invalidar el que se deduce.

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

Hay una versión sobrecargada de función que también contiene un compression parámetro que permite especificar la compresión que se va a usar cuando no se puede deducir de la extensión del path parámetro, o cuando se quiere invalidar la que se deduce.

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

Hay una versión sobrecargada de la función que también contiene un options parámetro para controlar encabezados personalizados, separadores personalizados, caracteres de escape, etc. options funciona de forma similar a las opciones que se pueden 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;

Permisos

Argumentos

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. Se puede establecer 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.

compresión

text la especificación del tipo de compresión. Se puede establecer 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`		Fuerza el uso del 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`		Fuerza el uso del algoritmo de compresión lz4 para comprimir el blob. Solo es compatible con `parquet` el codificador.
`none`		Fuerza a no comprimir el blob.
`snappy`		Fuerza el uso del algoritmo de compresión snappy para comprimir el blob. Solo es compatible con `parquet` el codificador.
`zstd`		Fuerza el uso del algoritmo de compresión zstd para comprimir el blob. Solo es compatible con `parquet` el codificador.

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

opciones

Tipo de retorno

VOID

azure_storage.options_copy

Función que actúa como una función de utilidad, a la que se 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);

Permisos

Cualquier usuario o rol puede invocar esta función.

Argumentos

delimitador

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

comillas

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 notifica 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 notifica 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 coincidan 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 se cita y, 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 se omite la opción, se usa la codificación del cliente actual.

Tipo de retorno

jsonb

azure_storage.options_parquet

Función que actúa como una función de utilidad, que se puede llamar como parámetro dentro blob_getde y es útil para descodificar el contenido de un archivo parquet.

azure_storage.options_parquet();

Permisos

Cualquier usuario o rol puede invocar esta función.

Argumentos

Tipo de retorno

jsonb

azure_storage.options_csv_get

Función que actúa como una función de utilidad, que se puede llamar como parámetro dentro blob_getde y es útil para descodificar el contenido de un archivo 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);

Permisos

Cualquier usuario o rol puede invocar esta función.

Argumentos

delimitador

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.

comillas

escapar

force_not_null

force_null

content_encoding

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

Tipo de retorno

jsonb

azure_storage.options_tsv

Función que actúa como una función de utilidad, a la que se puede llamar como parámetro dentro blob_getde y es útil para descodificar el contenido de un archivo tsv.

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

Permisos

Cualquier usuario o rol puede invocar esta función.

Argumentos

delimitador

null_string

content_encoding

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

Tipo de retorno

jsonb

azure_storage.options_binary

Función que actúa como una función de utilidad, que se puede llamar como parámetro dentro blob_getde y es útil para descodificar el contenido de un archivo binario.

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

Permisos

Cualquier usuario o rol puede invocar esta función.

Argumentos

content_encoding

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

Tipo de retorno

jsonb

Comentarios

¿Le resultó útil esta página?

Last updated on 2025-08-29

Compartir vía

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

azure_storage.account_add

Permisos

Argumentos

account_name_p

account_key_p

account_config

Tipo de retorno

azure_storage.account_options_managed_identity

Permisos

Argumentos

nombre

tipo

Tipo de retorno

azure_storage.account_options_credentials

Permisos

Argumentos

nombre

credenciales

tipo

Tipo de retorno

azure_storage.account_options

Permisos

Argumentos

nombre

auth_type

storage_type

credenciales

Tipo de retorno

azure_storage.account_remove

Permisos

Argumentos

account_name_p

Tipo de retorno

azure_storage.account_user_add

Permisos

Argumentos

account_name_p

user_p

Tipo de retorno

azure_storage.account_user_remove

Permisos

Argumentos

account_name_p

user_p

Tipo de retorno

azure_storage.account_list

Permisos

Argumentos

Tipo de retorno

azure_storage.blob_list

Permisos

Argumentos

account_name

nombre_del_contenedor

prefijo

Tipo de retorno

camino

Bytes

last_modified

ETag

content_type

content_encoding

content_hash

azure_storage.blob_get

Permisos

Argumentos

account_name

nombre_del_contenedor

camino

Rec

descodificador

compresión

opciones

Tipo de retorno

azure_storage.blob_put

Permisos

Argumentos

account_name