@azure/cosmos package

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

A single response page from the Azure Cosmos DB Change Feed

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.

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

Use to query or read all conflicts.

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

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

Operations for reading or deleting an existing database.

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

Used to perform operations on a specific item.

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

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

Use to query or read all Offers.

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

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

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,

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().

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

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

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

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

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

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

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

Represents a DatabaseAccount in the Azure Cosmos DB database service.

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

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

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.executeNext() call.

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.

Response object for Container operations

Interface for a single unique key passed as part of UniqueKeyPolicy

Interface for setting unique keys on container creation

Response object for Database operations

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>

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

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

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

The feed options and query methods.

Options associated with upload media.

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

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

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.

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

Specifies the supported Index types.

Lazy

Enum for media read mode values.

Enum for permission mode values.

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

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

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