Class UserDefinedFunctions

Readonlycontainer

create

• create(body, options?): Promise<UserDefinedFunctionResponse>

• Create a UserDefinedFunction.

  Azure Cosmos DB supports JavaScript UDFs which can be used inside queries, stored procedures and triggers.

  For additional details, refer to the server-side JavaScript API documentation.

  Parameters

  • body: UserDefinedFunctionDefinition
  • Optionaloptions: RequestOptions

  Returns Promise<UserDefinedFunctionResponse>

query

• query(query, options?): QueryIterator<any>

• Query all User Defined Functions.

  Parameters

  • query: SqlQuerySpec

    Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
  • Optionaloptions: FeedOptions

  Returns QueryIterator<any>
• query<T>(query, options?): QueryIterator<T>

• Query all User Defined Functions.

  Type Parameters

  • T

  Parameters

  • query: SqlQuerySpec

    Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
  • Optionaloptions: FeedOptions

  Returns QueryIterator<T>

readAll

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

• Read all User Defined Functions.

  Parameters

  • Optionaloptions: FeedOptions

  Returns QueryIterator<UserDefinedFunctionDefinition & Resource>

  Example: Read all User Defined Functions to array.

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