你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

UserDefinedFunctions class

参考

包:: @azure/cosmos

用于创建、更新插入、查询或读取所有用户定义函数。

请参阅 UserDefinedFunction ，按 ID 读取、替换或删除给定的用户定义的函数。

属性

方法

create(UserDefinedFunctionDefinition, RequestOptions)	创建 UserDefinedFunction。 Azure Cosmos DB 支持可在查询、存储过程和触发器中使用的 JavaScript UDF。有关更多详细信息，请参阅服务器端 JavaScript API 文档。
query(SqlQuerySpec, FeedOptions)	查询所有用户定义函数。
query<T>(SqlQuerySpec, FeedOptions)	查询所有用户定义函数。
readAll(FeedOptions)	读取所有用户定义函数。示例将所有用户定义函数读取到数组中。 `const {body: udfList} = await container.userDefinedFunctions.readAll().fetchAll();`

属性详细信息

container

container: Container

属性值

Container

方法详细信息

create(UserDefinedFunctionDefinition, RequestOptions)

创建 UserDefinedFunction。

Azure Cosmos DB 支持可在查询、存储过程和触发器中使用的 JavaScript UDF。

有关更多详细信息，请参阅服务器端 JavaScript API 文档。

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

参数

body: UserDefinedFunctionDefinition

options: RequestOptions

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

查询所有用户定义函数。

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

参数

query: SqlQuerySpec

操作的查询配置。有关如何配置查询的详细信息，请参阅 SqlQuerySpec 。

options: FeedOptions

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

查询所有用户定义函数。

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

参数

query: SqlQuerySpec

操作的查询配置。有关如何配置查询的详细信息，请参阅 SqlQuerySpec 。

options: FeedOptions

QueryIterator<T>

readAll(FeedOptions)

读取所有用户定义函数。

示例

将所有用户定义函数读取到数组中。

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

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

参数

options: FeedOptions

QueryIterator<UserDefinedFunctionDefinition & Resource>

通过