@azure/cosmos package

Klassen

AbortError	Deze fout wordt gegenereerd wanneer een asynchrone bewerking is afgebroken. Controleer op deze fout door de name te testen of de naameigenschap van de fout overeenkomt met "AbortError". voorbeeld van const controller = new AbortController(); controller.abort(); try { doAsyncWork(controller.signal) } catch (e) { if (e.name === 'AbortError') { // handle abort error here. } }
ChangeFeedIterator	Biedt iterator voor wijzigingenfeed. Gebruik Items.changeFeed() om een exemplaar van de iterator op te halen.
ChangeFeedIteratorResponse	Eén antwoordpagina van de Wijzigingenfeed van Azure Cosmos DB
ChangeFeedPolicy	Vertegenwoordigt de beleidsconfiguratie voor wijzigingenfeeds voor een container in de Azure Cosmos DB-service.
ChangeFeedResponse	Eén antwoordpagina van de Wijzigingenfeed van Azure Cosmos DB
ChangeFeedRetentionTimeSpan
ChangeFeedStartFrom	Basisklasse voor het starten van een ChangeFeedIterator.
ClientSideMetrics
Conflict	Gebruik dit om een bepaalde conflict op id te lezen of te verwijderen. Zie conflicten om alle conflicten op te vragen of te lezen.
ConflictResponse
Conflicts	Gebruik dit om alle conflicten op te vragen of te lezen. Zie Conflict om een bepaalde Conflict op id te lezen of te verwijderen.
Container	Bewerkingen voor het lezen, vervangen of verwijderen van een specifieke, bestaande container op id. Zie Containers voor het maken van nieuwe containers en het lezen/opvragen van alle containers; .containersgebruiken. Opmerking: al deze bewerkingen voeren aanroepen tegen een vast budget. U moet uw systeem zodanig ontwerpen dat deze aanroepen sublijnig worden geschaald met uw toepassing. Roep bijvoorbeeld niet container(id).read() aan vóór elke item.read() aanroep om ervoor te zorgen dat de container bestaat; Doe dit eenmaal bij het opstarten van de toepassing.
ContainerResponse	Antwoordobject voor containerbewerkingen
Containers	Bewerkingen voor het maken van nieuwe containers en het lezen/opvragen van alle containers Zie Container voor het lezen, vervangen of verwijderen van een bestaande container; .container(id)gebruiken. Opmerking: al deze bewerkingen voeren aanroepen tegen een vast budget. U moet uw systeem zodanig ontwerpen dat deze aanroepen sublijnig worden geschaald met uw toepassing. Roep bijvoorbeeld niet containers.readAll() aan vóór elke item.read() aanroep om ervoor te zorgen dat de container bestaat; Doe dit eenmaal bij het opstarten van de toepassing.
CosmosClient	Biedt een logische weergave aan de clientzijde van het Azure Cosmos DB-databaseaccount. Deze client wordt gebruikt voor het configureren en uitvoeren van aanvragen in de Azure Cosmos DB-databaseservice. voorbeeld van Een client instantiëren en een nieuwe database maken const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"}); await client.databases.create({id: "<database name here>"}); voorbeeld van Een client instantiëren met aangepast verbindingsbeleid const client = new CosmosClient({ endpoint: "<URL HERE>", key: "<KEY HERE>", connectionPolicy: { requestTimeout: 10000, }, });
CosmosDiagnostics	Dit is een Cosmos Diagnostic-type dat verzamelde diagnostische gegevens bevat tijdens een clientbewerking. Ie. Item.read(), Container.create(). Het heeft drie leden - clientSideRequestStatistics lid bevat geaggregeerde diagnostische gegevens, waaronder - zoekacties voor metagegevens. Hier worden alle serveraanvragen, afgezien van de uiteindelijke beoogde resource, beschouwd als metagegevens aanroepen. d.w.e. voor item.read(id), als de client serveroproep doet om eindpunten te detecteren, wordt deze beschouwd als metagegevensoproep. Pogingen eindpunten die contact hebben opgenomen. aanvraag, nettoladingstatistieken van antwoord. gatewayStatistics : informatie die overeenkomt met de hoofdbewerking. Tijdens Item.read() kan de client bijvoorbeeld veel bewerkingen uitvoeren, zoals het opzoeken van metagegevens, enzovoort, maar gatewayStatistics vertegenwoordigen de diagnostische gegevens voor de werkelijke leesbewerking. diagnosticNode: is een structuur zoals structuur die gedetailleerde diagnostische gegevens vastlegt. Deze is standaard uitgeschakeld en is alleen bedoeld voor foutopsporing in niet-productieomgevingen. Het soort gegevens dat in diagnosticNode is vastgelegd, wordt beheerd door CosmosDbDiagnosticLevel. CosmosDbDiagnosticLevel.info - is de standaardwaarde. In dit niveau worden alleen clientSideRequestStatistics vastgelegd. Is bedoeld voor productieomgevingen. CosmosDbDiagnosticLevel.debug : legt diagnosticNode en clientConfig vast. Er worden geen nettoladingen voor aanvragen en antwoorden vastgelegd. Is niet bedoeld om te worden gebruikt in een productieomgeving. CosmosDbDiagnosticLevel.debug-onveilig: naast gegevens die zijn vastgelegd in CosmosDbDiagnosticLevel.debug, worden ook nettoladingen van aanvragen en antwoorden vastgelegd. Is niet bedoeld om te worden gebruikt in een productieomgeving. clientConfig: legt informatie vast met betrekking tot de configuratie van de client tijdens de initialisatie.
Database	Bewerkingen voor het lezen of verwijderen van een bestaande database. Zie Databases voor het maken van nieuwe databases en het lezen/opvragen van alle databases; client.databasesgebruiken. Opmerking: al deze bewerkingen voeren aanroepen tegen een vast budget. U moet uw systeem zodanig ontwerpen dat deze aanroepen sublijnig worden geschaald met uw toepassing. Roep bijvoorbeeld niet database.read() aan vóór elke item.read() aanroep om ervoor te zorgen dat de database bestaat; Doe dit eenmaal bij het opstarten van de toepassing.
DatabaseAccount	Vertegenwoordigt een DatabaseAccount in de Azure Cosmos DB-databaseservice.
DatabaseResponse	Antwoordobject voor databasebewerkingen
Databases	Bewerkingen voor het maken van nieuwe databases en het lezen/opvragen van alle databases Zie Database voor het lezen of verwijderen van een bestaande database; client.database(id)gebruiken. Opmerking: al deze bewerkingen voeren aanroepen tegen een vast budget. U moet uw systeem zodanig ontwerpen dat deze aanroepen sublijnig worden geschaald met uw toepassing. Roep bijvoorbeeld niet databases.readAll() aan vóór elke item.read() aanroep om ervoor te zorgen dat de database bestaat; Doe dit eenmaal bij het opstarten van de toepassing.
ErrorResponse
FeedRange	Hiermee geeft u een feedbereik voor de wijzigingenfeed op.
FeedResponse
Item	Wordt gebruikt om bewerkingen uit te voeren op een specifiek item. Zie items voor bewerkingen op alle items; zie container.items.
ItemResponse
Items	Bewerkingen voor het maken van nieuwe items en het lezen/opvragen van alle items Zie Item voor het lezen, vervangen of verwijderen van een bestaande container; .item(id)gebruiken.
Offer	Gebruik dit om een bestaande aanbieding op id te lezen of te vervangen. Zie Aanbiedingen om alle aanbiedingen op te vragen of te lezen.
OfferResponse
Offers	Gebruik deze functie om alle aanbiedingen op te vragen of te lezen. Zie Aanbieding om een bestaande Aanbieding te lezen of te vervangen door id.
PartitionKeyBuilder	Opbouwklasse voor het bouwen van PartitionKey.
Permission	Gebruik dit om een bepaalde machtiging op id te lezen, te vervangen of te verwijderen. Zie machtigingen om alle machtigingen te maken, upsert, query's uit te voeren of te lezen.
PermissionResponse
Permissions	Gebruik dit om alle machtigingen te maken, te vervangen, te doorzoeken en te lezen. Zie machtiging om een specifieke machtiging per id te lezen, vervangen of verwijderen.
QueryIterator	Vertegenwoordigt een QueryIterator-object, een implementatie van feed- of queryreacties waarmee doorkruising en iteratie van het antwoord in de Azure Cosmos DB-databaseservice mogelijk is.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError	Een aangepast fouttype voor mislukte pijplijnaanvragen.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure	Bewerkingen voor het lezen, vervangen, verwijderen of uitvoeren van een specifieke, bestaande opgeslagen procedure op id. Voor bewerkingen om opgeslagen procedures te maken, lezen of opgeslagen procedures op te vragen,
StoredProcedureResponse
StoredProcedures	Bewerkingen voor het maken, upsert of lezen/opvragen van alle opgeslagen procedures. Zie container.storedProcedure()voor bewerkingen voor het lezen, vervangen, verwijderen of uitvoeren van een specifieke, bestaande opgeslagen procedure op id.
TimeoutError
Trigger	Bewerkingen voor het lezen, vervangen of verwijderen van een Trigger-. Gebruik container.triggers om alles te maken, upsert, query's uit te voeren of te lezen.
TriggerResponse
Triggers	Bewerkingen voor het maken, upsert, opvragen en lezen van alle triggers. Gebruik container.triggers om een Trigger-te lezen, te vervangen of te verwijderen.
User	Wordt gebruikt om gebruikers te lezen, te vervangen en te verwijderen. Daarnaast hebt u toegang tot de machtigingen voor een bepaalde gebruiker via user.permission en user.permissions. Zie gebruikers om alles te maken, upsert, op te vragen of te lezen.
UserDefinedFunction	Wordt gebruikt voor het lezen, vervangen of verwijderen van een opgegeven door de gebruiker geweigerde functie op id. Zie UserDefinedFunction om alle door de gebruiker gedefinieerde functies te maken, upsert, query's te lezen.
UserDefinedFunctionResponse
UserDefinedFunctions	Wordt gebruikt voor het maken, upsert, opvragen of lezen van alle door de gebruiker gedefinieerde functies. Zie UserDefinedFunction om een bepaalde door de gebruiker gedefinieerde functie te lezen, vervangen of verwijderen op id.
UserResponse
Users	Wordt gebruikt om alle gebruikers te maken, upsert, query's uit te voeren en te lezen. Zie Gebruiker een specifieke gebruiker lezen, vervangen of verwijderen op id.

Interfaces

@azure/cosmos.Index

Agent
BulkOptions	Optiesobject dat wordt gebruikt om bulkuitvoering te wijzigen. continueOnError (standaardwaarde: false) - Continue bulkuitvoering wanneer een bewerking mislukt ** OPMERKING DIT IS STANDAARD INGESTELD OP TRUE IN de 4.0 RELEASE
ChangeFeedIteratorOptions	Hiermee geeft u opties voor de wijzigingenfeed Als geen van deze opties is ingesteld, wordt vanaf nu wijzigingen voor de hele container gelezen.
ChangeFeedOptions	Hiermee geeft u opties voor de wijzigingenfeed Sommige van deze opties bepalen waar en wanneer ze moeten worden gelezen vanuit de wijzigingenfeed. De volgorde van prioriteit is: voortzetting startTime startFromBeginning Als geen van deze opties is ingesteld, wordt vanaf de eerste ChangeFeedIterator.fetchNext()-aanroep wijzigingen gelezen.
ChangeFeedPullModelIterator	Gebruik Items.getChangeFeedIterator() om een iterator te retourneren die alle wijzigingen voor een partitiesleutel, feedbereik of een hele container kan herhalen.
CompositePath	Vertegenwoordigt een samengesteld pad in het indexeringsbeleid.
ComputedProperty
ConflictDefinition
ConflictResolutionPolicy	Vertegenwoordigt de beleidsconfiguratie voor conflictoplossing voor het oplossen van conflicten in het geval schrijfbewerkingen uit verschillende regio's leiden tot conflicten in documenten in de verzameling in de Azure Cosmos DB-service.
ConnectionPolicy	Vertegenwoordigt het verbindingsbeleid dat is gekoppeld aan een CosmosClient in de Azure Cosmos DB-databaseservice.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode	Vertegenwoordigt een structuur als structuur voor het vastleggen van diagnostische gegevens.
ErrorBody
FailedRequestAttemptDiagnostic	Met dit type worden diagnostische gegevens vastgelegd met betrekking tot een mislukte aanvraag naar de server-API.
FeedOptions	De feedopties en querymethoden.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition	Items in Cosmos DB zijn gewoon JSON-objecten. Met de meeste itembewerkingen kunt u uw eigen type opgeven dat de zeer eenvoudige ItemDefinition uitbreidt. U kunt geen gereserveerde sleutels gebruiken. U ziet de lijst met gereserveerde sleutels in <xref:ItemBody>
JSONArray
JSONObject
Location	Wordt gebruikt om de beschikbare locaties op te geven, is lezen index 1 en schrijven is index 0.
MetadataLookUpDiagnostic	Dit type bevat diagnostische informatie met betrekking tot één aanvraag voor metagegevens naar de server.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions	Opties die kunnen worden opgegeven voor een aangevraagde aanvraag die is uitgegeven aan de Azure Cosmos DB-servers.=
Resource
RetryOptions	Vertegenwoordigt het beleid voor opnieuw proberen dat is gekoppeld aan beperkte aanvragen in de Azure Cosmos DB-databaseservice.
SharedOptions	Opties die kunnen worden opgegeven voor een aangevraagde aanvraag die is uitgegeven aan de Azure Cosmos DB-servers.=
SpatialIndex
SqlParameter	Vertegenwoordigt een parameter in een geparameteriseerde SQL-query die is opgegeven in SqlQuerySpec-
SqlQuerySpec	Vertegenwoordigt een SQL-query in de Azure Cosmos DB-service. Query's met invoer moeten worden geparameteriseerd om te beveiligen tegen SQL-injectie. voorbeeld van Geparameteriseerde SQL-query const query: SqlQuerySpec = { query: "SELECT * FROM Families f where f.lastName = @lastName", parameters: [ {name: "@lastName", value: "Wakefield"} ] };
StoredProcedureDefinition
TriggerDefinition
UniqueKey	Interface voor één unieke sleutel die is doorgegeven als onderdeel van UniqueKeyPolicy
UniqueKeyPolicy	Interface voor het instellen van unieke sleutels bij het maken van containers
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition
VectorEmbedding	Vertegenwoordigt een vector insluiten. Een vector insluiten wordt gebruikt om een vectorveld in de documenten te definiëren.
VectorEmbeddingPolicy	Vertegenwoordigt de beleidsconfiguratie voor vectorinsluitingen in de Azure Cosmos DB-service.
VectorIndex	Vertegenwoordigt een vectorindex in de Azure Cosmos DB-service. Een vectorindex wordt gebruikt om vectorvelden in de documenten te indexeren.

Type-aliassen

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic	Dit type bevat informatie met betrekking tot de initialisatie van CosmosClient
ClientSideRequestStatistics	Dit is een verzamelingstype voor alle diagnostische gegevens aan de clientzijde.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics	Dit type bevat diagnostische informatie met betrekking tot alle metagegevensaanvragen naar de server tijdens een CosmosDB-clientbewerking.
NonePartitionKeyType	Het geretourneerde object vertegenwoordigt een partitiesleutelwaarde waarmee items kunnen worden gemaakt en geopend zonder een waarde voor de partitiesleutel
NullPartitionKeyType	Het geretourneerde object vertegenwoordigt een partitiesleutelwaarde waarmee items kunnen worden gemaakt en geopend met een null-waarde voor de partitiesleutel.
Operation
OperationInput
OperationWithItem
PartitionKey	PartitionKey van een container.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue	Een primitieve partitiesleutelwaarde.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics	Met dit type worden diagnostische gegevens vastgelegd met betrekking tot nieuwe pogingen tijdens een CosmosDB-clientbewerking.
TokenProvider
UpsertOperation

Enums

ChangeFeedMode
ConflictResolutionMode
ConnectionMode	Bepaalt het verbindingsgedrag van de CosmosClient. Opmerking: momenteel bieden we alleen ondersteuning voor de gatewaymodus.
ConsistencyLevel	Vertegenwoordigt de consistentieniveaus die worden ondersteund voor Azure Cosmos DB-clientbewerkingen. Het aangevraagde ConsistencyLevel moet overeenkomen met of zwakker zijn dan die voor het databaseaccount is ingericht. Consistentieniveaus. Consistentieniveaus op volgorde van sterkte zijn Sterk, BoundedStaleness, Sessie, Consistent voorvoegsel en Uiteindelijk. Zie https://aka.ms/cosmos-consistency voor gedetailleerdere documentatie over consistentieniveaus.
CosmosDbDiagnosticLevel	Diagnostisch niveau van Cosmos DB
DataType	Definieert een doelgegevenstype van een indexpadspecificatie in de Azure Cosmos DB-service.
GeospatialType
IndexKind	Hiermee geeft u de ondersteunde indextypen.
IndexingMode	Hiermee geeft u de ondersteunde indexeringsmodi op.
MetadataLookUpType	Dit is een opsomming voor het type metagegevenszoekacties dat mogelijk is.
PartitionKeyDefinitionVersion	PartitionKey-definitieversie
PartitionKeyKind	Type PartitionKey, bijvoorbeeld Hash, MultiHash
PermissionMode	Opsomming voor waarden in de machtigingsmodus.
PriorityLevel	Vertegenwoordigt prioriteitsniveau dat is gekoppeld aan elke Azure Cosmos DB-clientaanvragen. De aanvragen met lage prioriteit worden altijd beperkt vóór aanvragen met hoge prioriteit. Standaard worden alle aanvragen beschouwd als aanvragen met hoge prioriteit. Zie https://aka.ms/CosmosDB/PriorityBasedExecution voor gedetailleerdere documentatie over beperking op basis van Prioriteit.
SpatialType
TriggerOperation	Opsomming voor triggerbewerkingswaarden. geeft de bewerkingen op waarop een trigger moet worden uitgevoerd.
TriggerType	Opsomming voor triggertypewaarden. Hiermee geeft u het type van de trigger.
UserDefinedFunctionType	Enum voor udf-typewaarden. Hiermee geeft u de typen door de gebruiker gedefinieerde functies op.
VectorEmbeddingDataType	Vertegenwoordigt het gegevenstype van de vector.
VectorEmbeddingDistanceFunction	Vertegenwoordigt de afstandsfunctie die moet worden gebruikt voor de berekening van de afstand tussen vectoren.
VectorIndexType	Vertegenwoordigt het indextype van de vector.

Functies

createAuthorizationSasToken(string, SasTokenProperties)

Experimenteel intern genereert alleen de nettolading die de machtigingsconfiguratie voor het SAS-token vertegenwoordigt.

Functiedetails

createAuthorizationSasToken(string, SasTokenProperties)

Experimenteel intern genereert alleen de nettolading die de machtigingsconfiguratie voor het SAS-token vertegenwoordigt.

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

Parameters

masterKey

string

sasTokenProperties

SasTokenProperties

Retouren

Promise<string>