使用者定義的函式

發行項
08/05/2023

Azure Cosmos DB 是全域散發的多模型資料庫，可支援檔、圖形和索引鍵/值資料模型。本節中的內容是透過 REST 使用SQL API來管理使用者定義函數資源 (udfs) 。

使用者定義函數 (UDF) 是以 JavaScript 撰寫的應用程式邏輯的副作用。它可讓開發人員建構查詢運算子，進而擴充 Cosmos DB 查詢語言的核心。如同預存程序，UDF 存在於集合的範圍內，因此將應用程式邏輯限定於集合中。

類似於預存程序，UDF 資源也有固定的結構描述。主體屬性包含應用程式邏輯。下列範例說明使用者定義函式的 JSON 建構。

{  
"id":"simpleTaxUDF",  
"body": "  
function tax(income) {  
        if(income == undefined)   
            throw 'no input';  
        if (income < 1000)   
            return income * 0.1;  
        else if (income < 10000)   
            return income * 0.2;  
        else  
            return income * 0.4;  
    }  
",  
"_rid":"hLEEAI1YjgcBAAAAAAAAgA==",  
"_ts":1408058682,  
"_self":"dbs\/hLEEAA==\/colls\/hLEEAI1Yjgc=\/udfs\/hLEEAI1YjgcBAAAAAAAAgA==\/",  
"_etag":"00004100-0000-0000-0000-53ed453a0000"  
}

屬性	描述
id	必要。它是使用者可設定的屬性。這是用來識別 UDF 的唯一名稱。識別碼不能超過 255 個字元。
body	必要。它是使用者可設定的屬性。它是 UDF 的主體。
_擺脫	這是系統產生的屬性。資源識別碼 (_rid) 是資源模型上每個資源堆疊也是階層式的唯一識別碼。供內部進行放置和導覽 UDF 資源時使用。
_Ts	這是系統產生的屬性。代表資源的上次更新時間戳記。值為時間戳記。
_自我	這是系統產生的屬性。代表資源的唯一可定址 URI。
_Etag	這是系統產生的屬性，指定開放式平行存取控制所需的資源 etag。

工作

您可以使用使用者定義的函式執行下列動作：

如需 UDF 如何運作的詳細資訊，包括在查詢中執行 UDF，請參閱 Cosmos DB 程式設計：預存程式、觸發程式和 UDF。

共用方式為

使用者定義的函式

工作

另請參閱

其他資源