@azure/cosmos package

Klasser

AbortError	Det här felet utlöses när en asynkron åtgärd har avbrutits. Sök efter det här felet genom att testa name att namnegenskapen för felet matchar "AbortError". Exempel const controller = new AbortController(); controller.abort(); try { doAsyncWork(controller.signal) } catch (e) { if (e.name === 'AbortError') { // handle abort error here. } }
ChangeFeedIterator	Tillhandahåller iterator för ändringsflöde. Använd Items.changeFeed() för att hämta en instans av iteratorn.
ChangeFeedIteratorResponse	En enda svarssida från Ändringsflödet i Azure Cosmos DB
ChangeFeedResponse	En enda svarssida från Ändringsflödet i Azure Cosmos DB
ChangeFeedStartFrom	Basklass för var du vill starta en ChangeFeedIterator.
ClientSideMetrics
Conflict	Använd för att läsa eller ta bort en viss konflikt efter ID. Se Konflikter för att fråga efter eller läsa alla konflikter.
ConflictResponse
Conflicts	Använd för att fråga eller läsa alla konflikter. Se Konflikt för att läsa eller ta bort en viss konflikt efter ID.
Container	Åtgärder för att läsa, ersätta eller ta bort en specifik befintlig container med ID. Se Containrar för att skapa nya containrar och läsa/köra frågor mot alla containrar. använd .containers. Obs! Alla dessa åtgärder gör anrop mot en fast budget. Du bör utforma systemet så att dessa anrop skalas sublinearly med ditt program. Anropa container(id).read() till exempel inte före varje enskilt item.read() anrop för att säkerställa att containern finns. Gör detta en gång när programmet startas.
ContainerResponse	Svarsobjekt för containeråtgärder
Containers	Åtgärder för att skapa nya containrar och läsa/fråga alla containrar Se Container för att läsa, ersätta eller ta bort en befintlig container. använd .container(id). Obs! Alla dessa åtgärder gör anrop mot en fast budget. Du bör utforma systemet så att dessa anrop skalas sublinearly med ditt program. Anropa containers.readAll() till exempel inte före varje enskilt item.read() anrop för att säkerställa att containern finns. Gör detta en gång när programmet startas.
CosmosClient	Tillhandahåller en logisk representation på klientsidan av Azure Cosmos DB-databaskontot. Den här klienten används för att konfigurera och köra begäranden i Azure Cosmos DB-databastjänsten. Exempel Skapa en instans av en klient och skapa en ny databas const client = new CosmosClient({endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}}); await client.databases.create({id: "<datbase name here>"}); Exempel Instansiera en klient med anpassad anslutningsprincip const connectionPolicy = new ConnectionPolicy(); connectionPolicy.RequestTimeout = 10000; const client = new CosmosClient({ endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}, connectionPolicy });
CosmosDiagnostics	Det här är en Cosmos-diagnostiktyp som innehåller insamlad diagnostikinformation under en klientåtgärd. Dvs. Item.read(), Container.create(). Den har tre medlemmar - clientSideRequestStatistics medlem innehåller aggregerad diagnostikinformation, inklusive - metadatasökningar. Här betraktas alla serverbegäranden, förutom den slutliga avsedda resursen som metadataanrop. Dvs. för item.read(id), om klienten gör serveranrop för att identifiera slutpunkter skulle det betraktas som metadataanrop. Försök slutpunkter som kontaktas. begäran, svarsnyttolaststatistik. gatewayStatistics – information som motsvarar huvudåtgärden. Till exempel under Item.read() kan klienten utföra många åtgärder, t.ex. metadatasökning osv. men gatewayStatistics representerar diagnostikinformationen för den faktiska läsåtgärden. diagnosticNode – är ett träd som en struktur som samlar in detaljerad diagnostikinformation. Som standard är den inaktiverad och är avsedd att endast användas för felsökning i icke-produktionsmiljöer. Den typ av information som samlas in i diagnosticNode styrs av CosmosDbDiagnosticLevel. CosmosDbDiagnosticLevel.info – är standardvärde. På den här nivån registreras endast clientSideRequestStatistics. Är avsett för produktionsmiljöer. CosmosDbDiagnosticLevel.debug – Samlar in diagnosticNode och clientConfig. Inga nyttolaster för begäranden och svar samlas in. Är inte avsett att användas i produktionsmiljön. CosmosDbDiagnosticLevel.debug-unsafe – Förutom data som samlas in i CosmosDbDiagnosticLevel.debug samlar även in nyttolaster för förfrågningar och svar. Är inte avsett att användas i produktionsmiljön. clientConfig – samlar in information om hur klienten konfigurerades under initieringen.
Database	Åtgärder för att läsa eller ta bort en befintlig databas. Se Databaser för att skapa nya databaser och läsa/fråga alla databaser; använd client.databases. Obs! Alla dessa åtgärder gör anrop mot en fast budget. Du bör utforma systemet så att dessa anrop skalas sublinearly med ditt program. Anropa database.read() till exempel inte före varje enskilt item.read() anrop för att säkerställa att databasen finns. Gör detta en gång när programmet startas.
DatabaseAccount	Representerar ett DatabaseAccount i Azure Cosmos DB-databastjänsten.
DatabaseResponse	Svarsobjekt för databasåtgärder
Databases	Åtgärder för att skapa nya databaser och läsa/fråga alla databaser Se Databas för att läsa eller ta bort en befintlig databas; använd client.database(id). Obs! Alla dessa åtgärder gör anrop mot en fast budget. Du bör utforma systemet så att dessa anrop skalas sublinearly med ditt program. Anropa databases.readAll() till exempel inte före varje enskilt item.read() anrop för att säkerställa att databasen finns. Gör detta en gång när programmet startas.
ErrorResponse
FeedRange	Anger ett flödesintervall för ändringsfeeden.
FeedResponse
Item	Används för att utföra åtgärder på ett visst objekt. Se Objekt för åtgärder på alla objekt; se container.items.
ItemResponse
Items	Åtgärder för att skapa nya objekt och läsa/fråga alla objekt Se Objekt för att läsa, ersätta eller ta bort en befintlig container. använd .item(id).
Offer	Använd för att läsa eller ersätta ett befintligt erbjudande med ID. Se Erbjudanden för att fråga eller läsa alla erbjudanden.
OfferResponse
Offers	Använd för att fråga eller läsa alla erbjudanden. Se Erbjudande för att läsa eller ersätta ett befintligt erbjudande med ID.
PartitionKeyBuilder	Builder-klass för att skapa PartitionKey.
Permission	Använd för att läsa, ersätta eller ta bort en viss behörighet med ID. Se Behörigheter för att skapa, upsert, fråga eller läsa alla behörigheter.
PermissionResponse
Permissions	Använd för att skapa, ersätta, fråga och läsa alla behörigheter. Se Behörighet att läsa, ersätta eller ta bort en specifik behörighet med ID.
QueryIterator	Representerar ett QueryIterator-objekt, en implementering av feed- eller frågesvar som möjliggör bläddrande och itererande över svaret i Azure Cosmos DB-databastjänsten.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError	En anpassad feltyp för misslyckade pipelinebegäranden.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure	Åtgärder för att läsa, ersätta, ta bort eller köra en specifik, befintlig lagrad procedur med ID. För åtgärder för att skapa, läsa alla eller fråga lagrade procedurer,
StoredProcedureResponse
StoredProcedures	Åtgärder för att skapa, utöka eller läsa/köra frågor mot alla lagrade procedurer. Information om åtgärder för att läsa, ersätta, ta bort eller köra en specifik, befintlig lagrad procedur med ID finns i container.storedProcedure().
TimeoutError
Trigger	Åtgärder för att läsa, ersätta eller ta bort en utlösare. Använd container.triggers för att skapa, upsert, fråga eller läsa alla.
TriggerResponse
Triggers	Åtgärder för att skapa, upsert, fråga och läsa alla utlösare. Använd container.triggers för att läsa, ersätta eller ta bort en utlösare.
User	Används för att läsa, ersätta och ta bort användare. Dessutom kan du komma åt behörigheterna för en viss användare via user.permission och user.permissions. Se Användare för att skapa, upsert, fråga eller läsa alla.
UserDefinedFunction	Används för att läsa, ersätta eller ta bort en angiven användardefinierad funktion med ID. Se UserDefinedFunction för att skapa, upsert, fråga, läsa alla användardefinierade funktioner.
UserDefinedFunctionResponse
UserDefinedFunctions	Används för att skapa, upsert, fråga eller läsa alla användardefinierade funktioner. Se UserDefinedFunction för att läsa, ersätta eller ta bort en viss användardefinierad funktion med id.
UserResponse
Users	Används för att skapa, upsert, fråga och läsa alla användare. Se Användare för att läsa, ersätta eller ta bort en specifik användare med ID.

