Compartir a través de

@azure/cosmos package

  • Referencia

Clases

AbortError

Este error se produce cuando se ha anulado una operación asincrónica. Compruebe este error probando el name que la propiedad name del error coincide con "AbortError".

Ejemplo

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

Proporciona iterador para la fuente de cambios.

Use Items.changeFeed() para obtener una instancia del iterador.
ChangeFeedIteratorResponse

Una sola página de respuesta de la fuente de cambios de Azure Cosmos DB
ChangeFeedPolicy

Representa la configuración de la directiva de fuente de cambios para un contenedor en el servicio Azure Cosmos DB.
ChangeFeedResponse

Una sola página de respuesta de la fuente de cambios de Azure Cosmos DB
ChangeFeedRetentionTimeSpan
ChangeFeedStartFrom

Clase base para dónde iniciar un ChangeFeedIterator.
ClientSideMetrics
Conflict

Use para leer o eliminar un conflicto determinado por identificador.

Consulte Conflictos para consultar o leer todos los conflictos.
ConflictResponse
Conflicts

Use para consultar o leer todos los conflictos.

Consulte Conflict para leer o eliminar un conflicto determinado por identificador.
Container

Operaciones para leer, reemplazar o eliminar un contenedor específico existente por identificador.

Consulte contenedores para crear nuevos contenedores y leer y consultar todos los contenedores; use .containers.

Nota: todas estas operaciones realizan llamadas con un presupuesto fijo. Debe diseñar el sistema de forma que estas llamadas se escalen de forma sublineal con la aplicación. Por ejemplo, no llame a container(id).read() antes de cada llamada item.read() única, para asegurarse de que el contenedor existe; Haga esto una vez en el inicio de la aplicación.
ContainerResponse

Objeto de respuesta para las operaciones de contenedor
Containers

Operaciones para crear nuevos contenedores y leer y consultar todos los contenedores

Consulte contenedor para leer, reemplazar o eliminar un contenedor existente; use .container(id).

Nota: todas estas operaciones realizan llamadas con un presupuesto fijo. Debe diseñar el sistema de forma que estas llamadas se escalen de forma sublineal con la aplicación. Por ejemplo, no llame a containers.readAll() antes de cada llamada item.read() única, para asegurarse de que el contenedor existe; Haga esto una vez en el inicio de la aplicación.
CosmosClient

Proporciona una representación lógica del lado cliente de la cuenta de base de datos de Azure Cosmos DB. Este cliente se usa para configurar y ejecutar solicitudes en el servicio de base de datos de Azure Cosmos DB.

Ejemplo

Creación de instancias de un cliente y creación de una base de datos

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

Ejemplo

Creación de instancias de un cliente con una directiva de conexión personalizada

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});
CosmosDiagnostics
  • Se trata de un tipo de diagnóstico de Cosmos que contiene información de diagnóstico recopilada durante las operaciones de cliente. Ie. Item.read(), Container.create(). Tiene tres miembros:
  1. clientSideRequestStatistics miembro contiene información de diagnóstico agregada, incluida :
  • búsquedas de metadatos. Aquí todas las solicitudes de servidor, aparte del recurso previsto final, se consideran llamadas de metadatos. Es decir, para item.read(id), si el cliente realiza una llamada de servidor para detectar puntos de conexión, se consideraría como llamada de metadatos.
  • Reintentos
  • puntos de conexión contactados.
  • estadísticas de solicitud y carga de respuesta.
  • gatewayStatistics: información correspondiente a la operación principal. Por ejemplo, durante Item.read(), el cliente puede realizar muchas operaciones, es decir, la búsqueda de metadatos etcetera, pero gatewayStatistics representa la información de diagnóstico para la operación de lectura real.
  1. diagnosticNode: es un árbol como una estructura que captura información detallada de diagnóstico. De forma predeterminada, está deshabilitado y está pensado para usarse solo para la depuración en entornos que no son de producción. El tipo de detalles capturados en diagnosticNode se controla mediante CosmosDbDiagnosticLevel.
  • CosmosDbDiagnosticLevel.info: es el valor predeterminado. En este nivel solo se captura clientSideRequestStatistics. Está diseñado para entornos de producción.
  • CosmosDbDiagnosticLevel.debug: captura diagnosticNode y clientConfig. No se capturan cargas de solicitud y respuesta. No está pensado para usarse en el entorno de producción.
  • CosmosDbDiagnosticLevel.debug-unsafe: además de los datos capturados en CosmosDbDiagnosticLevel.debug, también captura las cargas de solicitud y respuesta. No está pensado para usarse en el entorno de producción.
  1. clientConfig: captura información relacionada con cómo se configuró el cliente durante la inicialización.
