Dela via

@azure/cosmos package

  • Referens

Klasser

AbortError

Det här felet utlöses när en asynkron åtgärd har avbrutits. Kontrollera 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 Azure Cosmos DB-ändringsflödet
ChangeFeedPolicy

Representerar principkonfigurationen för ändringsflöde för en container i Azure Cosmos DB-tjänsten.
ChangeFeedResponse

En enda svarssida från Azure Cosmos DB-ändringsflödet
ChangeFeedRetentionTimeSpan
ChangeFeedStartFrom

Basklass för var du ska 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 efter eller läsa alla konflikter.

Läs 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 anropar en fast budget. Du bör utforma systemet så att dessa anrop skalas sublinearly med ditt program. Anropa till exempel inte container(id).read() innan 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/köra frågor mot 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 anropar en fast budget. Du bör utforma systemet så att dessa anrop skalas sublinearly med ditt program. Anropa till exempel inte containers.readAll() innan 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

Instansiera en klient och skapa en ny databas

const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});

Exempel

Instansiera en klient med anpassad anslutningsprincip

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});
CosmosDiagnostics
  • Det här är en Cosmos-diagnostiktyp som innehåller insamlad diagnostikinformation under en klientåtgärd. ie. Item.read(), Container.create(). Den har tre medlemmar -
  1. 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 kontaktats.
  • 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.
  1. diagnosticNode – är en trädliknande 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 – fångar diagnosticNode och clientConfig. Inga nyttolaster för begäran 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 begäran och svar. Är inte avsett att användas i produktionsmiljön.
  1. 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/köra frågor mot alla databaser. använd client.databases.

Obs! Alla dessa åtgärder anropar en fast budget. Du bör utforma systemet så att dessa anrop skalas sublinearly med ditt program. Anropa till exempel inte database.read() 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/köra frågor mot alla databaser

Se Database för att läsa eller ta bort en befintlig databas. använd client.database(id).

Obs! Alla dessa åtgärder anropar en fast budget. Du bör utforma systemet så att dessa anrop skalas sublinearly med ditt program. Anropa till exempel inte databases.readAll() 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/köra frågor mot 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 efter eller läsa alla erbjudanden.
OfferResponse
Offers

Använd för att fråga efter 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 för 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äddringar och iterering ö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.

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

Läs 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: false) – Fortsätter masskörningen när en åtgärd misslyckas ** OBSERVERA ATT DETTA KOMMER ATT VARA SANT I VERSION 4.0
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.
CompositePath

Representerar en sammansatt sökväg i indexeringsprincipen.
ComputedProperty
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 anslutningsprincipen 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 struktur för att samla in diagnostikinformation.
ErrorBody
FailedRequestAttemptDiagnostic

Den här typen samlar in diagnostikinformation 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 utfärdad till Azure Cosmos DB-servrarna.=
Resource
RetryOptions

Representerar återförsöksprincipen som är inlagd med begränsade begäranden i Azure Cosmos DB-databastjänsten.
SharedOptions

Alternativ som kan anges för en begärd utfärdad 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 ska 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
VectorEmbedding

Representerar en vektorbäddning. En vektorbäddning används för att definiera ett vektorfält i dokumenten.
VectorEmbeddingPolicy

Representerar principkonfigurationen för vektorbäddningar i Azure Cosmos DB-tjänsten.
VectorIndex

Representerar ett vektorindex i Azure Cosmos DB-tjänsten. Ett vektorindex används för att indexera vektorfält i dokumenten.

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

ChangeFeedMode
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 Stark, BoundedStaleness, Session, Consistent Prefix och Eventual.

Mer detaljerad dokumentation om konsekvensnivåer finns i https://aka.ms/cosmos-consistency.
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

Det här är en uppräkning för möjliga typer av metadatasökningar.
PartitionKeyDefinitionVersion

PartitionKey-definitionsversion
PartitionKeyKind

Typ av PartitionKey, d.v.s. Hash, MultiHash
PermissionMode

Räkna upp värden för behörighetsläge.
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 detaljerad dokumentation om prioritetsbaserad begränsning finns i https://aka.ms/CosmosDB/PriorityBasedExecution.
SpatialType
TriggerOperation

Uppräkning för utlösaråtgärdsvärden. 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.
VectorEmbeddingDataType

Representerar datatypen för vektorn.
VectorEmbeddingDistanceFunction

Representerar den avståndsfunktion som ska användas för avståndsberäkning mellan vektorer.
VectorIndexType

Representerar vektorns indextyp.

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>