Gränssnitt

@azure/cosmos.Index

Agent
BulkOptions	Alternativobjekt som används för att ändra masskörning. continueOnError (standardvärde: falskt) – Fortsätter masskörningen när en åtgärd misslyckas ** OBSERVERA ATT STANDARDVÄRDET ÄR TRUE I 4.0-VERSIONEN
ChangeFeedIteratorOptions	Anger alternativ för ändringsflödet Om inget av dessa alternativ har angetts börjar det läsa ändringar från och med nu för hela containern.
ChangeFeedOptions	Anger alternativ för ändringsflödet Vissa av dessa alternativ styr var och när du ska börja läsa från ändringsflödet. Prioritetsordningen är: Fortsättning startTime startFromBeginning Om inget av dessa alternativ har angetts börjar det läsa ändringar från det första ChangeFeedIterator.fetchNext() anropet.
ChangeFeedPullModelIterator	Använd Items.getChangeFeedIterator() för att returnera en iterator som kan iterera över alla ändringar för en partitionsnyckel, ett flödesintervall eller en hel container.
ConflictDefinition
ConflictResolutionPolicy	Representerar konfigurationen av konfliktlösningsprincipen för att ange hur konflikter ska lösas om skrivningar från olika regioner resulterar i konflikter i dokument i samlingen i Azure Cosmos DB-tjänsten.
ConnectionPolicy	Representerar den anslutningsprincip som är associerad med en CosmosClient i Azure Cosmos DB-databastjänsten.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode	Representerar ett träd som en struktur för att samla in diagnostikinformation.
ErrorBody
FailedRequestAttemptDiagnostic	Den här typen samlar in diagnostisk information om en misslyckad begäran till server-API:et.
FeedOptions	Flödesalternativen och frågemetoderna.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition	Objekt i Cosmos DB är helt enkelt JSON-objekt. De flesta objektåtgärder gör att du kan ange din egen typ som utökar den mycket enkla ItemDefinition. Du kan inte använda några reserverade nycklar. Du kan se listan över reserverade nycklar i <xref:ItemBody>
JSONArray
JSONObject
Location	Används för att ange vilka platser som är tillgängliga, läsning är index 1 och skrivning är index 0.
MetadataLookUpDiagnostic	Den här typen innehåller diagnostikinformation om en enskild metadatabegäran till servern.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions	Alternativ som kan anges för en begärd som utfärdats till Azure Cosmos DB-servrarna.=
Resource
RetryOptions	Representerar återförsöksprincipen som är assocerad med begränsade begäranden i Azure Cosmos DB-databastjänsten.
SharedOptions	Alternativ som kan anges för en begärd som utfärdats till Azure Cosmos DB-servrarna.=
SpatialIndex
SqlParameter	Representerar en parameter i en parameteriserad SQL-fråga som anges i SqlQuerySpec
SqlQuerySpec	Representerar en SQL-fråga i Azure Cosmos DB-tjänsten. Frågor med indata bör parametriseras för att skydda mot SQL-inmatning. Exempel Parameteriserad SQL-fråga const query: SqlQuerySpec = { query: "SELECT * FROM Families f where f.lastName = @lastName", parameters: [ {name: "@lastName", value: "Wakefield"} ] };
StoredProcedureDefinition
TriggerDefinition
UniqueKey	Gränssnitt för en enda unik nyckel som skickas som en del av UniqueKeyPolicy
UniqueKeyPolicy	Gränssnitt för att ange unika nycklar vid skapande av container
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition

