Справочник по функциям, предоставляемым расширением служба хранилища Azure на гибком сервере База данных Azure для PostgreSQL

В следующем списке показаны функции, предоставляемые расширением служба хранилища Azure:

azure_storage.account_add

Функция, которая добавляет учетную запись хранения и связанный с ним ключ доступа к списку учетных записей хранения, к которым azure_storage может получить доступ расширение.

Если предыдущее вызов этой функции уже добавило ссылку на эту учетную запись хранения, она не добавляет новую запись, а вместо этого обновляет ключ доступа существующей записи.

Замечание

Эта функция не проверяет, существует ли имя учетной записи или доступно ли оно с помощью ключа доступа. Однако он проверяет, является ли имя учетной записи хранения допустимым в соответствии с правилами проверки именования, введенными для учетных записей хранения Azure.

azure_storage.account_add(account_name_p text, account_key_p text);

Перегруженная версия этой функции принимает account_config параметр, инкапсулирующий имя указанной служба хранилища Azure учетной записи, а также все необходимые параметры, такие как тип проверки подлинности, тип учетной записи или учетные данные хранения.

azure_storage.account_add(account_config jsonb);

Permissions

Должен быть членом azure_storage_admin.

Arguments

account_name_p

text Имя учетной записи хранения BLOB-объектов Azure, содержащей все объекты: большие двоичные объекты, файлы, очереди и таблицы. Учетная запись хранения предоставляет уникальное пространство имен, доступ к которому можно получить из любой точки мира по протоколу HTTPS.

account_key_p

text значение одного из ключей доступа для учетной записи хранения. Ключи доступа к хранилищу BLOB-объектов Azure похожи на корневой пароль для учетной записи хранения. Не забудьте защитить ключи доступа. Для безопасного управления и ротации ключей воспользуйтесь Azure Key Vault. Ключ учетной записи хранится в таблице, к которому может получить доступ только суперпользователь. Пользователи, которым предоставлена роль, могут взаимодействовать с этой таблицей azure_storage_admin с помощью функций. Чтобы узнать, какие учетные записи хранения добавляются, используйте функцию azure_storage.account_list.

account_config

jsonb имя учетной записи хранения Azure и все необходимые параметры, такие как тип проверки подлинности, тип учетной записи или учетные данные хранения. Используйте функции служебной программы azure_storage.account_options_managed_identity, azure_storage.account_options_credentials или azure_storage.account_options , чтобы создать любое из допустимых значений, которые необходимо передать в качестве этого аргумента.

Тип возвращаемого значения

VOID

azure_storage.account_encrypt_existing_credentials

Функция, которая сканирует список существующих учетных записей хранения, добавленных с помощью azure_storage.account_add в более ранних версиях расширения. Эти версии хранят незашифрованные учетные данные. Эта функция шифрует все учетные данные с помощью ключа, хранящегося в azure_storage.credential_encryption_key. Значение azure_storage.credential_encryption_key области на уровне сервера. Поэтому при создании расширения служба хранилища Azure в нескольких базах данных на одном сервере один и тот же ключ шифрования шифрует все конфиденциальные учетные данные, хранящиеся расширением, независимо от базы данных, в которой они хранятся.

Это важно

Если вы создаете расширение служба хранилища Azure в нескольких базах данных одного сервера, необходимо выполнить функцию azure_storage.account_encrypt_existing_credentials в каждой из этих баз данных.

azure_storage.account_encrypt_existing_credentials();

Permissions

Должен быть членом azure_storage_admin.

Arguments

Эта функция не принимает никаких аргументов.

Тип возвращаемого значения

bigint Число существующих учетных данных учетной записи хранения, которые были незашифрованы перед выполнением функции и теперь шифруются с помощью ключа, хранящегося в azure_storage.credential_encryption_key.

azure_storage.account_options_managed_identity

Функция, которая выступает в качестве служебной функции. Вызовите его как параметр в azure_storage.account_add. Он помогает создать допустимое значение аргумента account_config при использовании управляемого удостоверения, назначаемого системой, для взаимодействия с учетной записью служба хранилища Azure.

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

Permissions

Любой пользователь или роль могут вызывать эту функцию.

Arguments

имя

type

azure_storage.storage_type значение одного из поддерживаемых типов хранилища. Поддерживаемое значение — blob.

Тип возвращаемого значения

jsonb

azure_storage.account_options_credentials

