@azure/cosmos package

Classes

ChangeFeedIterator

Provides iterator for change feed. Use Items.readChangeFeed() to get an instance of the iterator.

ChangeFeedResponse

A single response page from the Azure Cosmos DB Change Feed

ClientSideMetrics
Conflict

Use to read or delete a given <xref:Conflict> by id.

ConflictResponse
Conflicts

Use to query or read all conflicts.

Container

Operations for reading, replacing, or deleting a specific, existing container by id.

ContainerResponse

Response object for Container operations

Containers

Operations for creating new containers, and reading/querying all containers

CosmosClient

Provides a client-side logical representation of the Azure Cosmos DB database account. This client is used to configure and execute requests in the Azure Cosmos DB database service.

Database

Operations for reading or deleting an existing database.

DatabaseAccount

Represents a DatabaseAccount in the Azure Cosmos DB database service.

DatabaseResponse

Response object for Database operations

Databases

Operations for creating new databases, and reading/querying all databases

FeedResponse
Item

Used to perform operations on a specific item.

ItemResponse
Items

Operations for creating new items, and reading/querying all items

Offer

Use to read or replace an existing <xref:Offer> by id.

OfferResponse
Offers

Use to query or read all Offers.

Permission

Use to read, replace, or delete a given <xref:Permission> by id.

PermissionResponse
Permissions

Use to create, replace, query, and read all Permissions.

QueryIterator

Represents a QueryIterator Object, an implementation of feed or query response that enables traversal and iterating over the response in the Azure Cosmos DB database service.

QueryMetrics
QueryPreparationTimes
ResourceResponse
RuntimeExecutionTimes
Scripts
StoredProcedure

Operations for reading, replacing, deleting, or executing a specific, existing stored procedure by id. For operations to create, upsert, read all, or query Stored Procedures,

StoredProcedureResponse
StoredProcedures

Operations for creating, upserting, or reading/querying all Stored Procedures. For operations to read, replace, delete, or execute a specific, existing stored procedure by id, see container.storedProcedure().

Trigger

Operations to read, replace, or delete a <xref:Trigger>. Use container.triggers to create, upsert, query, or read all.

TriggerResponse
Triggers

Operations to create, upsert, query, and read all triggers. Use container.triggers to read, replace, or delete a <xref:Trigger>.

User

Used to read, replace, and delete Users. Additionally, you can access the permissions for a given user via user.permission and user.permissions.

UserDefinedFunction

Used to read, replace, or delete a specified User Definied Function by id.

UserDefinedFunctionResponse
UserDefinedFunctions

Used to create, upsert, query, or read all User Defined Functions.

UserResponse
Users

Used to create, upsert, query, and read all users.

Interfaces

Agent
ChangeFeedOptions

Specifies options for the change feed Some of these options control where and when to start reading from the change feed. The order of precedence is:

  • continuation
  • startTime
  • startFromBeginning

If none of those options are set, it will start reading changes from the first ChangeFeedIterator.fetchNext() call.

ConflictDefinition
ConflictResolutionPolicy

Represents the conflict resolution policy configuration for specifying how to resolve conflicts in case writes from different regions result in conflicts on documents in the collection in the Azure Cosmos DB service.

ConnectionPolicy

Represents the Connection policy associated with a CosmosClient in the Azure Cosmos DB database service.

ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CosmosHeaders_2
DatabaseDefinition
DatabaseRequest
ErrorBody
ErrorResponse
FeedOptions

The feed options and query methods.

IndexedPath
IndexingPolicy
ItemDefinition

Items in Cosmos DB are simply JSON objects. Most of the Item operations allow for your to provide your own type that extends the very simple ItemDefinition. You cannot use any reserved keys. You can see the reserved key list in <xref:ItemBody>

JSONArray
JSONObject
Location

Used to specify the locations that are available, read is index 1 and write is index 0.

OfferDefinition
PartitionKeyDefinition
PermissionBody
PermissionDefinition
RequestOptions

Options that can be specified for a requested issued to the Azure Cosmos DB servers.=

Resource
RetryOptions

Represents the Retry policy assocated with throttled requests in the Azure Cosmos DB database service.

SharedOptions

Options that can be specified for a requested issued to the Azure Cosmos DB servers.=

SqlParameter

Represents a parameter in a Parameterized SQL query, specified in <xref:SqlQuerySpec>

SqlQuerySpec

Represents a SQL query in the Azure Cosmos DB service. Queries with inputs should be parameterized to protect against SQL injection.

StoredProcedureDefinition
TriggerDefinition
UniqueKey

Interface for a single unique key passed as part of UniqueKeyPolicy

UniqueKeyPolicy

Interface for setting unique keys on container creation

UserDefinedFunctionDefinition
UserDefinition

Type Aliases

JSONValue
PartitionKey
SubStatusCode
TokenProvider

Enums

ConflictResolutionMode
ConnectionMode

Determines the connection behavior of the CosmosClient. Note, we currently only support Gateway Mode.

ConsistencyLevel

Represents the consistency levels supported for Azure Cosmos DB client operations.
The requested ConsistencyLevel must match or be weaker than that provisioned for the database account. Consistency levels. Consistency levels by order of strength are Strong, BoundedStaleness, Session, Consistent Prefix, and Eventual.

See https://aka.ms/cosmos-consistency for more detailed documentation on Consistency Levels.

DataType

Defines a target data type of an index path specification in the Azure Cosmos DB service.

IndexKind

Specifies the supported Index types.

IndexingMode

Lazy

PermissionMode

Enum for permission mode values.

TriggerOperation

Enum for trigger operation values. specifies the operations on which a trigger should be executed.

TriggerType

Enum for trigger type values. Specifies the type of the trigger.

UserDefinedFunctionType

Enum for udf type values. Specifies the types of user defined functions.