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

2025-07-08

Följande är listan över funktioner som tillhandahålls av Azure Storage-tillägget:

azure_storage.account_add

Funktion som gör det möjligt att lägga 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);

Det finns en överbelastad version av den här funktionen som 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 lagringsautentiseringsuppgifter.

azure_storage.account_add(account_config jsonb);

Behörigheter

Måste vara medlem i azure_storage_admin.

Argumentpunkter

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 är tillgängligt 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 är tillgänglig för superanvändaren. 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. Vi rekommenderar att du använder 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 måste skickas som det här argumentet.

Returtyp

VOID

azure_storage.account_options_managed_identity

Funktion som fungerar som en verktygsfunktion, som kan anropas som en parameter i azure_storage.account_add, och är användbar för 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);

Behörigheter

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

Argumentpunkter

namn

typ

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

Returtyp

jsonb

azure_storage.account_options_credentials

Funktion som fungerar som en verktygsfunktion, som kan anropas som en parameter i azure_storage.account_add, och är användbar för 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);

Behörigheter

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

Argumentpunkter

namn

Autentiseringsuppgifter

typ

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

Returtyp

jsonb

azure_storage.account_options

Funktion som fungerar som en verktygsfunktion, som kan anropas som en parameter i azure_storage.account_add, och är användbar för att skapa ett giltigt värde för account_config argumentet när du använder en Azure Storage-åtkomstnyckel eller en systemtilldelad hanterad identitet för att interagera med Azure Storage-kontot.

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

Behörigheter

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

Argumentpunkter

namn

auth_type

azure_storage.auth_type värdet för en av de typer av lagring som stöds. Endast 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. Endast värdet som stöds är blob.

Autentiseringsuppgifter

Returtyp

jsonb

azure_storage.account_remove

Funktion som gör det möjligt att ta 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);

Behörigheter

Måste vara medlem i azure_storage_admin.

Argumentpunkter

account_name_p

Returtyp

VOID

azure_storage.account_user_add

Funktion som gör det möjligt att bevilja 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 skickas som det första argumentet, redan har skapats med hjälp av azure_storage.account_add, och om användaren eller rollen, vars namn skickas som det andra argumentet, redan finns.

azure_storage.account_add(account_name_p text, user_p regrole);

Behörigheter

Måste vara medlem i azure_storage_admin.

Argumentpunkter

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 gör det möjligt att återkalla 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 skickas som det första argumentet redan har skapats med hjälp av azure_storage.account_add och om den användare eller roll vars namn skickas som det andra argumentet fortfarande finns. När en användare eller roll tas bort från servern, genom att DROP USER | ROLEköra , elimineras även de behörigheter som beviljats för alla referenser till Azure Storage-konton automatiskt.

azure_storage.account_user_remove(account_name_p text, user_p regrole);

Behörigheter

Måste vara medlem i azure_storage_admin.

Argumentpunkter

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 har konfigurerats 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();

Behörigheter

Måste vara medlem i azure_storage_admin.

Argumentpunkter

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 en lista ö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 beviljas å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);

Behörigheter

Användare eller roll som anropar den här funktionen måste läggas till i listan över tillåtna för den account_name angivna 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.

Argumentpunkter

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 måste du följa 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.

väg

text blobens fullständiga namn.

byte

bigint storleken på bloben i byte.

last_modified

timestamp with time zonedatum 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 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 det här huvudet har angetts kontrollerar lagringstjänsten den angivna hashen med en som beräknas från innehåll. Om de två hashvärdena inte matchar misslyckas åtgärden med felkoden 400 (felaktig begäran).

azure_storage.blob_get

Funktion som gör det möjligt att importera data. Den laddar ned en fil från en blobcontainer i ett Azure Storage-konto. Sedan översätts innehållet till rader, som kan användas och bearbetas med 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 angivna lagringskontot kontrollerar den här funktionen om namnen på lagringskontot och containern som skickas som argument är giltiga enligt de namngivningsverifieringsregler som införts för Azure-lagringskonton. Om någon av dem är ogiltig utlöses 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);

Det finns en överbelastad version av den här funktionen som accepterar en rec parameter som gör att du enkelt kan 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);

Behörigheter

Argumentpunkter

account_name

container_name

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

väg

text blobens fullständiga namn.

Rec

anyelement definitionen av postutdatastrukturen.

avkodare

text specifikationen för blobformatet. Kan anges till 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 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 .
`csv`		Format för kommaavgränsade värden som används av PostgreSQL COPY.
`tsv`		Tabbavgränsade värden, standardformatet PostgreSQL COPY.
`binary`		Binärt PostgreSQL COPY-format.
`text` \| `xml` \| `json`		En fil som innehåller ett enda textvärde.

komprimering

text specifikationen av komprimeringstyp. Kan anges till 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 .
`gzip`		Tvingar fram användning av gzip-avkodare för att dekomprimera bloben.
`none`		Tvingar att behandla bloben som en som inte kräver dekomprimering.

Tillägget stöder inte andra komprimeringstyper.

alternativ

