StoredProcedures | @azure/cosmos

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

Hierarchy

StoredProcedures

Index

Properties

container

Methods

Properties

container

container: Container

The parent Container.

Methods

create

create(body: StoredProcedureDefinition, options?: RequestOptions): Promise<StoredProcedureResponse>

- Defined in client/StoredProcedure/StoredProcedures.ts:93
Create a StoredProcedure.

Azure Cosmos DB allows stored procedures to be executed in the storage tier, directly against an item container. The script gets executed under ACID transactions on the primary storage partition of the specified container. For additional details, refer to the server-side JavaScript API documentation.

Parameters
- body: StoredProcedureDefinition
- Optional options: RequestOptions
Returns Promise<StoredProcedureResponse>

query

query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>
query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

- Defined in client/StoredProcedure/StoredProcedures.ts:39
Query all Stored Procedures.
example
Read all stored procedures to array.
```
const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM root r WHERE r.id = @sproc",
  parameters: [
    {name: "@sproc", value: "Todo"}
  ]
};
const {body: sprocList} = await containers.storedProcedures.query(querySpec).toArray();
```
Parameters
- query: SqlQuerySpec
  
  Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
- Optional options: FeedOptions
Returns QueryIterator<any>
- Defined in client/StoredProcedure/StoredProcedures.ts:55
Query all Stored Procedures.
example
Read all stored procedures to array.
```
const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM root r WHERE r.id = @sproc",
  parameters: [
    {name: "@sproc", value: "Todo"}
  ]
};
const {body: sprocList} = await containers.storedProcedures.query(querySpec).toArray();
```
Type parameters
- T
Parameters
- query: SqlQuerySpec
  
  Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
- Optional options: FeedOptions
Returns QueryIterator<T>

readAll

readAll(options?: FeedOptions): QueryIterator<StoredProcedureDefinition & Resource>

- Defined in client/StoredProcedure/StoredProcedures.ts:80
Read all stored procedures.
example
Read all stored procedures to array.
```
const {body: sprocList} = await containers.storedProcedures.readAll().toArray();
```
Parameters
- Optional options: FeedOptions
Returns QueryIterator<StoredProcedureDefinition & Resource>

Hierarchy

Index

Properties

Methods

Properties

container

Methods

create

Parameters

body: StoredProcedureDefinition

Optional options: RequestOptions

Returns Promise<StoredProcedureResponse>

query

Parameters

query: SqlQuerySpec

Optional options: FeedOptions

Returns QueryIterator<any>

Type parameters

T

Parameters

query: SqlQuerySpec

Optional options: FeedOptions

Returns QueryIterator<T>

readAll

Parameters

Optional options: FeedOptions

Returns QueryIterator<StoredProcedureDefinition & Resource>