Referens för funktioner som tillhandahålls av Azure Storage-tillägget i Azure Database for PostgreSQL flexibel server

I följande lista visas de funktioner som tillhandahålls av Azure Storage-tillägget:

azure_storage.account_add

Funktion som lägger till ett lagringskonto och dess associerade åtkomstnyckel i listan över lagringskonton som azure_storage tillägget kan komma åt.

Om en tidigare anrop av den här funktionen redan har lagt till referensen till det här lagringskontot, lägger den inte till en ny post utan uppdaterar i stället åtkomstnyckeln för den befintliga posten.

Anmärkning

Den här funktionen verifierar inte om det refererade kontonamnet finns eller om det är tillgängligt med den angivna åtkomstnyckeln. Den verifierar dock att namnet på lagringskontot är giltigt, enligt de namngivningsverifieringsregler som införts för Azure-lagringskonton.

azure_storage.account_add(account_name_p text, account_key_p text);

En överbelastad version av den här funktionen accepterar en account_config parameter som kapslar in namnet på det refererade Azure Storage-kontot och alla nödvändiga inställningar som autentiseringstyp, kontotyp eller lagringsuppgifter.

azure_storage.account_add(account_config jsonb);

Permissions

Måste vara medlem i azure_storage_admin.

Arguments

account_name_p

text namnet på Azure Blob Storage-kontot som innehåller alla dina objekt: blobar, filer, köer och tabeller. Lagringskontot tillhandahåller ett unikt namnområde som du kan komma åt var som helst i världen via HTTPS.

account_key_p

text värdet för en av åtkomstnycklarna för lagringskontot. Åtkomstnycklarna för Azure Blob Storage liknar ett rotlösenord för ditt lagringskonto. Var alltid noga med att skydda dina åtkomstnycklar. Använd Azure Key Vault för att hantera och rotera dina nycklar på ett säkert sätt. Kontonyckeln lagras i en tabell som endast superanvändaren kan komma åt. Användare som beviljats azure_storage_admin rollen kan interagera med den här tabellen via funktioner. Om du vill se vilka lagringskonton som läggs till använder du funktionen azure_storage.account_list.

account_config

jsonb Namnet på Azure Storage-kontot och alla nödvändiga inställningar som autentiseringstyp, kontotyp eller autentiseringsuppgifter för lagring. Använd verktygsfunktionerna azure_storage.account_options_managed_identity, azure_storage.account_options_credentials eller azure_storage.account_options för att skapa något av de giltiga värden som du måste skicka som det här argumentet.

Returtyp

VOID

azure_storage.account_encrypt_existing_credentials

Funktion som söker igenom en lista över befintliga lagringskonton som du har lagt till med hjälp av azure_storage.account_add i äldre versioner av tillägget. Dessa versioner lagrar okrypterade autentiseringsuppgifter. Den här funktionen krypterar alla autentiseringsuppgifter med hjälp av nyckeln som lagras i azure_storage.credential_encryption_key. Värdet azure_storage.credential_encryption_key för är begränsat till servernivå. Om du skapar Azure Storage-tillägget i flera databaser på samma server krypterar därför samma krypteringsnyckel alla känsliga autentiseringsuppgifter som lagras av tillägget, oavsett i vilken databas de lagras.

Viktigt!

Om du skapar Azure Storage-tillägget i flera databaser på samma server måste du köra azure_storage.account_encrypt_existing_credentials funktionen i var och en av dessa databaser.

azure_storage.account_encrypt_existing_credentials();

Permissions

Måste vara medlem i azure_storage_admin.

Arguments

Den här funktionen tar inga argument.

Returtyp

bigint Antalet befintliga autentiseringsuppgifter för lagringskontot som var okrypterade innan funktionen kördes och som nu krypteras med hjälp av nyckeln som lagras i azure_storage.credential_encryption_key.

azure_storage.account_options_managed_identity

Funktion som fungerar som en verktygsfunktion. Anropa den som en parameter i azure_storage.account_add. Det hjälper dig att skapa ett giltigt värde för account_config argumentet när du använder en systemtilldelad hanterad identitet för att interagera med Azure Storage-kontot.

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

Permissions

Alla användare eller roller kan anropa den här funktionen.

Arguments

name

type

azure_storage.storage_type värdet för en av de typer av lagring som stöds. Värdet som stöds är blob.

Returtyp

jsonb

azure_storage.account_options_credentials

Verktygsfunktion som du kan anropa som en parameter i azure_storage.account_add. Det hjälper dig att skapa ett giltigt värde för account_config argumentet när du använder en Azure Storage åtkomstnyckel för att interagera med Azure Storage-kontot.

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