Database

Operaciones para leer o eliminar una base de datos existente.

Consulte Bases de datos para crear nuevas bases de datos y leer y consultar todas las bases de datos; use client.databases.

Nota: todas estas operaciones realizan llamadas con un presupuesto fijo. Debe diseñar el sistema de forma que estas llamadas se escalen de forma sublineal con la aplicación. Por ejemplo, no llame a database.read() antes de cada llamada item.read() única, para asegurarse de que la base de datos existe; Haga esto una vez en el inicio de la aplicación.
DatabaseAccount

Representa una base de datos DatabaseAccount en el servicio de base de datos de Azure Cosmos DB.
DatabaseResponse

Objeto response para las operaciones de base de datos
Databases

Operaciones para crear nuevas bases de datos y leer o consultar todas las bases de datos

Consulte database para leer o eliminar una base de datos existente; use client.database(id).

Nota: todas estas operaciones realizan llamadas con un presupuesto fijo. Debe diseñar el sistema de forma que estas llamadas se escalen de forma sublineal con la aplicación. Por ejemplo, no llame a databases.readAll() antes de cada llamada item.read() única, para asegurarse de que la base de datos existe; Haga esto una vez en el inicio de la aplicación.
ErrorResponse
FeedRange

Especifica un intervalo de fuente para el suministro de cambios.
FeedResponse
Item

Se usa para realizar operaciones en un elemento específico.

Consulte elementos para las operaciones en todos los elementos; consulte container.items.
ItemResponse
Items

Operaciones para crear nuevos elementos y leer o consultar todos los elementos

Consulte de elementos para leer, reemplazar o eliminar un contenedor existente; use .item(id).
Offer

Use para leer o reemplazar una oferta de existente por identificador.

Consulte Ofertas para consultar o leer todas las ofertas.
OfferResponse
Offers

Use para consultar o leer todas las ofertas.

Consulte oferta para leer o reemplazar una oferta de existente por identificador.
PartitionKeyBuilder

Clase Builder para compilar PartitionKey.
Permission

Use para leer, reemplazar o eliminar un permiso determinado por identificador.

Consulte Permisos crear, upsert, consultar o leer todos los permisos.
PermissionResponse
Permissions

Use para crear, reemplazar, consultar y leer todos los permisos.

Consulte Permiso para leer, reemplazar o eliminar un permiso específico por identificador.
QueryIterator

Representa un objeto QueryIterator, una implementación de la respuesta de fuente o consulta que permite recorrer y recorrer en iteración la respuesta en el servicio de base de datos de Azure Cosmos DB.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError

Tipo de error personalizado para solicitudes de canalización con error.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure

Operaciones para leer, reemplazar, eliminar o ejecutar un procedimiento almacenado específico existente por id.

Para que las operaciones creen, lean todos o consulten procedimientos almacenados,
StoredProcedureResponse
StoredProcedures

Operaciones para crear, subir o leer y consultar todos los procedimientos almacenados.

Para que las operaciones lean, reemplacen, eliminen o ejecuten un procedimiento almacenado específico existente por identificador, consulte container.storedProcedure().
TimeoutError
Trigger

Operaciones para leer, reemplazar o eliminar un desencadenador de .

Use container.triggers para crear, upsert, consultar o leer todo.
TriggerResponse
Triggers

Operaciones para crear, upsert, consultar y leer todos los desencadenadores.

Use container.triggers para leer, reemplazar o eliminar un desencadenador de .
User

Se usa para leer, reemplazar y eliminar usuarios.

Además, puede acceder a los permisos de un usuario determinado a través de user.permission y user.permissions.

Consulte usuarios para crear, upsert, consultar o leer todo.
UserDefinedFunction

Se usa para leer, reemplazar o eliminar una función definida por el usuario especificada por identificador.

