مشاركة عبر

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)

اقرأ StoredProcedureDefinitionStoredProcedure المحدد.

مثال

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[]

صفيف المعلمات لتمريرها كوسيطات إلى StoredProcedure المحددة .

options
RequestOptions

خيارات إضافية، مثل مفتاح القسم لاستدعاء StoredProcedure. *

المرتجعات

Promise<ResourceResponse<T>>

read(RequestOptions)

اقرأ StoredProcedureDefinitionStoredProcedure المحدد.

مثال

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>