Sdílet prostřednictvím

UserDefinedFunction class

Balíček:
@azure/cosmos

Slouží ke čtení, nahrazení nebo odstranění zadané funkce Uživatele Definied Function by ID.

Viz UserDefinedFunction vytvoření, upsert, dotaz, čtení všech uživatelem definovaných funkcí.

Vlastnosti

container
id
url

Vrátí adresu URL odkazu na prostředek. Používá se pro propojení v oprávněních.

Metody

delete(RequestOptions)

Odstraňte danou <xref:UserDefined>.

Příklad

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)

Přečtěte si UserDefinedFunctionDefinition pro danou UserDefinedFunction.

Příklad

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)

Nahraďte danou UserDefinedFunction zadaným UserDefinedFunctionDefinition.

Příklad

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

Podrobnosti vlastnosti

container 

container: Container

Hodnota vlastnosti

Container

id 

id: string

Hodnota vlastnosti

string

url

Vrátí adresu URL odkazu na prostředek. Používá se pro propojení v oprávněních.

string url

Hodnota vlastnosti

string

Podrobnosti metody

delete(RequestOptions)

Odstraňte danou <xref:UserDefined>.

Příklad

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

Návraty

Promise<UserDefinedFunctionResponse>

read(RequestOptions)

Přečtěte si UserDefinedFunctionDefinition pro danou UserDefinedFunction.

Příklad

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

Návraty

Promise<UserDefinedFunctionResponse>

replace(UserDefinedFunctionDefinition, RequestOptions)

Nahraďte danou UserDefinedFunction zadaným UserDefinedFunctionDefinition.

Příklad

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

Návraty

Promise<UserDefinedFunctionResponse>