StoredProcedure class

Пакет:
@azure/cosmos

Операции чтения, замены, удаления или выполнения определенной хранимой процедуры по идентификатору.

Для операций для создания, чтения всех или запроса хранимых процедур

Свойства

container
id
url

Возвращает URL-адрес ссылки для ресурса. Используется для связывания в разрешениях.

Методы

delete(RequestOptions)

Удалите указанный StoredProcedure.

Пример

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" });

await container.scripts.storedProcedure("<sproc-id>").delete();
execute<T>(PartitionKey, any[], RequestOptions)

Выполните указанный StoredProcedure.

Указанный тип T не применяется клиентом. Убедитесь, что ответ от хранимой процедуры соответствует типу T, который вы предоставляете.

Пример

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 { resource: result } = await container.scripts
  .storedProcedure("<sproc-id>")
  .execute(undefined);
read(RequestOptions)

Прочитайте StoredProcedureDefinition для заданного StoredProcedure.

Пример

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 { resource: sproc } = await container.scripts.storedProcedure("<sproc-id>").read();
replace(StoredProcedureDefinition, RequestOptions)

Замените указанный StoredProcedure указанным StoredProcedureDefinition.

Пример

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);

sproc.body = function () {
  const x = 20;
  console.log(x);
};
const { resource: replacedSproc } = await container.scripts
  .storedProcedure(sproc.id)
  .replace(sproc);

Сведения о свойстве

container 

container: Container

Значение свойства

Container

id 

id: string

Значение свойства

string

url

Возвращает URL-адрес ссылки для ресурса. Используется для связывания в разрешениях.

string url

Значение свойства

string

Сведения о методе

delete(RequestOptions)

Удалите указанный StoredProcedure.

Пример

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" });

await container.scripts.storedProcedure("<sproc-id>").delete();

function delete(options?: RequestOptions): Promise<StoredProcedureResponse>

Параметры

options
RequestOptions

Возвращаемое значение

Promise<StoredProcedureResponse>

execute<T>(PartitionKey, any[], RequestOptions)

Выполните указанный StoredProcedure.

Указанный тип T не применяется клиентом. Убедитесь, что ответ от хранимой процедуры соответствует типу T, который вы предоставляете.

Пример

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 { resource: result } = await container.scripts
  .storedProcedure("<sproc-id>")
  .execute(undefined);

function execute<T>(partitionKey: PartitionKey, params?: any[], options?: RequestOptions): Promise<ResourceResponse<T>>

Параметры

partitionKey
PartitionKey

Ключ секции, используемый при выполнении хранимой процедуры

params

any[]

Массив параметров, передаваемых в качестве аргументов в заданный хранимой.

options
RequestOptions

Дополнительные параметры, такие как ключ секции для вызова хранимой. *

Возвращаемое значение

Promise<ResourceResponse<T>>

read(RequestOptions)

Прочитайте StoredProcedureDefinition для заданного StoredProcedure.

Пример

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 { resource: sproc } = await container.scripts.storedProcedure("<sproc-id>").read();

function read(options?: RequestOptions): Promise<StoredProcedureResponse>

Параметры

options
RequestOptions

Возвращаемое значение

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Замените указанный StoredProcedure указанным StoredProcedureDefinition.

Пример

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);

sproc.body = function () {
  const x = 20;
  console.log(x);
};
const { resource: replacedSproc } = await container.scripts
  .storedProcedure(sproc.id)
  .replace(sproc);

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

Параметры

body
StoredProcedureDefinition

Указанный StoredProcedureDefinition для замены существующего определения.

options
RequestOptions

Возвращаемое значение

Promise<StoredProcedureResponse>