共用方式為

UserDefinedFunctions class

套件:
@azure/cosmos

用來建立、更新插入、查詢或讀取所有用戶定義函數。

請參閱 UserDefinedFunction，依標識符讀取、取代或刪除指定的使用者定義函數。

屬性

container

方法

create(UserDefinedFunctionDefinition, RequestOptions)

建立 UserDefinedFunction。

Azure Cosmos DB 支援 JavaScript UDF，可在查詢、預存程式和觸發程式內使用。

如需其他詳細數據，請參閱伺服器端 JavaScript API 檔。

範例

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 UDF，可在查詢、預存程式和觸發程式內使用。

如需其他詳細數據，請參閱伺服器端 JavaScript API 檔。

範例

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>