Partilhar via

UserDefinedFunctions class

Pacote:
@azure/cosmos

Usado para criar, atualizar, consultar ou ler todas as funções definidas pelo usuário.

Consulte UserDefinedFunction para ler, substituir ou excluir uma determinada função definida pelo usuário por id.

Propriedades

container

Métodos

create(UserDefinedFunctionDefinition, RequestOptions)

Crie um UserDefinedFunction.

O Azure Cosmos DB suporta UDFs JavaScript que podem ser usados dentro de consultas, procedimentos armazenados e gatilhos.

Para obter detalhes adicionais, consulte a documentação da API JavaScript do lado do servidor.

Exemplo

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)

Consultar todas as funções definidas pelo usuário.
query<T>(SqlQuerySpec, FeedOptions)

Consultar todas as funções definidas pelo usuário.

Exemplo

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)

Leia todas as funções definidas pelo usuário.

Exemplo

Leia todas as funções definidas pelo usuário para 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();

Detalhes de Propriedade

container 

container: Container

Valor de Propriedade

Container

Detalhes de Método

create(UserDefinedFunctionDefinition, RequestOptions)

Crie um UserDefinedFunction.

O Azure Cosmos DB suporta UDFs JavaScript que podem ser usados dentro de consultas, procedimentos armazenados e gatilhos.

Para obter detalhes adicionais, consulte a documentação da API JavaScript do lado do servidor.

Exemplo

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

Devoluções

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

Consultar todas as funções definidas pelo usuário.

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

Parâmetros

query
SqlQuerySpec

Configuração de consulta para a operação. Consulte SqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options
FeedOptions

Devoluções

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Consultar todas as funções definidas pelo usuário.

Exemplo

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

Configuração de consulta para a operação. Consulte SqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options
FeedOptions

Devoluções

QueryIterator<T>

readAll(FeedOptions)

Leia todas as funções definidas pelo usuário.

Exemplo

Leia todas as funções definidas pelo usuário para 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

Devoluções

QueryIterator<UserDefinedFunctionDefinition & Resource>