次の方法で共有

UserDefinedFunctions class

  • リファレンス
パッケージ:
@azure/cosmos

すべてのユーザー定義関数の作成、アップサート、クエリ、読み取りに使用されます。

特定 ユーザー定義関数を id で読み取り、置換、または削除するには、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>