مشاركة عبر

UserDefinedFunction class

الحزمة:
@azure/cosmos

يستخدم لقراءة أو استبدال أو حذف دالة محددة محددة من قبل المستخدم المحدد بواسطة المعرف.

راجع UserDefinedFunction لإنشاء كافة الدالات المعرفة من قبل المستخدم وتكبيرها والاستعلام فيها.

الخصائص

container
id
url

إرجاع URL مرجع إلى المورد. يستخدم للارتباط في الأذونات.

الأساليب

delete(RequestOptions)

احذف <xref:UserDefined>المحدد .

مثال

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.userDefinedFunction("<udf-id>").delete();
read(RequestOptions)

اقرأ UserDefinedFunctionDefinition المحدد UserDefinedFunction.

مثال

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: udf } = await container.scripts.userDefinedFunction("<udf-id>").read();
replace(UserDefinedFunctionDefinition, RequestOptions)

استبدل userDefinedFunction المحدد UserDefinedFunctionDefinition المحدد.

مثال

import { CosmosClient, UserDefinedFunctionDefinition } 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 udfDefinition: UserDefinedFunctionDefinition = {
  id: "sample udf",
  body: "function () { const x = 10; }",
};
await container.scripts.userDefinedFunctions.create(udfDefinition);

udfDefinition.body = "function () { const x = 20; }";
const { resource: replacedUdf } = await container.scripts
  .userDefinedFunction(udfDefinition.id)
  .replace(udfDefinition);

تفاصيل الخاصية

container 

container: Container

قيمة الخاصية

Container

id 

id: string

قيمة الخاصية

string

url

إرجاع URL مرجع إلى المورد. يستخدم للارتباط في الأذونات.

string url

قيمة الخاصية

string

تفاصيل الأسلوب

delete(RequestOptions)

احذف <xref:UserDefined>المحدد .

مثال

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.userDefinedFunction("<udf-id>").delete();

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

المعلمات

options
RequestOptions

المرتجعات

Promise<UserDefinedFunctionResponse>

read(RequestOptions)

اقرأ UserDefinedFunctionDefinition المحدد UserDefinedFunction.

مثال

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: udf } = await container.scripts.userDefinedFunction("<udf-id>").read();

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

المعلمات

options
RequestOptions

المرتجعات

Promise<UserDefinedFunctionResponse>

replace(UserDefinedFunctionDefinition, RequestOptions)

استبدل userDefinedFunction المحدد UserDefinedFunctionDefinition المحدد.

مثال

import { CosmosClient, UserDefinedFunctionDefinition } 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 udfDefinition: UserDefinedFunctionDefinition = {
  id: "sample udf",
  body: "function () { const x = 10; }",
};
await container.scripts.userDefinedFunctions.create(udfDefinition);

udfDefinition.body = "function () { const x = 20; }";
const { resource: replacedUdf } = await container.scripts
  .userDefinedFunction(udfDefinition.id)
  .replace(udfDefinition);

function replace(body: UserDefinedFunctionDefinition, options?: RequestOptions): Promise<UserDefinedFunctionResponse>

المعلمات

body
UserDefinedFunctionDefinition
options
RequestOptions

المرتجعات

Promise<UserDefinedFunctionResponse>