Служебная функция, которую можно вызвать в качестве параметра в azure_storage.account_add. Это помогает создать допустимое значение аргумента account_config при использовании ключа доступа служба хранилища Azure для взаимодействия с учетной записью служба хранилища Azure.

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

Permissions

Любой пользователь или роль могут вызывать эту функцию.

Arguments

имя

credentials

type

azure_storage.storage_type значение одного из поддерживаемых типов хранилища. Поддерживаемое значение — blob.

Тип возвращаемого значения

jsonb

azure_storage.account_options

Служебная функция, которую можно вызвать в качестве параметра в azure_storage.account_add. Это помогает создать допустимое значение аргумента account_config при использовании ключа доступа служба хранилища Azure или управляемого удостоверения, назначаемого системой, для взаимодействия с учетной записью служба хранилища Azure.

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

Permissions

Любой пользователь или роль могут вызывать эту функцию.

Arguments

имя

auth_type

azure_storage.auth_type значение одного из поддерживаемых типов хранилища. Поддерживаемые значения: access-key и managed-identity.

storage_type

azure_storage.storage_type значение одного из поддерживаемых типов хранилища. Поддерживаемое значение — blob.

credentials

Тип возвращаемого значения

jsonb

azure_storage.account_remove

Функция, которая удаляет учетную запись хранения и связанный с ним ключ доступа из списка учетных записей хранения, к которым azure_storage может получить доступ расширение.

azure_storage.account_remove(account_name_p text);

Permissions

Должен быть членом azure_storage_admin.

Arguments

account_name_p

Тип возвращаемого значения

VOID

azure_storage.account_user_add

Функция, которая предоставляет пользователю Или роли PostgreSQL доступ к учетной записи хранения через функции, предоставляемые расширением azure_storage .

Замечание

Выполнение этой функции выполняется только в том случае, если учетная запись хранения, имя которой вы передаете в качестве первого аргумента, уже создана с помощью azure_storage.account_add, и если пользователь или роль, имя которого передается в качестве второго аргумента, уже существует.

azure_storage.account_add(account_name_p text, user_p regrole);

Permissions

Должен быть членом azure_storage_admin.

Arguments

account_name_p

user_p

regrole имя пользователя Или роли PostgreSQL, доступной на сервере.

Тип возвращаемого значения

VOID

azure_storage.account_user_remove

Функция, которая отменяет доступ пользователя Или роли PostgreSQL к учетной записи хранения через функции, предоставляемые расширением azure_storage .

Замечание

Выполнение этой функции выполняется только в том случае, если учетная запись хранения, имя которой вы передаете в качестве первого аргумента, уже существует и создано с помощью azure_storage.account_add. Пользователь или роль, имя которой вы передаете в качестве второго аргумента, также должно существовать. При удалении пользователя или роли с сервера путем выполнения DROP USER | ROLEразрешения, предоставленные для любой ссылки на служба хранилища Azure учетных записей, также удаляются автоматически.

azure_storage.account_user_remove(account_name_p text, user_p regrole);

Permissions

Должен быть членом azure_storage_admin.

Arguments

account_name_p

user_p

regrole имя пользователя Или роли PostgreSQL, доступной на сервере.

Тип возвращаемого значения

VOID

azure_storage.account_list

Функция, которая содержит имена учетных записей хранения, настроенных с помощью функции azure_storage.account_add , а также пользователей Или ролей PostgreSQL, имеющих разрешения на взаимодействие с этой учетной записью хранения через функции, предоставляемые azure_storage расширением.

azure_storage.account_list();

Permissions

Должен быть членом azure_storage_admin.

Arguments

Эта функция не принимает никаких аргументов.

Тип возвращаемого значения

TABLE(account_name text, auth_type azure_storage.auth_type, azure_storage_type azure_storage.storage_type, allowed_users regrole[])таблица с четырьмя столбцами со списком добавленных учетных записей служба хранилища Azure, тип проверки подлинности, используемый для взаимодействия с каждой учетной записью, типом хранилища и списком пользователей Или ролей PostgreSQL, имеющих к нему доступ.

azure_storage.blob_list

Функция, которая перечисляет имена и другие свойства (размер, lastModified, eTag, contentType, contentEncoding и contentHash) больших двоичных объектов, хранящихся в указанном контейнере указанной учетной записи хранения.

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

Permissions

Добавьте пользователя или роль, которая вызывает эту функцию в список разрешений, account_name выполнив azure_storage.account_user_add. azure_storage_admin Участники автоматически могут ссылаться на все служба хранилища Azure учетные записи, ссылки на которые были добавлены с помощью azure_storage.account_add.

