Condividi tramite

@azure/cosmos package

  • Riferimento

Classi

AbortError

Questo errore viene generato quando un'operazione asincrona è stata interrotta. Verificare la presenza di questo errore testando il name che la proprietà name dell'errore corrisponde a "AbortError".

Esempio

const controller = new AbortController();
controller.abort();
try {
  doAsyncWork(controller.signal)
} catch (e) {
  if (e.name === 'AbortError') {
    // handle abort error here.
  }
}
ChangeFeedIterator

Fornisce l'iteratore per il feed di modifiche.

Usare Items.changeFeed() per ottenere un'istanza dell'iteratore.
ChangeFeedIteratorResponse

Una singola pagina di risposta dal feed di modifiche di Azure Cosmos DB
ChangeFeedPolicy

Rappresenta la configurazione dei criteri dei feed di modifiche per un contenitore nel servizio Azure Cosmos DB.
ChangeFeedResponse

Una singola pagina di risposta dal feed di modifiche di Azure Cosmos DB
ChangeFeedRetentionTimeSpan
ChangeFeedStartFrom

Classe di base per la posizione in cui avviare un oggetto ChangeFeedIterator.
ClientSideMetrics
Conflict

Usare per leggere o eliminare un determinato Conflitto in base all'ID.

Vedere Conflitti per eseguire query o leggere tutti i conflitti.
ConflictResponse
Conflicts

Usare per eseguire query o leggere tutti i conflitti.

Vedere Conflitto per leggere o eliminare un di conflitto specificato in base all'ID.
Container

Operazioni per la lettura, la sostituzione o l'eliminazione di un contenitore specifico in base all'ID.

Vedere contenitori per la creazione di nuovi contenitori e la lettura/esecuzione di query su tutti i contenitori; usare .containers.

Nota: tutte queste operazioni effettuano chiamate a un budget fisso. È consigliabile progettare il sistema in modo che queste chiamate scalano in modo secondario con l'applicazione. Ad esempio, non chiamare container(id).read() prima di ogni singola chiamata item.read(), per assicurarsi che il contenitore esista; eseguire questa operazione una volta all'avvio dell'applicazione.
ContainerResponse

Oggetto risposta per le operazioni del contenitore
Containers

Operazioni per la creazione di nuovi contenitori e la lettura/esecuzione di query su tutti i contenitori

Per la lettura, la sostituzione o l'eliminazione di un contenitore esistente, vedere Container; usare .container(id).

Nota: tutte queste operazioni effettuano chiamate a un budget fisso. È consigliabile progettare il sistema in modo che queste chiamate scalano in modo secondario con l'applicazione. Ad esempio, non chiamare containers.readAll() prima di ogni singola chiamata item.read(), per assicurarsi che il contenitore esista; eseguire questa operazione una volta all'avvio dell'applicazione.
CosmosClient

Fornisce una rappresentazione logica lato client dell'account del database Azure Cosmos DB. Questo client viene usato per configurare ed eseguire richieste nel servizio di database di Azure Cosmos DB.

Esempio

Creare un'istanza di un client e creare un nuovo database

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

Esempio

Creare un'istanza di un client con criteri di connessione personalizzati

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});
CosmosDiagnostics
  • Si tratta di un tipo di diagnostica Cosmos che contiene le informazioni di diagnostica raccolte durante le operazioni client. Ie. Item.read(), Container.create(). Ha tre membri :
  1. clientSideRequestStatistics membro contiene informazioni di diagnostica aggregate, tra cui :
  • ricerche di metadati. In questo caso, tutte le richieste del server, a parte la risorsa finale desiderata, vengono considerate chiamate ai metadati. ad esempio per item.read(id), se il client effettua una chiamata al server per individuare gli endpoint, verrebbe considerato come chiamata ai metadati.
  • Tentativi
  • endpoint contattati.
  • request, response payload stats.request, response payload stats.
  • gatewayStatistics: informazioni corrispondenti all'operazione principale. Ad esempio durante Item.read(), il client potrebbe eseguire molte operazioni, ad esempio la ricerca dei metadati e così via, ma gatewayStatistics rappresenta le informazioni di diagnostica per l'operazione di lettura effettiva.
  1. diagnosticNode: struttura simile a una struttura che acquisisce informazioni di diagnostica dettagliate. Per impostazione predefinita, è disabilitata e deve essere usata solo per il debug in ambienti non di produzione. Il tipo di dettagli acquisiti in diagnosticNode è controllato da CosmosDbDiagnosticLevel.
  • CosmosDbDiagnosticLevel.info: valore predefinito. In questo livello vengono acquisiti solo clientSideRequestStatistics. È destinato agli ambienti di produzione.
  • CosmosDbDiagnosticLevel.debug - Acquisisce diagnosticNode e clientConfig. Non vengono acquisiti payload di richiesta e risposta. Non deve essere usato nell'ambiente di produzione.
  • CosmosDbDiagnosticLevel.debug-unsafe: oltre ai dati acquisiti in CosmosDbDiagnosticLevel.debug, acquisisce anche payload di richiesta e risposta. Non deve essere usato nell'ambiente di produzione.
  1. clientConfig: acquisisce informazioni relative alla configurazione del client durante l'inizializzazione.