Permissions

Alla användare eller roller kan anropa den här funktionen.

Arguments

name

credentials

type

azure_storage.storage_type värdet för en av de typer av lagring som stöds. Värdet som stöds är blob.

Returtyp

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

Alla användare eller roller kan anropa den här funktionen.

Arguments

name

auth_type

azure_storage.auth_type värdet för en av de typer av lagring som stöds. Värden som stöds är access-key och managed-identity.

storage_type

azure_storage.storage_type värdet för en av de typer av lagring som stöds. Värdet som stöds är blob.

credentials

text värdet för en av åtkomstnycklarna för lagringskontot. Åtkomstnycklarna för Azure Blob Storage liknar ett rotlösenord för ditt lagringskonto. Var alltid noga med att skydda dina åtkomstnycklar. Använd Azure Key Vault för att hantera och rotera dina nycklar på ett säkert sätt. Kontonyckeln lagras i en tabell som bara superanvändaren kan komma åt. Användare som beviljats azure_storage_admin rollen kan interagera med den här tabellen via funktioner. Om du vill se vilka lagringskonton som läggs till använder du funktionen azure_storage.account_list.

Returtyp

jsonb

azure_storage.account_remove

Funktion som tar bort ett lagringskonto och dess associerade åtkomstnyckel från listan över lagringskonton som azure_storage tillägget kan komma åt.

azure_storage.account_remove(account_name_p text);

Permissions

Måste vara medlem i azure_storage_admin.

Arguments

account_name_p

Returtyp

VOID

azure_storage.account_user_add

Funktion som ger en PostgreSQL-användare eller roll åtkomst till ett lagringskonto via de funktioner som tillhandahålls av azure_storage tillägget.

Anmärkning

Körningen av den här funktionen lyckas bara om lagringskontot, vars namn du skickar som det första argumentet, redan har skapats med hjälp av azure_storage.account_add, och om användaren eller rollen, vars namn du skickar som det andra argumentet, redan finns.

azure_storage.account_add(account_name_p text, user_p regrole);

Permissions

Måste vara medlem i azure_storage_admin.

Arguments

account_name_p

user_p

regrole namnet på en PostgreSQL-användare eller roll som är tillgänglig på servern.

Returtyp

VOID

azure_storage.account_user_remove

Funktion som återkallar en PostgreSQL-användare eller rollåtkomst till ett lagringskonto via de funktioner som tillhandahålls av azure_storage tillägget.

Anmärkning

Körningen av den här funktionen lyckas bara om det lagringskonto vars namn du skickar som det första argumentet redan finns och skapades med hjälp av azure_storage.account_add. Den användare eller roll vars namn du skickar som det andra argumentet måste också finnas. När du släpper en användare eller roll från servern genom att DROP USER | ROLEköra tas även de behörigheter som har beviljats för en referens till Azure Storage konton bort automatiskt.

azure_storage.account_user_remove(account_name_p text, user_p regrole);

Permissions

Måste vara medlem i azure_storage_admin.

Arguments

account_name_p

user_p

regrole namnet på en PostgreSQL-användare eller roll som är tillgänglig på servern.

Returtyp

VOID

azure_storage.account_list

Funktion som visar namnen på de lagringskonton som du konfigurerade via funktionen azure_storage.account_add , tillsammans med PostgreSQL-användare eller roller som har behörighet att interagera med lagringskontot via funktionerna i azure_storage tillägget.

azure_storage.account_list();

Permissions

Måste vara medlem i azure_storage_admin.

Arguments

Den här funktionen tar inga argument.

Returtyp

TABLE(account_name text, auth_type azure_storage.auth_type, azure_storage_type azure_storage.storage_type, allowed_users regrole[])en tabell med fyra kolumner med listan över Azure Storage konton som lagts till, vilken typ av autentisering som används för att interagera med varje konto, typen av lagring och listan över PostgreSQL-användare eller roller som har åtkomst till det.

azure_storage.blob_list

Funktion som visar namn och andra egenskaper (storlek, lastModified, eTag, contentType, contentEncoding och contentHash) för blobar som lagras i den angivna containern för det refererade lagringskontot.

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

Permissions

Lägg till den användare eller roll som anropar den här funktionen i listan över tillåtna account_name för genom att köra azure_storage.account_user_add. Medlemmar i azure_storage_admin får automatiskt referera till alla Azure Storage konton vars referenser har lagts till med hjälp av azure_storage.account_add.