Arguments

account_name

имя_контейнера

text имя контейнера. Контейнер организует набор блобов, аналогично каталогу в файловой системе. Учетная запись хранения может включать неограниченное количество контейнеров, а контейнер может содержать неограниченное количество блобов. Имя контейнера должно быть допустимым именем системы доменных имен (DNS), так как оно входит в уникальный универсальный код ресурса (URI), используемый для адресов контейнера или больших двоичных объектов. При именовании контейнера следуйте этим правилам.

Универсальный код ресурса (URI) для контейнера аналогичен: https://myaccount.blob.core.windows.net/mycontainer

prefix

text При указании функция возвращает большие двоичные объекты, имена которых начинаются со значения, указанного в этом параметре. По умолчанию используется пустая строка.

Тип возвращаемого значения

TABLE(path text, bytes bigint, last_modified timestamp with time zone, etag text, content_type text, content_encoding text, content_hash text) Таблица с одной записью для каждого возвращаемого большого двоичного объекта, включая полное имя большого двоичного объекта и некоторые другие свойства.

путь

text полное имя большого двоичного объекта.

байт

bigint размер большого двоичного объекта в байтах.

last_modified

timestamp with time zone дата и время последнего изменения большого двоичного объекта. Любая операция, которая изменяет большой двоичный объект, включая обновление метаданных или свойств большого двоичного объекта, изменяет время последнего изменения большого двоичного объекта.

ETag

text Свойство ETag используется для оптимистического параллелизма во время обновлений. Это не метка времени, так как есть другое свойство с именем Timestamp, которое сохраняет последний раз, когда запись была обновлена. Например, если вы загружаете сущность и хотите обновить ее, ETag должна соответствовать тому, что сейчас хранится. Настройка соответствующего ETag важна, так как если у вас несколько пользователей редактировали один и тот же элемент, вы не хотите, чтобы они перезаписывали изменения друг друга.

content_type

text Тип контента, указанный для большого двоичного объекта. Тип контента по умолчанию — application/octet-stream.

content_encoding

text Свойство Content-Encoding большого двоичного объекта, который позволяет определить хранилище Azure. Для сжатого содержимого можно задать для свойства Gzip. Когда браузер обращается к содержимому, он автоматически распаковывает содержимое.

content_hash

text Хэш, используемый для проверки целостности большого двоичного объекта во время транспорта. При указании этого заголовка служба хранилища проверяет предоставленный хэш на один из них, который вычисляется из содержимого. Если два хэша не соответствуют, операция завершается ошибкой и возвращает код ошибки 400 (недопустимый запрос).

azure_storage.blob_get

Функция, которая импортирует данные, скачивая файл из контейнера BLOB-объектов в учетной записи служба хранилища Azure. Он преобразует содержимое в строки, которые можно использовать и обрабатывать с помощью конструкций языка SQL. Эта функция добавляет поддержку фильтрации и управления данными, полученными из контейнера BLOB-объектов перед импортом.

Замечание

Прежде чем пытаться получить доступ к контейнеру для указанной учетной записи хранения, эта функция проверяет, действительны ли имена учетной записи хранения и контейнера в качестве аргументов в соответствии с правилами проверки именования, введенными для учетных записей хранения Azure. Если любое имя недопустимо, функция возвращает ошибку.

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

Перегруженная версия этой функции принимает rec параметр, который можно использовать для удобного определения записи выходного формата.

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

имя_контейнера

Универсальный код ресурса (URI) для контейнера аналогичен: https://myaccount.blob.core.windows.net/mycontainer

путь

text полное имя большого двоичного объекта.

rec

anyelement определение выходной структуры записи.

дешифратор

text спецификация формата большого двоичного объекта. Задайте для любого из следующих значений:

Формат	По умолчанию	Описание
`auto`	`true`	Выводит значение на основе последней серии символов, назначенных имени большого двоичного объекта. Если имя большого двоичного объекта заканчивается `.parquet`, предполагается `parquet`. Если заканчивается или `.csv.csv.gz`предполагается `csv`. Если заканчивается или `.tsv.tsv.gz`предполагается `tsv`. Если заканчивается , `.json.json.gz.xml.xml.gz.txt`или `.txt.gz`, предполагается.`text`
`binary`		Двоичный формат PostgreSQL COPY.
`csv`		Формат разделенных запятыми значений, используемый PostgreSQL COPY.
`parquet`		Формат Parquet.
`text` \| `xml` \| `json`		Файл, содержащий одно текстовое значение.
`tsv`		Значения, разделенные табуляции, формат копирования PostgreSQL по умолчанию.

