Udostępnij za pomocą

UserDefinedFunction class

Pakiet:
@azure/cosmos

Służy do odczytywania, zastępowania lub usuwania określonej funkcji definied użytkownika według identyfikatora.

Zobacz UserDefinedFunction, aby utworzyć, upsert, zapytanie, przeczytać wszystkie funkcje zdefiniowane przez użytkownika.

Właściwości

container
id
url

Zwraca adres URL odwołania do zasobu. Służy do łączenia w obszarze Uprawnienia.

Metody

delete(RequestOptions)

Usuń podane <xref:UserDefined>.

Przykład

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)

Przeczytaj UserDefinedFunctionDefinitionDefinition dla danego UserDefinedFunction.

Przykład

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)

Zastąp podane UserDefinedFunction określonym UserDefinedFunctionDefinition.

Przykład

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

Szczegóły właściwości

container 

container: Container

Wartość właściwości

Container

id 

id: string

Wartość właściwości

string

url

Zwraca adres URL odwołania do zasobu. Służy do łączenia w obszarze Uprawnienia.

string url

Wartość właściwości

string

Szczegóły metody

delete(RequestOptions)

Usuń podane <xref:UserDefined>.

Przykład

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>

Parametry

options
RequestOptions

Zwraca

Promise<UserDefinedFunctionResponse>

read(RequestOptions)

Przeczytaj UserDefinedFunctionDefinitionDefinition dla danego UserDefinedFunction.

Przykład

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>

Parametry

options
RequestOptions

Zwraca

Promise<UserDefinedFunctionResponse>

replace(UserDefinedFunctionDefinition, RequestOptions)

Zastąp podane UserDefinedFunction określonym UserDefinedFunctionDefinition.

Przykład

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>

Parametry

body
UserDefinedFunctionDefinition
options
RequestOptions

Zwraca

Promise<UserDefinedFunctionResponse>