Arguments

account_name

container_name

text namnet på en container. En container organiserar en uppsättning blobar, ungefär som en katalog i ett filsystem. Ett lagringskonto kan innehålla ett obegränsat antal containrar och en container kan lagra ett obegränsat antal blobar. Ett containernamn måste vara ett giltigt DNS-namn (Domain Name System), eftersom det utgör en del av den unika URI som används för att adressera containern eller dess blobar. När du namnger en container följer du dessa regler.

URI:n för en container liknar: https://myaccount.blob.core.windows.net/mycontainer

prefix

text när den anges returnerar funktionen de blobbar vars namn börjar med värdet som anges i den här parametern. Standardvärdet är en tom sträng.

Returtyp

TABLE(path text, bytes bigint, last_modified timestamp with time zone, etag text, content_type text, content_encoding text, content_hash text) en tabell med en post per blob returnerad, inklusive blobens fullständiga namn och några andra egenskaper.

path

text blobens fullständiga namn.

bytes

bigint storleken på bloben i byte.

last_modified

timestamp with time zone datum och tid då bloben senast ändrades. Alla åtgärder som ändrar bloben, inklusive en uppdatering av blobens metadata eller egenskaper, ändrar blobens senast ändrade tid.

etag

text ETag-egenskapen används för optimistisk samtidighet under uppdateringar. Det är inte en tidsstämpel eftersom det finns en annan egenskap som heter Tidsstämpel som lagrar den senaste gången en post uppdaterades. Om du till exempel läser in en entitet och vill uppdatera den måste ETag matcha det som för närvarande lagras. Det är viktigt att ange lämplig ETag eftersom du inte vill att flera användare ska skriva över varandras ändringar om du har flera användare som redigerar samma objekt.

content_type

text den innehållstyp som angetts för bloben. Standardinnehållstypen är application/octet-stream.

content_encoding

text egenskapen Content-Encoding för en blob som du kan definiera i Azure Storage. För komprimerat innehåll kan du ange egenskapen till Gzip. När webbläsaren kommer åt innehållet dekomprimerar den automatiskt innehållet.

content_hash

text den hash som används för att verifiera blobens integritet under transporten. När du anger det här huvudet kontrollerar lagringstjänsten den angivna hashen mot en som den beräknar från innehållet. Om de två hashvärdena inte matchar misslyckas åtgärden och returnerar felkoden 400 (felaktig begäran).

azure_storage.blob_get

Funktion som importerar data genom att ladda ned en fil från en blobcontainer i ett Azure Storage konto. Det översätter innehållet till rader som du kan använda och bearbeta med hjälp av SQL-språkkonstruktioner. Den här funktionen lägger till stöd för att filtrera och ändra data som hämtas från blobcontainern innan du importerar dem.

Anmärkning

Innan du försöker komma åt containern för det refererade lagringskontot kontrollerar den här funktionen om namnen på lagringskontot och containern som du skickar som argument är giltiga enligt de namngivningsverifieringsregler som införts för Azure lagringskonton. Om något av namnen är ogiltigt returnerar funktionen ett fel.

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

En överbelastad version av den här funktionen accepterar en rec parameter som du kan använda för att enkelt definiera utdataformatposten.

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

URI:n för en container liknar: https://myaccount.blob.core.windows.net/mycontainer

path

text blobens fullständiga namn.

Rec

anyelement definitionen av postutdatastrukturen.

avkodare

text specifikationen för blobformatet. Ange något av följande värden:

Format	Standardinställning	Beskrivning
`auto`	`true`	Härleder värdet baserat på den sista serien med tecken som tilldelats namnet på bloben. Om blobnamnet slutar med `.parquet`förutsätter `parquet`det . Om slutar med `.csv` eller `.csv.gz`förutsätter `csv`det . Om slutar med `.tsv` eller `.tsv.gz`förutsätter `tsv`det . Om slutar med `.json`, `.json.gz`, `.xml`, `.xml.gz`, `.txt`eller `.txt.gz`, förutsätter `text`det .
`binary`		Binärt PostgreSQL COPY-format.
`csv`		Format för kommaavgränsade värden som används av PostgreSQL COPY.
`parquet`		Parquet-format.
`text` \| `xml` \| `json`		En fil som innehåller ett enda textvärde.
`tsv`		Tabbavgränsade värden, standardformatet PostgreSQL COPY.

compression

text specifikationen av komprimeringstyp. Ange något av följande värden:

Format	Standardinställning	Beskrivning
`auto`	`true`	Härleder värdet baserat på den sista serien med tecken som tilldelats namnet på bloben. Om blobnamnet slutar med `.gz`förutsätter `gzip`det . I annat fall förutsätter `none`det .
`brotli`		Använder algoritmen för brotlikomprimering för att komprimera bloben. Stöds endast av `parquet` kodaren.
`gzip`		Tvingar med hjälp av gzip-komprimeringsalgoritmen för att komprimera bloben.
`lz4`		Använder lz4-komprimeringsalgoritmen för att komprimera bloben. Kodaren `parquet` är den enda kodaren som stöder den här algoritmen.
`none`		Komprimerar inte bloben.
`snappy`		Använder den snabba komprimeringsalgoritmen för att komprimera bloben. Kodaren `parquet` är den enda kodaren som stöder den här algoritmen.
`zstd`		Använder zstd-komprimeringsalgoritmen för att komprimera bloben. Kodaren `parquet` är den enda kodaren som stöder den här algoritmen.

Tillägget stöder inte andra komprimeringstyper.

options

jsonb inställningarna som definierar hanteringen av anpassade rubriker, anpassade avgränsare, escape-tecken och andra alternativ. options påverkar funktionens beteende på ett sätt som liknar hur de alternativ som du kan skicka till COPY kommandot i PostgreSQL påverkar dess beteende.

Returtyp

SETOF record SETOF anyelement

azure_storage.blob_put

Funktion som exporterar data genom att ladda upp filer till en blobcontainer i ett Azure Storage konto. Funktionen skapar filinnehållet från rader i PostgreSQL.

Anmärkning

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

En överbelastad version av funktionen innehåller parametern encoder . Använd den här parametern för att ange kodaren när den inte kan härledas från parameterns tillägg path eller när du vill åsidosätta den härledda kodaren.

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

En överbelastad version av funktionen innehåller parametern compression . Använd den här parametern för att ange komprimering när den inte kan härledas från parameterns tillägg path eller när du vill åsidosätta den härledda komprimering.

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

En överlagrad version av funktionen innehåller parametern options för hantering av anpassade huvuden, anpassade avgränsare, escape-tecken och andra alternativ. Parametern options fungerar på ett liknande sätt som de alternativ som du kan skicka till COPY kommandot i 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

URI:n för en container liknar: https://myaccount.blob.core.windows.net/mycontainer

path

text blobens fullständiga namn.

tupel

record definitionen av postutdatastrukturen.

Kodare

text specifikationen för blobformatet. Ange något av följande värden:

Format	Standardinställning	Beskrivning
`auto`	`true`	Härleder värdet baserat på den sista serien med tecken som tilldelats namnet på bloben. Om blobnamnet slutar med `.csv` eller `.csv.gz`förutsätter `csv`det . Om den slutar med `.tsv` eller `.tsv.gz`förutsätter `tsv`den . Om den slutar med `.json`, `.json.gz`, `.xml`, `.xml.gz`, `.txt`eller `.txt.gz`, förutsätter `text`den .
`binary`		Binärt PostgreSQL COPY-format.
`csv`		Format för kommaavgränsade värden som används av PostgreSQL COPY.
`parquet`		Parquet-format.
`text` \| `xml` \| `json`		En fil som innehåller ett enda textvärde.
`tsv`		Tabbavgränsade värden, standardformatet PostgreSQL COPY.

compression

text specifikationen av komprimeringstyp. Ange något av följande värden:

Format	Standardinställning	Beskrivning
`auto`	`true`	Härleder värdet baserat på den sista serien med tecken som tilldelats namnet på bloben. Om blobnamnet slutar med `.gz`förutsätter `gzip`det . I annat fall förutsätter `none`det .
`brotli`		Använder algoritmen för brotlikomprimering för att komprimera bloben. Stöds endast av `parquet` kodaren.
`gzip`		Tvingar med hjälp av gzip-komprimeringsalgoritmen för att komprimera bloben.
`lz4`		Använder lz4-komprimeringsalgoritmen för att komprimera bloben. Kodaren `parquet` är den enda kodaren som stöder den här algoritmen.
`none`		Komprimerar inte bloben.
`snappy`		Använder den snabba komprimeringsalgoritmen för att komprimera bloben. Kodaren `parquet` är den enda kodaren som stöder den här algoritmen.
`zstd`		Använder zstd-komprimeringsalgoritmen för att komprimera bloben. Kodaren `parquet` är den enda kodaren som stöder den här algoritmen.

Tillägget stöder inte andra komprimeringstyper.

options