compression

text спецификация типа сжатия. Задайте для любого из следующих значений:

Формат	По умолчанию	Описание
`auto`	`true`	Выводит значение на основе последней серии символов, назначенных имени большого двоичного объекта. Если имя большого двоичного объекта заканчивается `.gz`, предполагается `gzip`. В противном случае предполагается `none`.
`brotli`		Использует алгоритм сжатия brotli для сжатия большого двоичного объекта. Поддерживается только кодировщиком `parquet` .
`gzip`		Принудительно использует алгоритм сжатия gzip для сжатия большого двоичного объекта.
`lz4`		Использует алгоритм сжатия lz4 для сжатия большого двоичного объекта. Кодировщик `parquet` является единственным кодировщиком, поддерживающим этот алгоритм.
`none`		Не сжимает большой двоичный объект.
`snappy`		Использует алгоритм сжатия snappy для сжатия большого двоичного объекта. Кодировщик `parquet` является единственным кодировщиком, поддерживающим этот алгоритм.
`zstd`		Использует алгоритм сжатия zstd для сжатия большого двоичного объекта. Кодировщик `parquet` является единственным кодировщиком, поддерживающим этот алгоритм.

Расширение не поддерживает другие типы сжатия.

options

jsonb Параметры, определяющие обработку пользовательских заголовков, настраиваемых разделителей, escape-символов и других параметров. options влияет на поведение этой функции таким образом, как параметры, которые можно передать команде COPY в PostgreSQL, влияют на его поведение.

Тип возвращаемого значения

SETOF record SETOF anyelement

azure_storage.blob_put

Функция, которая экспортирует данные путем отправки файлов в контейнер BLOB-объектов в учетной записи служба хранилища Azure. Функция создает содержимое файла из строк в PostgreSQL.

Замечание

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

Перегруженная версия функции включает encoder параметр. Используйте этот параметр, чтобы указать кодировщик, если его невозможно вывести из расширения параметра, или при переопределении выводимого path кодировщика.

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

Перегруженная версия функции включает compression параметр. Используйте этот параметр, чтобы указать сжатие, если оно не может быть выведено из расширения path параметра, или если требуется переопределить выводимый сжатие.

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

Перегруженная версия функции включает options параметр для обработки пользовательских заголовков, пользовательских разделителей, escape-символов и других параметров. Этот options параметр работает аналогично параметрам, которые можно передать команде COPY в 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

имя_контейнера

Универсальный код ресурса (URI) для контейнера аналогичен: https://myaccount.blob.core.windows.net/mycontainer

путь

text полное имя большого двоичного объекта.

кортеж

record определение выходной структуры записи.

кодировщик

text спецификация формата большого двоичного объекта. Задайте для любого из следующих значений:

Формат	По умолчанию	Описание
`auto`	`true`	Выводит значение на основе последней серии символов, назначенных имени большого двоичного объекта. Если имя большого двоичного объекта заканчивается `.csv` или `.csv.gz`предполагается `csv`. Если он заканчивается `.tsv` или `.tsv.gz`предполагается `tsv`. Если он заканчивается , `.json.json.gz`, `.xml`, `.xml.gz.txt`или `.txt.gz`, предполагается`text`.
`binary`		Двоичный формат PostgreSQL COPY.
`csv`		Формат разделенных запятыми значений, используемый PostgreSQL COPY.
`parquet`		Формат Parquet.
`text` \| `xml` \| `json`		Файл, содержащий одно текстовое значение.
`tsv`		Значения, разделенные табуляции, формат копирования PostgreSQL по умолчанию.

compression

text спецификация типа сжатия. Задайте для любого из следующих значений:

Формат	По умолчанию	Описание
`auto`	`true`	Выводит значение на основе последней серии символов, назначенных имени большого двоичного объекта. Если имя большого двоичного объекта заканчивается `.gz`, предполагается `gzip`. В противном случае предполагается `none`.
`brotli`		Использует алгоритм сжатия brotli для сжатия большого двоичного объекта. Поддерживается только кодировщиком `parquet` .
`gzip`		Принудительно использует алгоритм сжатия gzip для сжатия большого двоичного объекта.
`lz4`		Использует алгоритм сжатия lz4 для сжатия большого двоичного объекта. Кодировщик `parquet` является единственным кодировщиком, поддерживающим этот алгоритм.
`none`		Не сжимает большой двоичный объект.
`snappy`		Использует алгоритм сжатия snappy для сжатия большого двоичного объекта. Кодировщик `parquet` является единственным кодировщиком, поддерживающим этот алгоритм.
`zstd`		Использует алгоритм сжатия zstd для сжатия большого двоичного объекта. Кодировщик `parquet` является единственным кодировщиком, поддерживающим этот алгоритм.