Database

Operazioni per la lettura o l'eliminazione di un database esistente.

Vedere Database per la creazione di nuovi database e la lettura/esecuzione di query su tutti i database; usare client.databases.

Nota: tutte queste operazioni effettuano chiamate a un budget fisso. È consigliabile progettare il sistema in modo che queste chiamate scalano in modo secondario con l'applicazione. Ad esempio, non chiamare database.read() prima di ogni singola chiamata item.read(), per assicurarsi che il database esista; eseguire questa operazione una volta all'avvio dell'applicazione.
DatabaseAccount

Rappresenta un databaseAccount nel servizio di database Azure Cosmos DB.
DatabaseResponse

Oggetto risposta per le operazioni di database
Databases

Operazioni per la creazione di nuovi database e la lettura/esecuzione di query su tutti i database

Vedere database per la lettura o l'eliminazione di un database esistente. usare client.database(id).

Nota: tutte queste operazioni effettuano chiamate a un budget fisso. È consigliabile progettare il sistema in modo che queste chiamate scalano in modo secondario con l'applicazione. Ad esempio, non chiamare databases.readAll() prima di ogni singola chiamata item.read(), per assicurarsi che il database esista; eseguire questa operazione una volta all'avvio dell'applicazione.
ErrorResponse
FeedRange

Specifica un intervallo di feed per l'avanzamento delle modifiche.
FeedResponse
Item

Utilizzato per eseguire operazioni su un elemento specifico.

Vedere elementi per le operazioni su tutti gli elementi; vedere container.items.
ItemResponse
Items

Operazioni per la creazione di nuovi elementi e la lettura/esecuzione di query su tutti gli elementi

Vedere elemento per la lettura, la sostituzione o l'eliminazione di un contenitore esistente; usare .item(id).
Offer

Usare per leggere o sostituire un'offerta di esistente in base all'ID.

Vedere Offerte per eseguire query o leggere tutte le offerte.
OfferResponse
Offers

Usare per eseguire query o leggere tutte le offerte.

Vedere Offerta per leggere o sostituire un offerta di esistente in base all'ID.
PartitionKeyBuilder

Classe Builder per la compilazione di PartitionKey.
Permission

Usare per leggere, sostituire o eliminare un determinato autorizzazione in base all'ID.

Vedere Autorizzazioni per creare, upsert, eseguire query o leggere tutte le autorizzazioni.
PermissionResponse
Permissions

Usare per creare, sostituire, eseguire query e leggere tutte le autorizzazioni.

Vedere Autorizzazione per leggere, sostituire o eliminare un'autorizzazione specifica in base all'ID.
QueryIterator

Rappresenta un oggetto QueryIterator, un'implementazione di feed o risposta di query che consente l'attraversamento e l'iterazione della risposta nel servizio di database di Azure Cosmos DB.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure

Operazioni per la lettura, la sostituzione, l'eliminazione o l'esecuzione di una stored procedure specifica esistente in base all'ID.

Per le operazioni da creare, leggere tutte o eseguire query su stored procedure,
StoredProcedureResponse
StoredProcedures

Operazioni per la creazione, l'upserting o la lettura/esecuzione di query su tutte le stored procedure.

Per le operazioni di lettura, sostituzione, eliminazione o esecuzione di una stored procedure specifica esistente in base all'ID, vedere container.storedProcedure().
TimeoutError
Trigger

Operazioni per leggere, sostituire o eliminare un trigger .

Usare container.triggers per creare, upsert, eseguire query o leggere tutto.
TriggerResponse
Triggers

Operazioni per creare, upsert, eseguire query e leggere tutti i trigger.

Usare container.triggers per leggere, sostituire o eliminare un trigger .
User

Usato per leggere, sostituire ed eliminare utenti.

Inoltre, è possibile accedere alle autorizzazioni per un determinato utente tramite user.permission e user.permissions.

Vedere Utenti per creare, upsert, eseguire query o leggere tutto.
UserDefinedFunction

Usato per leggere, sostituire o eliminare una funzione definita dall'utente specificata in base all'ID.

