Compartir a través de

UserDefinedFunctions class

  • Referencia
Paquete:
@azure/cosmos

Se usa para crear, upsert, consultar o leer todas las funciones definidas por el usuario.

Consulte userDefinedFunction para leer, reemplazar o eliminar una función definida por el usuario determinada por identificador.

Propiedades

container

Métodos

create(UserDefinedFunctionDefinition, RequestOptions)

Cree un userDefinedFunction.

Azure Cosmos DB admite UDF de JavaScript que se pueden usar dentro de consultas, procedimientos almacenados y desencadenadores.

Para obtener más información, consulte la documentación de la API de JavaScript del lado servidor.

de ejemplo de

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)

Consulte todas las funciones definidas por el usuario.
query<T>(SqlQuerySpec, FeedOptions)

Consulte todas las funciones definidas por el usuario.

de ejemplo de

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)

Lea todas las funciones definidas por el usuario.

de ejemplo de

Lea todas las funciones definidas por el usuario en la matriz.

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

Detalles de las propiedades

container 

container: Container

Valor de propiedad

Container

Detalles del método

create(UserDefinedFunctionDefinition, RequestOptions)

Cree un userDefinedFunction.

Azure Cosmos DB admite UDF de JavaScript que se pueden usar dentro de consultas, procedimientos almacenados y desencadenadores.

Para obtener más información, consulte la documentación de la API de JavaScript del lado servidor.

de ejemplo de

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>

Parámetros

body
UserDefinedFunctionDefinition
options
RequestOptions

Devoluciones

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

Consulte todas las funciones definidas por el usuario.

function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Parámetros

query
SqlQuerySpec

Consulta de la configuración de la operación. Consulte SqlQuerySpec para obtener más información sobre cómo configurar una consulta.

options
FeedOptions

Devoluciones

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Consulte todas las funciones definidas por el usuario.

de ejemplo de

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>

Parámetros

query
SqlQuerySpec

Consulta de la configuración de la operación. Consulte SqlQuerySpec para obtener más información sobre cómo configurar una consulta.

options
FeedOptions

Devoluciones

QueryIterator<T>

readAll(FeedOptions)

Lea todas las funciones definidas por el usuario.

de ejemplo de

Lea todas las funciones definidas por el usuario en la matriz.

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>

Parámetros

options
FeedOptions

Devoluciones

QueryIterator<UserDefinedFunctionDefinition & Resource>