UserDefinedFunctions | @azure/cosmos

Used to create, upsert, query, or read all User Defined Functions.

see: UserDefinedFunction to read, replace, or delete a given User Defined Function by id.

Hierarchy

UserDefinedFunctions

Index

Properties

container

Methods

Properties

container

container: Container

The parent Container.

Methods

create

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

- Defined in client/UserDefinedFunction/UserDefinedFunctions.ts:72
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
- Optional options: RequestOptions
Returns Promise<UserDefinedFunctionResponse>

query

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

- Defined in client/UserDefinedFunction/UserDefinedFunctions.ts:29
Query all User Defined Functions.

Parameters
- query: SqlQuerySpec
  
  Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
- Optional options: FeedOptions
Returns QueryIterator<any>
- Defined in client/UserDefinedFunction/UserDefinedFunctions.ts:35
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.
- Optional options: FeedOptions
Returns QueryIterator<T>

readAll

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

- Defined in client/UserDefinedFunction/UserDefinedFunctions.ts:60
Read all User Defined Functions.
example
Read all User Defined Functions to array.
```
const {body: udfList} = await container.userDefinedFunctions.readAll().toArray();
```
Parameters
- Optional options: FeedOptions
Returns QueryIterator<UserDefinedFunctionDefinition & Resource>

Hierarchy

Index

Properties

Methods

Properties

container

Methods

create

Parameters

body: UserDefinedFunctionDefinition

Optional options: RequestOptions

Returns Promise<UserDefinedFunctionResponse>

query

Parameters

query: SqlQuerySpec

Optional options: FeedOptions

Returns QueryIterator<any>

Type parameters

T

Parameters

query: SqlQuerySpec

Optional options: FeedOptions

Returns QueryIterator<T>

readAll

Parameters

Optional options: FeedOptions

Returns QueryIterator<UserDefinedFunctionDefinition & Resource>