StoredProcedures class

套件:

@azure/cosmos

建立、更新插入或讀取/查詢所有預存程序的作業。

如需依識別碼讀取、取代、刪除或執行特定現有預存程式的作業，請參閱 container.storedProcedure()。

屬性

container

方法

create(StoredProcedureDefinition, RequestOptions)	建立 StoredProcedure。 Azure Cosmos DB 可讓預存程式直接在儲存層中針對專案容器執行。 腳本會在指定容器的主要記憶體分割區 ACID 交易下執行。 如需其他詳細數據，請參閱伺服器端 JavaScript API 檔。 範例 import { CosmosClient, StoredProcedureDefinition } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); const { database } = await client.databases.createIfNotExists({ id: "Test Database" }); const { container } = await database.containers.createIfNotExists({ id: "Test Container" }); const sprocDefinition: StoredProcedureDefinition = { id: "sample sproc", body: "function () { const x = 10; }", }; const { resource: sproc } = await container.scripts.storedProcedures.create(sprocDefinition);
query(SqlQuerySpec, FeedOptions)	查詢所有預存程式。 範例 將所有預存程式讀取至陣列。 import { CosmosClient, SqlQuerySpec } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); const { database } = await client.databases.createIfNotExists({ id: "Test Database" }); const { container } = await database.containers.createIfNotExists({ id: "Test Container" }); const querySpec: SqlQuerySpec = { query: `SELECT * FROM root r WHERE r.id = @sproc`, parameters: [{ name: "@sproc", value: "Todo" }], }; const { resources: storedProceduresList } = await container.scripts.storedProcedures .query(querySpec) .fetchAll();
query<T>(SqlQuerySpec, FeedOptions)	查詢所有預存程式。 範例 將所有預存程式讀取至陣列。 import { CosmosClient, SqlQuerySpec } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); const { database } = await client.databases.createIfNotExists({ id: "Test Database" }); const { container } = await database.containers.createIfNotExists({ id: "Test Container" }); const querySpec: SqlQuerySpec = { query: `SELECT * FROM root r WHERE r.id = @sproc`, parameters: [{ name: "@sproc", value: "Todo" }], }; const { resources: storedProceduresList } = await container.scripts.storedProcedures .query(querySpec) .fetchAll();
readAll(FeedOptions)	讀取所有預存程式。 範例 將所有預存程式讀取至陣列。 import { CosmosClient } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); const { database } = await client.databases.createIfNotExists({ id: "Test Database" }); const { container } = await database.containers.createIfNotExists({ id: "Test Container" }); const { resources: storedProceduresList } = await container.scripts.storedProcedures .readAll() .fetchAll();

屬性詳細資料

container

container: Container

屬性值

Container

方法詳細資料

create(StoredProcedureDefinition, RequestOptions)

建立 StoredProcedure。

Azure Cosmos DB 可讓預存程式直接在儲存層中針對專案容器執行。 腳本會在指定容器的主要記憶體分割區 ACID 交易下執行。 如需其他詳細數據，請參閱伺服器端 JavaScript API 檔。

範例

import { CosmosClient, StoredProcedureDefinition } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const sprocDefinition: StoredProcedureDefinition = {
  id: "sample sproc",
  body: "function () { const x = 10; }",
};

const { resource: sproc } = await container.scripts.storedProcedures.create(sprocDefinition);

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

參數

body

StoredProcedureDefinition

options

RequestOptions

傳回

Promise<StoredProcedureResponse>

query(SqlQuerySpec, FeedOptions)

查詢所有預存程式。

範例

將所有預存程式讀取至陣列。

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @sproc`,
  parameters: [{ name: "@sproc", value: "Todo" }],
};
const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .query(querySpec)
  .fetchAll();

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

參數

query

SqlQuerySpec

作業的查詢組態。 如需如何設定查詢的詳細資訊，請參閱 SqlQuerySpec。

options

FeedOptions

傳回

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

查詢所有預存程式。

範例

將所有預存程式讀取至陣列。

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @sproc`,
  parameters: [{ name: "@sproc", value: "Todo" }],
};
const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .query(querySpec)
  .fetchAll();

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

參數

query

SqlQuerySpec

作業的查詢組態。 如需如何設定查詢的詳細資訊，請參閱 SqlQuerySpec。

options

FeedOptions

傳回

QueryIterator<T>

readAll(FeedOptions)

讀取所有預存程式。

範例

將所有預存程式讀取至陣列。

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .readAll()
  .fetchAll();

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

參數

options

FeedOptions

傳回

QueryIterator<StoredProcedureDefinition & Resource>