UserDefinedFunctions class

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 id.

Propiedades

container

Métodos

create(UserDefinedFunctionDefinition, RequestOptions)	Cree una 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.
query(SqlQuerySpec, FeedOptions)	Consulte todas las funciones definidas por el usuario.
query<T>(SqlQuerySpec, FeedOptions)	Consulte todas las funciones definidas por el usuario.
readAll(FeedOptions)	Lee todas las funciones definidas por el usuario. Ejemplo Lee todas las funciones definidas por el usuario en la matriz. const {body: udfList} = await container.userDefinedFunctions.readAll().fetchAll();

Detalles de las propiedades

container

container: Container

Valor de propiedad

Container

Detalles del método

create(UserDefinedFunctionDefinition, RequestOptions)

Cree una 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.

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.

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)

Lee todas las funciones definidas por el usuario.

Ejemplo

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

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

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

Parámetros

options

FeedOptions

Devoluciones

QueryIterator<UserDefinedFunctionDefinition & Resource>