Consulte userDefinedFunction para crear, upsert, consultar y leer todas las funciones definidas por el usuario.
UserDefinedFunctionResponse
UserDefinedFunctions

Se usa para crear, upsert, consultar o leer todas las funciones definidas por el usuario.

Consulte userDefinedFunction para leer, reemplazar o eliminar una función definida por el usuario determinada por identificador.
UserResponse
Users

Se usa para crear, upsert, consultar y leer todos los usuarios.

Consulte usuario para leer, reemplazar o eliminar un usuario específico por identificador.

Interfaces

@azure/cosmos.Index
Agent
BulkOptions

Objeto options usado para modificar la ejecución masiva. continueOnError (valor predeterminado: false): continúa la ejecución masiva cuando se produce un error en una operación ** NOTE THIS WILL DEFAULT TO TRUE IN the 4.0 RELEASE
ChangeFeedIteratorOptions

Especifica las opciones de la fuente de cambios.

Si no se establece ninguna de esas opciones, comenzará a leer los cambios desde ahora para todo el contenedor.
ChangeFeedOptions

Especifica las opciones de la fuente de cambios.

Algunas de estas opciones controlan dónde y cuándo empezar a leer desde la fuente de cambios. El orden de prioridad es:

  • continuación
  • startTime
  • startFromBeginning

Si no se establece ninguna de esas opciones, comenzará a leer los cambios desde la primera llamada ChangeFeedIterator.fetchNext().
ChangeFeedPullModelIterator

Use Items.getChangeFeedIterator() para devolver un iterador que pueda iterar en todos los cambios de una clave de partición, un intervalo de fuente o un contenedor completo.
CompositePath

Representa una ruta de acceso compuesta en la directiva de indexación.
ComputedProperty
ConflictDefinition
ConflictResolutionPolicy

Representa la configuración de la directiva de resolución de conflictos para especificar cómo resolver conflictos en caso de que las escrituras de diferentes regiones produzcan conflictos en los documentos de la colección en el servicio Azure Cosmos DB.
ConnectionPolicy

Representa la directiva de conexión asociada a cosmosClient en el servicio de base de datos de Azure Cosmos DB.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode

Representa un árbol como estructura para capturar información de diagnóstico.
ErrorBody
FailedRequestAttemptDiagnostic

Este tipo captura información de diagnóstico con respecto a una solicitud errónea a la API del servidor.
FeedOptions

Las opciones de fuente y los métodos de consulta.
FullTextIndex

Representa un índice de texto completo en la directiva de indexación.
FullTextPath

Representa una ruta de acceso de texto completo que se va a indexar en el servicio Azure Cosmos DB.
FullTextPolicy

Representa una directiva de texto completo para una colección en el servicio Azure Cosmos DB.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition

Los elementos de Cosmos DB son simplemente objetos JSON. La mayoría de las operaciones Item permiten que proporcione su propio tipo que extienda el itemDefinition muy simple.

No se pueden usar claves reservadas. Puede ver la lista de claves reservadas en <xref:ItemBody>
JSONArray
JSONObject
Location

Se usa para especificar las ubicaciones disponibles, leer es el índice 1 y la escritura es el índice 0.
MetadataLookUpDiagnostic

Este tipo contiene información de diagnóstico sobre una única solicitud de metadatos al servidor.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions

Opciones que se pueden especificar para una solicitud emitida a los servidores de Azure Cosmos DB.=
Resource
RetryOptions

Representa la directiva de reintento con solicitudes limitadas en el servicio de base de datos de Azure Cosmos DB.
SharedOptions

Opciones que se pueden especificar para una solicitud emitida a los servidores de Azure Cosmos DB.=
SpatialIndex
SqlParameter

Representa un parámetro en una consulta SQL con parámetros, especificada en SqlQuerySpec
SqlQuerySpec

Representa una consulta SQL en el servicio Azure Cosmos DB.

Las consultas con entradas deben parametrizarse para protegerse frente a la inyección de CÓDIGO SQL.

Ejemplo

Consulta SQL con parámetros

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

Interfaz para una sola clave única pasada como parte de UniqueKeyPolicy
UniqueKeyPolicy

Interfaz para establecer claves únicas en la creación de contenedores
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition
VectorEmbedding