Typalias

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic	Den här typen innehåller information om initiering av CosmosClient
ClientSideRequestStatistics	Det här är en samlingstyp för all diagnostikinformation på klientsidan.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics	Den här typen innehåller diagnostikinformation om alla metadatabegäran till servern under en CosmosDB-klientåtgärd.
NonePartitionKeyType	Det returnerade objektet representerar ett partitionsnyckelvärde som gör det möjligt att skapa och komma åt objekt utan ett värde för partitionsnyckeln
NullPartitionKeyType	Det returnerade objektet representerar ett partitionsnyckelvärde som gör det möjligt att skapa och komma åt objekt med ett null-värde för partitionsnyckeln.
Operation
OperationInput
OperationWithItem
PartitionKey	PartitionKey för en container.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue	Ett primitivt partitionsnyckelvärde.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics	Den här typen samlar in diagnostikinformation om återförsök under en CosmosDB-klientåtgärd.
TokenProvider
UpsertOperation

Uppräkningar

ConflictResolutionMode
ConnectionMode	Avgör anslutningsbeteendet för CosmosClient. Observera att vi för närvarande endast stöder gatewayläge.
ConsistencyLevel	Representerar de konsekvensnivåer som stöds för Azure Cosmos DB-klientåtgärder. Den begärda ConsistencyLevel måste matcha eller vara svagare än den som har etablerats för databaskontot. Konsekvensnivåer. Konsekvensnivåer efter styrkeordning är Strong, BoundedStaleness, Session, Consistent Prefix och Eventual. Mer https://aka.ms/cosmos-consistency detaljerad dokumentation om konsekvensnivåer finns i.
CosmosDbDiagnosticLevel	Cosmos DB-diagnostiknivå
DataType	Definierar en måldatatyp för en indexsökvägsspecifikation i Azure Cosmos DB-tjänsten.
GeospatialType
IndexKind	Anger vilka indextyper som stöds.
IndexingMode	Anger vilka indexeringslägen som stöds.
MetadataLookUpType	Detta är enum för typ av metadatasökningar som är möjliga.
PartitionKeyDefinitionVersion	PartitionKey Definition Version
PartitionKeyKind	Typ av PartitionKey, d.v.s. hash, multihash
PermissionMode	Räkna upp behörighetslägesvärden.
PriorityLevel	Representerar prioritetsnivå som är associerad med varje Azure Cosmos DB-klientbegäranden. Begäranden med låg prioritet begränsas alltid före begäranden med hög prioritet. Som standard betraktas alla begäranden som begäranden med hög prioritet. Mer https://aka.ms/CosmosDB/PriorityBasedExecution detaljerad dokumentation om prioritetsbaserad begränsning finns i .
SpatialType
TriggerOperation	Räkna upp värden för utlösaråtgärd. anger de åtgärder som en utlösare ska köras på.
TriggerType	Räkna upp värden för utlösartyp. Anger typen av utlösare.
UserDefinedFunctionType	Uppräkning för udf-typvärden. Anger typerna av användardefinierade funktioner.

Funktioner

createAuthorizationSasToken(string, SasTokenProperties)

Experimentell intern endast Genererar nyttolasten som representerar behörighetskonfigurationen för sas-token.

Funktionsinformation

createAuthorizationSasToken(string, SasTokenProperties)

Experimentell intern endast Genererar nyttolasten som representerar behörighetskonfigurationen för sas-token.

function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>

Parametrar

masterKey

string

sasTokenProperties

SasTokenProperties

Returer

Promise<string>