Bagikan melalui

UserDefinedFunction class

Paket:
@azure/cosmos

Digunakan untuk membaca, mengganti, atau menghapus Fungsi Definied Pengguna tertentu berdasarkan id.

Lihat userDefinedFunction untuk membuat, upsert, kueri, membaca semua Fungsi yang Ditentukan Pengguna.

Properti

container
id
url

Mengembalikan URL referensi ke sumber daya. Digunakan untuk menautkan di Izin.

Metode

delete(RequestOptions)

Hapus <xref:UserDefined>yang diberikan .

Contoh

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)

Baca userDefinedFunctionDefinition untuk UserDefinedFunctionyang diberikan.

Contoh

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)

Ganti UserDefinedFunction yang diberikan dengan UserDefinedFunctionDefinition yang ditentukan .

Contoh

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);

Detail Properti

container 

container: Container

Nilai Properti

Container

id 

id: string

Nilai Properti

string

url

Mengembalikan URL referensi ke sumber daya. Digunakan untuk menautkan di Izin.

string url

Nilai Properti

string

Detail Metode

delete(RequestOptions)

Hapus <xref:UserDefined>yang diberikan .

Contoh

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>

Parameter

options
RequestOptions

Mengembalikan

Promise<UserDefinedFunctionResponse>

read(RequestOptions)

Baca userDefinedFunctionDefinition untuk UserDefinedFunctionyang diberikan.

Contoh

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>

Parameter

options
RequestOptions

Mengembalikan

Promise<UserDefinedFunctionResponse>

replace(UserDefinedFunctionDefinition, RequestOptions)

Ganti UserDefinedFunction yang diberikan dengan UserDefinedFunctionDefinition yang ditentukan .

Contoh

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>

Parameter

body
UserDefinedFunctionDefinition
options
RequestOptions

Mengembalikan

Promise<UserDefinedFunctionResponse>