jsonb de inställningar som definierar hanteringen av anpassade rubriker, anpassade avgränsare, escape-tecken osv. 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 gör det möjligt att exportera data genom att ladda upp filer till en blobcontainer i ett Azure Storage-konto. Innehållet i filerna skapas från rader i PostgreSQL.

Anmärkning

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

Det finns en överbelastad funktionsversion som innehåller encoder parametern som gör att du kan ange kodaren som ska användas när den inte kan härledas från parameterns tillägg path eller när du vill åsidosätta den härledda.

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

Det finns en överbelastad funktionsversion som också innehåller en compression parameter som gör att du kan ange vilken komprimering som ska användas när den inte kan härledas från parameterns tillägg path eller när du vill åsidosätta den härledda.

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

Det finns en överbelastad funktionsversion som också innehåller en options parameter för hantering av anpassade huvuden, anpassade avgränsare, escape-tecken osv. options fungerar på liknande sätt som de alternativ som kan skickas 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;

Behörigheter

Argumentpunkter

account_name

container_name

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

väg

text blobens fullständiga namn.

tupel

record definitionen av postutdatastrukturen.

Kodare

text specifikationen för blobformatet. Kan anges till 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 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 .
`csv`		Format för kommaavgränsade värden som används av PostgreSQL COPY.
`tsv`		Tabbavgränsade värden, standardformatet PostgreSQL COPY.
`binary`		Binärt PostgreSQL COPY-format.
`text` \| `xml` \| `json`		En fil som innehåller ett enda textvärde.

komprimering

text specifikationen av komprimeringstyp. Kan anges till 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 .
`gzip`		Tvingar fram användning av gzip-avkodare för att dekomprimera bloben.
`none`		Tvingar att behandla bloben som en som inte kräver dekomprimering.

Tillägget stöder inte andra komprimeringstyper.

alternativ

Returtyp

VOID

azure_storage.options_csv_get

Funktion som fungerar som en verktygsfunktion, som kan anropas som en parameter i blob_getoch är användbar för att avkoda innehållet i en csv-fil.

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

Behörigheter

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

Argumentpunkter

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, rapporterar 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.

citera

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, rapporterar 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, rapporterar 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_not_null

text[] matcha inte de angivna kolumnernas värden mot null-strä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, och om en matchning hittas anger du värdet till NULL. I standardfallet där null-strängen är tom konverteras en citerad tom sträng till NULL.

content_encoding

text namnet på den kodning som filen är kodad med. Om alternativet utelämnas används den aktuella klientkodningen.

Returtyp

jsonb

azure_storage.options_copy

Funktion som fungerar som en verktygsfunktion, som kan anropas som en parameter i blob_get. Den fungerar som en hjälpfunktion för 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);

Behörigheter

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

Argumentpunkter

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.

citera

ESC

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

force_null

content_encoding

text namnet på den kodning som filen är kodad med. Om alternativet utelämnas används den aktuella klientkodningen.

Returtyp

jsonb

azure_storage.options_tsv

Funktion som fungerar som en verktygsfunktion, som kan anropas som en parameter i blob_getoch är användbar för att avkoda innehållet i en tsv-fil.

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

Behörigheter

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

Argumentpunkter

avgränsare

null_string

content_encoding

text namnet på den kodning som filen är kodad med. Om alternativet utelämnas används den aktuella klientkodningen.

Returtyp

jsonb

azure_storage.options_binary

Funktion som fungerar som en verktygsfunktion, som kan anropas som en parameter i blob_getoch är användbar för att avkoda innehållet i en binär fil.

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

Behörigheter

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

Argumentpunkter

content_encoding

text namnet på den kodning som filen är kodad med. Om alternativet utelämnas används den aktuella klientkodningen.

Returtyp

jsonb

Feedback

Var den här sidan till hjälp?

Dela via

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

azure_storage.account_add

Behörigheter

Argumentpunkter

account_name_p

account_key_p

account_config

Returtyp

azure_storage.account_options_managed_identity

Behörigheter

Argumentpunkter

namn

typ

Returtyp

azure_storage.account_options_credentials

Behörigheter

Argumentpunkter

namn

Autentiseringsuppgifter

typ

Returtyp

azure_storage.account_options

Behörigheter

Argumentpunkter

namn

auth_type

storage_type

Autentiseringsuppgifter

Returtyp

azure_storage.account_remove

Behörigheter

Argumentpunkter

account_name_p

Returtyp

azure_storage.account_user_add

Behörigheter

Argumentpunkter

account_name_p

user_p

Returtyp

azure_storage.account_user_remove

Behörigheter

Argumentpunkter

account_name_p

user_p

Returtyp

azure_storage.account_list

Behörigheter

Argumentpunkter

Returtyp

azure_storage.blob_list

Behörigheter

Argumentpunkter

account_name

container_name

prefix

Returtyp

väg

byte

last_modified

etag etag

content_type

content_encoding

content_hash

azure_storage.blob_get

Behörigheter

Argumentpunkter

account_name

container_name

väg

Rec

avkodare

komprimering

alternativ

Returtyp

azure_storage.blob_put

Behörigheter

Argumentpunkter

account_name