UserDefinedFunctions class

參考

套件:: @azure/cosmos

用來建立、upsert、查詢或讀取所有使用者定義函式。

請參閱 UserDefinedFunction ，依識別碼讀取、取代或刪除指定的使用者定義函數。

屬性

方法

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>

共用方式為