Compartir a través de

UserDefinedFunction class

  • Referencia
Paquete:
@azure/cosmos

Se usa para leer, reemplazar o eliminar una función definida por el usuario especificada por identificador.

Consulte userDefinedFunction para crear, upsert, consultar y leer todas las funciones definidas por el usuario.

Propiedades

container
id
url

Devuelve una dirección URL de referencia al recurso. Se usa para vincular en Permisos.

Métodos

delete(RequestOptions)

Elimine el <xref:UserDefined>especificado.

Ejemplo

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)

Lea el UserDefinedFunctionDefinition para el UserDefinedFunction especificado.

Ejemplo

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)

Reemplace el UserDefinedFunction especificado por el UserDefinedFunctionDefinition especificado.

Ejemplo

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

Detalles de las propiedades

container 

container: Container

Valor de propiedad

Container

id 

id: string

Valor de propiedad

string

url

Devuelve una dirección URL de referencia al recurso. Se usa para vincular en Permisos.

string url

Valor de propiedad

string

Detalles del método

delete(RequestOptions)

Elimine el <xref:UserDefined>especificado.

Ejemplo

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>

Parámetros

options
RequestOptions

Devoluciones

Promise<UserDefinedFunctionResponse>

read(RequestOptions)

Lea el UserDefinedFunctionDefinition para el UserDefinedFunction especificado.

Ejemplo

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>

Parámetros

options
RequestOptions

Devoluciones

Promise<UserDefinedFunctionResponse>

replace(UserDefinedFunctionDefinition, RequestOptions)

Reemplace el UserDefinedFunction especificado por el UserDefinedFunctionDefinition especificado.

Ejemplo

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>

Parámetros

body
UserDefinedFunctionDefinition
options
RequestOptions

Devoluciones

Promise<UserDefinedFunctionResponse>