Расширение не поддерживает другие типы сжатия.

options

Тип возвращаемого значения

VOID

azure_storage.options_copy

Служебная функция, которую можно вызвать как параметр внутри blob_get. Он выступает в качестве вспомогательной функции для options_parquet, options_csv_get, options_tsv и 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

Любой пользователь или роль могут вызывать эту функцию.

Arguments

разделитель

text Символ, разделяющий столбцы в каждой строке (строке) файла. Это должен быть один 1-байтовый символ. Хотя эта функция поддерживает разделители любого количества символов, если вы пытаетесь использовать более одного байтового символа, PostgreSQL возвращает ошибку COPY delimiter must be a single one-byte character .

null_string

text Строка, представляющая значение NULL. Значение по умолчанию — \N (backslash-N) в текстовом формате и неквалированная пустая строка в формате CSV. Вы можете предпочесть пустую строку даже в текстовом формате, если вы не хотите различать значения NULL от пустых строк.

boolean Флаг, указывающий, содержит ли файл строку заголовка с именами каждого столбца в файле. В выходных данных начальная строка содержит имена столбцов из таблицы.

quote

text Символ кавычек, используемый при кавычках значения данных. По умолчанию используется двойная кавычка. Это должен быть один 1-байтовый символ. Хотя эта функция поддерживает разделители любого количества символов, если вы пытаетесь использовать более одного байтового символа, PostgreSQL возвращает ошибку COPY quote must be a single one-byte character .

побег

text Символ, который должен отображаться перед символом данных, соответствующим значению QUOTE. Значение по умолчанию совпадает со значением QUOTE (чтобы символ кавычки был двойным, если он отображается в данных). Это должен быть один 1-байтовый символ. Хотя эта функция поддерживает разделители любого количества символов, если вы пытаетесь использовать более одного байтового символа, PostgreSQL возвращает ошибку COPY escape must be a single one-byte character .

force_quote

text[] принудительно используется для всех значений, отличных от NULL, в каждом указанном столбце. Выходные данные NULL никогда не цитируются. Если задано значение *, значения, отличные от NULL, указываются во всех столбцах.

force_not_null

text[] Не сопоставляйте значения указанных столбцов со строкой NULL. В случае, если строка NULL пуста, это означает, что пустые значения считываются как строки нулевой длины, а не null, даже если они не кавычки.

force_null

text[] Сопоставлять значения указанных столбцов со строкой NULL, даже если они указаны. Если совпадение найдено, задайте значение NULL. В случае, если строка NULL пуста, она преобразует в кавычки пустую строку в NULL.

content_encoding

text Имя кодировки, с которой кодируется файл. Если этот параметр не указан, используется текущая кодировка клиента.

Тип возвращаемого значения

jsonb

azure_storage.options_parquet

Функция служебной программы для декодирования содержимого файла Parquet. Используйте его в качестве параметра в blob_get.

azure_storage.options_parquet();

Permissions

Любой пользователь или роль могут вызывать эту функцию.

Arguments

Тип возвращаемого значения

jsonb

azure_storage.options_csv_get

Функция служебной программы для декодирования содержимого CSV-файла. Вызовите эту функцию в качестве параметра внутри 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

Любой пользователь или роль могут вызывать эту функцию.

Arguments

разделитель

null_string

header

quote

побег

force_not_null

force_null

content_encoding

Тип возвращаемого значения

jsonb

azure_storage.options_tsv

Служебная функция для декодирования содержимого файла TSV. Вызовите эту функцию в качестве параметра внутри blob_get.

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

Permissions

Любой пользователь или роль могут вызывать эту функцию.

Arguments

разделитель

null_string

content_encoding

Тип возвращаемого значения

jsonb

azure_storage.options_binary

Служебная функция, которую можно вызвать как параметр внутри blob_get. Он помогает декодировать содержимое двоичного файла.

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

Permissions

Любой пользователь или роль могут вызывать эту функцию.

Arguments

content_encoding

Тип возвращаемого значения

jsonb

Обратная связь

Были ли сведения на этой странице полезными?

Последнее обновление: 2026-07-10