Returtyp

VOID

azure_storage.options_copy

Verktygsfunktion som du kan anropa som en parameter i blob_get. Den fungerar som en hjälpfunktion för options_parquet, options_csv_get, options_tsv och 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

Alla användare eller roller kan anropa den här funktionen.

Arguments

avgränsare

text Tecknet som separerar kolumner inom varje rad (rad) i filen. Det måste vara ett enda 1 byte-tecken. Även om den här funktionen stöder avgränsare av valfritt antal tecken, returnerar PostgreSQL ett COPY delimiter must be a single one-byte character fel om du försöker använda mer än ett enda 1 byte-tecken.

null_string

text Strängen som representerar ett null-värde. Standardvärdet är \N (backslash-N) i textformat och en ociterad tom sträng i CSV-format. Du kanske föredrar en tom sträng även i textformat för fall där du inte vill skilja null-värden från tomma strängar.

boolean Flagga som anger om filen innehåller en rubrikrad med namnen på varje kolumn i filen. Vid utdata innehåller den första raden kolumnnamnen från tabellen.

offert

text Det citattecken som ska användas när ett datavärde citeras. Standardvärdet är dubbelcitat. Det måste vara ett enda 1 byte-tecken. Även om den här funktionen stöder avgränsare av valfritt antal tecken, returnerar PostgreSQL ett COPY quote must be a single one-byte character fel om du försöker använda mer än ett enda 1 byte-tecken.

ESC

text Det tecken som ska visas före ett datatecken som matchar CITAT-värdet. Standardvärdet är detsamma som OFFERT-värdet (så att citattecknet fördubblas om det visas i data). Det måste vara ett enda 1 byte-tecken. Även om den här funktionen stöder avgränsare av valfritt antal tecken, returnerar PostgreSQL ett COPY escape must be a single one-byte character fel om du försöker använda mer än ett enda 1 byte-tecken.

force_quote

text[] tvingar citat att användas för alla icke-NULL-värden i varje angiven kolumn. NULL-utdata citeras aldrig. Om * anges anges icke-NULL-värden i alla kolumner.

force_not_null

text[] Matcha inte de angivna kolumnernas värden mot nullsträngen. I standardfallet där nullsträngen är tom innebär det att tomma värden läse som nolllängdssträngar i stället för null, även om de inte citeras.

force_null

text[] Matcha de angivna kolumnernas värden mot null-strängen, även om de anges. Om en matchning hittas anger du värdet null. I standardfallet där null-strängen är tom konverteras en citerad tom sträng till NULL.

content_encoding

text Namnet på kodningen som filen är kodad med. Om du utelämnar det här alternativet används den aktuella klientkodningen.

Returtyp

jsonb

azure_storage.options_parquet

Verktygsfunktion för avkodning av innehållet i en Parquet-fil. Använd den som en parameter i blob_get.

azure_storage.options_parquet();

Permissions

Alla användare eller roller kan anropa den här funktionen.

Arguments

Returtyp

jsonb

azure_storage.options_csv_get

Verktygsfunktion för avkodning av innehållet i en CSV-fil. Anropa den här funktionen som en parameter i 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

Alla användare eller roller kan anropa den här funktionen.

Arguments

avgränsare

null_string

rubrik

boolean Flagga som anger om filen innehåller en rubrikrad med namnen på varje kolumn i filen. Vid utdata innehåller den första raden kolumnnamnen från tabellen.

offert

ESC

force_not_null

force_null

content_encoding

text Namnet på kodningen som filen är kodad med. Om du utelämnar det här alternativet används den aktuella klientkodningen.

Returtyp

jsonb

azure_storage.options_tsv

Verktygsfunktion för avkodning av innehållet i en TSV-fil. Anropa den här funktionen som en parameter i blob_get.

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

Permissions

Alla användare eller roller kan anropa den här funktionen.

Arguments

avgränsare

null_string

content_encoding

text Namnet på kodningen som filen är kodad med. Om du utelämnar det här alternativet används den aktuella klientkodningen.

Returtyp

jsonb

azure_storage.options_binary

Verktygsfunktion som du kan anropa som en parameter i blob_get. Det hjälper till att avkoda innehållet i en binär fil.

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

Permissions

Alla användare eller roller kan anropa den här funktionen.

Arguments

content_encoding

text Namnet på kodningen som filen är kodad med. Om du utelämnar det här alternativet används den aktuella klientkodningen.

Returtyp

jsonb

Feedback

Var den här sidan till hjälp?

Uppdaterades senast 2026-07-14