Representa una inserción de vectores. Se usa una inserción de vectores para definir un campo vectorial en los documentos.
VectorEmbeddingPolicy

Representa la configuración de directiva para las incrustaciones de vectores en el servicio Azure Cosmos DB.
VectorIndex

Representa un índice vectorial en el servicio Azure Cosmos DB. Un índice vectorial se usa para indexar campos vectoriales en los documentos.

Alias de tipos

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic

Este tipo contiene información relacionada con la inicialización de CosmosClient
ClientSideRequestStatistics

Se trata de un tipo de colección para toda la información de diagnóstico del lado cliente.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics

Este tipo contiene información de diagnóstico relacionada con todas las solicitudes de metadatos al servidor durante una operación de cliente de CosmosDB.
NonePartitionKeyType

El objeto devuelto representa un valor de clave de partición que permite crear y acceder a elementos sin un valor para la clave de partición.
NullPartitionKeyType

El objeto devuelto representa un valor de clave de partición que permite crear y acceder a elementos con un valor NULL para la clave de partición.
Operation
OperationInput
OperationWithItem
PartitionKey

PartitionKey de un contenedor.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue

Valor primitivo de clave de partición.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics

Este tipo captura información de diagnóstico con respecto al intento de reintento durante una operación de cliente de CosmosDB.
TokenProvider
UpsertOperation

Enumeraciones

ChangeFeedMode
ConflictResolutionMode
ConnectionMode

Determina el comportamiento de conexión de CosmosClient. Tenga en cuenta que actualmente solo se admite el modo de puerta de enlace.
ConsistencyLevel

Representa los niveles de coherencia admitidos para las operaciones de cliente de Azure Cosmos DB.
ConsistencyLevel solicitado debe coincidir o ser más débil que el aprovisionado para la cuenta de base de datos. Niveles de coherencia.

Los niveles de coherencia por orden de fuerza son Strong, BoundedStaleness, Session, Consistent Prefix y Eventual.

Consulte https://aka.ms/cosmos-consistency para obtener documentación más detallada sobre los niveles de coherencia.
CosmosDbDiagnosticLevel

Nivel de diagnóstico de Cosmos DB
DataType

Define un tipo de datos de destino de una especificación de ruta de acceso de índice en el servicio Azure Cosmos DB.
GeospatialType
IndexKind

Especifica los tipos de índice admitidos.
IndexingMode

Especifica los modos de indexación admitidos.
MetadataLookUpType

Esta es la enumeración del tipo de búsquedas de metadatos posibles.
PartitionKeyDefinitionVersion

PartitionKey Definition Version
PartitionKeyKind

Tipo de PartitionKey, es decir, Hash, MultiHash
PermissionMode

Enumeración para los valores del modo de permiso.
PriorityLevel

Representa el nivel de prioridad asociado a cada solicitud de cliente de Azure Cosmos DB.
Las solicitudes de prioridad baja siempre se limitan antes de cualquier solicitud de prioridad alta.

De forma predeterminada, todas las solicitudes se consideran solicitudes de prioridad alta.

Consulte https://aka.ms/CosmosDB/PriorityBasedExecution para obtener documentación más detallada sobre la limitación basada en prioridad.
SpatialType
TriggerOperation

Enumeración para valores de operación de desencadenador. especifica las operaciones en las que se debe ejecutar un desencadenador.
TriggerType

Enumeración para los valores de tipo de desencadenador. Especifica el tipo del desencadenador.
UserDefinedFunctionType

Enumeración para los valores de tipo udf. Especifica los tipos de funciones definidas por el usuario.
VectorEmbeddingDataType

Representa el tipo de datos del vector.
VectorEmbeddingDistanceFunction

Representa la función de distancia que se va a usar para el cálculo de distancia entre vectores.
VectorIndexType

Representa el tipo de índice del vector.

Funciones

createAuthorizationSasToken(string, SasTokenProperties)

Solo interno experimental Genera la carga que representa la configuración de permisos para el token sas.

Detalles de la función

createAuthorizationSasToken(string, SasTokenProperties)

Solo interno experimental Genera la carga que representa la configuración de permisos para el token sas.

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

Parámetros

masterKey

string

sasTokenProperties
SasTokenProperties

Devoluciones

Promise<string>