مشاركة عبر

UserDefinedFunctions class

الحزمة:
@azure/cosmos

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

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

الخصائص

container

الأساليب

create(UserDefinedFunctionDefinition, RequestOptions)

إنشاء UserDefinedFunction.

يدعم Azure Cosmos DB JavaScript UDFs التي يمكن استخدامها داخل الاستعلامات والإجراءات المخزنة والمشغلات.

للحصول على تفاصيل إضافية، راجع وثائق واجهة برمجة تطبيقات JavaScript من جانب الخادم.

المثال

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

const { resource: udf } = await container.scripts.userDefinedFunctions.create(udfDefinition);
query(SqlQuerySpec, FeedOptions)

الاستعلام عن كافة الدالات المعرفة من قبل المستخدم.
query<T>(SqlQuerySpec, 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 querySpec = {
  query: "SELECT * FROM root r WHERE r.id=@id",
  parameters: [
    {
      name: "@id",
      value: "<udf-id>",
    },
  ],
};
const { resources: results } = await container.scripts.userDefinedFunctions
  .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: udfList } = await container.scripts.userDefinedFunctions.readAll().fetchAll();

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

container 

container: Container

قيمة الخاصية

Container

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

create(UserDefinedFunctionDefinition, RequestOptions)

إنشاء UserDefinedFunction.

يدعم Azure Cosmos DB JavaScript UDFs التي يمكن استخدامها داخل الاستعلامات والإجراءات المخزنة والمشغلات.

للحصول على تفاصيل إضافية، راجع وثائق واجهة برمجة تطبيقات JavaScript من جانب الخادم.

المثال

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

const { resource: udf } = await container.scripts.userDefinedFunctions.create(udfDefinition);

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

المعلمات

body
UserDefinedFunctionDefinition
options
RequestOptions

المرتجعات

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

الاستعلام عن كافة الدالات المعرفة من قبل المستخدم.

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

المعلمات

query
SqlQuerySpec

تكوين الاستعلام للعملية. راجع SqlQuerySpec لمزيد من المعلومات حول كيفية تكوين استعلام.

options
FeedOptions

المرتجعات

QueryIterator<any>

query<T>(SqlQuerySpec, 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 querySpec = {
  query: "SELECT * FROM root r WHERE r.id=@id",
  parameters: [
    {
      name: "@id",
      value: "<udf-id>",
    },
  ],
};
const { resources: results } = await container.scripts.userDefinedFunctions
  .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: udfList } = await container.scripts.userDefinedFunctions.readAll().fetchAll();

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

المعلمات

options
FeedOptions

المرتجعات

QueryIterator<UserDefinedFunctionDefinition & Resource>