Class StoredProcedures

Readonlycontainer

create

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

• 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
  • Optionaloptions: RequestOptions

  Returns Promise<StoredProcedureResponse>

query

• query(query, options?): QueryIterator<any>

• Query all Stored Procedures.

  Parameters

  • query: SqlQuerySpec

    Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
  • Optionaloptions: FeedOptions

  Returns QueryIterator<any>

  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).fetchAll();
  Copy

• query<T>(query, options?): QueryIterator<T>

• Query all Stored Procedures.

  Type Parameters

  • T

  Parameters

  • query: SqlQuerySpec

    Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
  • Optionaloptions: FeedOptions

  Returns QueryIterator<T>

  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).fetchAll();
  Copy

readAll

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

• Read all stored procedures.

  Parameters

  • Optionaloptions: FeedOptions

  Returns QueryIterator<StoredProcedureDefinition & Resource>

  Example: Read all stored procedures to array.

  const {body: sprocList} = await containers.storedProcedures.readAll().fetchAll();
  Copy