UserDefinedFunctions class

  • Referência
Pacote:
@azure/cosmos

Usado para criar, upsert, 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 dá suporte a 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.
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.
readAll(FeedOptions)

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

Exemplo

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

const {body: udfList} = await container.userDefinedFunctions.readAll().fetchAll();

Detalhes da propriedade

container 

container: Container

Valor da propriedade

Container

Detalhes do método

create(UserDefinedFunctionDefinition, RequestOptions)

Crie um UserDefinedFunction.

O Azure Cosmos DB dá suporte a 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.

function create(body: UserDefinedFunctionDefinition, options?: RequestOptions): Promise<UserDefinedFunctionResponse>

Parâmetros

body
UserDefinedFunctionDefinition
options
RequestOptions

Retornos

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

Retornos

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

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

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

Retornos

QueryIterator<T>

readAll(FeedOptions)

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

Exemplo

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

const {body: udfList} = await container.userDefinedFunctions.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<UserDefinedFunctionDefinition & Resource>

Parâmetros

options
FeedOptions

Retornos

QueryIterator<UserDefinedFunctionDefinition & Resource>