Vedere userDefinedFunction per creare, upsert, eseguire query e leggere tutte le funzioni definite dall'utente.
UserDefinedFunctionResponse
UserDefinedFunctions

Usato per creare, upsert, eseguire query o leggere tutte le funzioni definite dall'utente.

Vedere UserDefinedFunction per leggere, sostituire o eliminare una determinata funzione definita dall'utente in base all'ID.
UserResponse
Users

Usato per creare, upsert, eseguire query e leggere tutti gli utenti.

Vedere utente per leggere, sostituire o eliminare un utente specifico in base all'ID.

Interfacce

@azure/cosmos.Index
Agent
BulkOptions

Oggetto Options utilizzato per modificare l'esecuzione bulk. continueOnError (valore predefinito: false): continua l'esecuzione bulk quando un'operazione non riesce ** NOTA QUESTA IMPOSTAZIONE PREDEFINITA VERRÀ IMPOSTATA SU TRUE NELLA VERSIONE 4.0
ChangeFeedIteratorOptions

Specifica le opzioni per il feed di modifiche

Se nessuna di queste opzioni è impostata, inizierà a leggere le modifiche da ora per l'intero contenitore.
ChangeFeedOptions

Specifica le opzioni per il feed di modifiche

Alcune di queste opzioni controllano dove e quando iniziare la lettura dal feed di modifiche. L'ordine di precedenza è:

  • continuazione
  • startTime
  • startFromBeginning

Se nessuna di queste opzioni è impostata, inizierà a leggere le modifiche dalla prima chiamata ChangeFeedIterator.fetchNext().
ChangeFeedPullModelIterator

Usare Items.getChangeFeedIterator() per restituire un iteratore in grado di scorrere tutte le modifiche per una chiave di partizione, un intervallo di feed o un intero contenitore.
CompositePath

Rappresenta un percorso composito nei criteri di indicizzazione.
ComputedProperty
ConflictDefinition
ConflictResolutionPolicy

Rappresenta la configurazione dei criteri di risoluzione dei conflitti per specificare come risolvere i conflitti in caso di scritture da aree diverse genera conflitti nei documenti nella raccolta nel servizio Azure Cosmos DB.
ConnectionPolicy

Rappresenta i criteri di connessione associati a cosmosClient nel servizio di database Azure Cosmos DB.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode

Rappresenta un albero come struttura per l'acquisizione di informazioni di diagnostica.
ErrorBody
FailedRequestAttemptDiagnostic

Questo tipo acquisisce informazioni di diagnostica relative a una richiesta non riuscita all'API server.
FeedOptions

Opzioni del feed e metodi di query.
FullTextIndex

Rappresenta un indice full-text nei criteri di indicizzazione.
FullTextPath

Rappresenta un percorso full-text da indicizzare nel servizio Azure Cosmos DB.
FullTextPolicy

Rappresenta un criterio full-text per una raccolta nel servizio Azure Cosmos DB.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition

Gli elementi in Cosmos DB sono semplicemente oggetti JSON. La maggior parte delle operazioni item consente all'utente di fornire un tipo personalizzato che estende l'elemento ItemDefinition molto semplice.

Non è possibile usare chiavi riservate. È possibile visualizzare l'elenco delle chiavi riservate in <xref:ItemBody>
JSONArray
JSONObject
Location

Usato per specificare i percorsi disponibili, read è indice 1 e scrittura è indice 0.
MetadataLookUpDiagnostic

Questo tipo contiene informazioni di diagnostica relative a una singola richiesta di metadati al server.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions

Opzioni che possono essere specificate per un'emissione richiesta ai server Azure Cosmos DB.=
Resource
RetryOptions

Rappresenta i criteri di ripetizione dei tentativi associati alle richieste limitate nel servizio di database di Azure Cosmos DB.
SharedOptions

Opzioni che possono essere specificate per un'emissione richiesta ai server Azure Cosmos DB.=
SpatialIndex
SqlParameter

Rappresenta un parametro in una query SQL con parametri, specificato in SqlQuerySpec
SqlQuerySpec

Rappresenta una query SQL nel servizio Azure Cosmos DB.

Le query con input devono essere parametrizzate per proteggere da SQL injection.

Esempio

Query SQL con parametri

const query: SqlQuerySpec = {
  query: "SELECT * FROM Families f where f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Wakefield"}
  ]
};
StoredProcedureDefinition
TriggerDefinition
UniqueKey

Interfaccia per una singola chiave univoca passata come parte di UniqueKeyPolicy
UniqueKeyPolicy

Interfaccia per l'impostazione di chiavi univoche nella creazione del contenitore
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition
VectorEmbedding

Rappresenta un incorporamento vettoriale. Per definire un campo vettoriale nei documenti viene usato un incorporamento vettoriale.
VectorEmbeddingPolicy

Rappresenta la configurazione dei criteri per gli incorporamenti vettoriali nel servizio Azure Cosmos DB.
VectorIndex

Rappresenta un indice vettoriale nel servizio Azure Cosmos DB. Un indice vettoriale viene usato per indicizzare i campi vettoriali nei documenti.

Alias tipo

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic

Questo tipo contiene informazioni correlate all'inizializzazione di CosmosClient
ClientSideRequestStatistics

Si tratta di un tipo di raccolta per tutte le informazioni di diagnostica lato client.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics

Questo tipo contiene informazioni di diagnostica relative a tutte le richieste di metadati al server durante un'operazione client cosmosDB.
NonePartitionKeyType

L'oggetto restituito rappresenta un valore della chiave di partizione che consente di creare e accedere agli elementi senza un valore per la chiave di partizione
NullPartitionKeyType

L'oggetto restituito rappresenta un valore della chiave di partizione che consente di creare e accedere agli elementi con un valore Null per la chiave di partizione.
Operation
OperationInput
OperationWithItem
PartitionKey

PartitionKey di un contenitore.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue

Valore della chiave di partizione primitiva.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics

Questo tipo acquisisce informazioni di diagnostica relative ai tentativi durante un'operazione client di CosmosDB.
TokenProvider
UpsertOperation

Enumerazioni

ChangeFeedMode
ConflictResolutionMode
ConnectionMode

Determina il comportamento della connessione di CosmosClient. Si noti che attualmente è supportata solo la modalità gateway.
ConsistencyLevel

Rappresenta i livelli di coerenza supportati per le operazioni client di Azure Cosmos DB.
L'elemento ConsistencyLevel richiesto deve corrispondere o essere più debole di quello di cui è stato effettuato il provisioning per l'account del database. Livelli di coerenza.

I livelli di coerenza in base all'ordine di forza sono Strong, BoundedStaleness, Session, Consistent Prefix e Eventual.

Vedere https://aka.ms/cosmos-consistency per una documentazione più dettagliata sui livelli di coerenza.
CosmosDbDiagnosticLevel

Livello di diagnostica di Cosmos DB
DataType

Definisce un tipo di dati di destinazione di una specifica del percorso di indice nel servizio Azure Cosmos DB.
GeospatialType
IndexKind

Specifica i tipi di indice supportati.
IndexingMode

Specifica le modalità di indicizzazione supportate.
MetadataLookUpType

Si tratta dell'enumerazione possibile per il tipo di ricerca dei metadati.
PartitionKeyDefinitionVersion

Versione della definizione partitionkey
PartitionKeyKind

Tipo di PartitionKey, ad esempio Hash, MultiHash
PermissionMode

Enumerazione per i valori della modalità di autorizzazione.
PriorityLevel

Rappresenta il livello di priorità associato a ogni richiesta client di Azure Cosmos DB.
Le richieste con priorità bassa vengono sempre limitate prima di qualsiasi richiesta con priorità alta.

Per impostazione predefinita, tutte le richieste vengono considerate come richieste con priorità elevata.

Per informazioni più dettagliate sulla limitazione basata sulla priorità, vedere https://aka.ms/CosmosDB/PriorityBasedExecution.
SpatialType
TriggerOperation

Enumerazione per i valori dell'operazione trigger. specifica le operazioni su cui deve essere eseguito un trigger.
TriggerType

Enumerazione per i valori del tipo di trigger. Specifica il tipo di trigger.
UserDefinedFunctionType

Enumerazione per i valori di tipo udf. Specifica i tipi di funzioni definite dall'utente.
VectorEmbeddingDataType

Rappresenta il tipo di dati del vettore.
VectorEmbeddingDistanceFunction

Rappresenta la funzione distance da utilizzare per il calcolo della distanza tra vettori.
VectorIndexType

Rappresenta il tipo di indice del vettore.

Funzioni

createAuthorizationSasToken(string, SasTokenProperties)

Interno sperimentale Genera solo il payload che rappresenta la configurazione dell'autorizzazione per il token di firma di accesso condiviso.

Dettagli funzione

createAuthorizationSasToken(string, SasTokenProperties)

Interno sperimentale Genera solo il payload che rappresenta la configurazione dell'autorizzazione per il token di firma di accesso condiviso.

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

Parametri

masterKey

string

sasTokenProperties
SasTokenProperties

Restituisce

Promise<string>