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

UserDefinedFunctionProperties 类

定义

命名空间:

Microsoft.Azure.Cosmos.Scripts

程序集:

Microsoft.Azure.Cosmos.Client.dll

包:

Microsoft.Azure.Cosmos v3.39.0

Source:

UserDefinedFunctionProperties.cs

表示 Azure Cosmos 服务中的用户定义的函数。

public class UserDefinedFunctionProperties

type UserDefinedFunctionProperties = class

Public Class UserDefinedFunctionProperties

继承

Object

UserDefinedFunctionProperties

示例

以下示例演示如何注册和使用 UDF。

await this.container.UserDefinedFunctions.CreateUserDefinedFunctionAsync(
    new UserDefinedFunctionProperties 
    { 
        Id = "calculateTax", 
        Body = @"function(amt) { return amt * 0.05; }" 
    });

QueryDefinition sqlQuery = new QueryDefinition(
    "SELECT VALUE udf.calculateTax(t.cost) FROM toDoActivity t where t.cost > @expensive and t.status = @status")
    .WithParameter("@expensive", 9000)
    .WithParameter("@status", "Done");

using (FeedIterator<double> feedIterator = this.container.Items.GetItemsQueryIterator<double>(
    sqlQueryDefinition: sqlQuery,
    partitionKey: "Done"))
{
    while (feedIterator.HasMoreResults)
    {
        foreach (var tax in await feedIterator.ReadNextAsync())
        {
            Console.WriteLine(tax);
        }
    }
}

注解

Azure Cosmos 支持 JavaScript 用户定义的函数 (UDF) ，这些函数存储在数据库中，可在查询中使用。 有关如何在 https://docs.microsoft.com/azure/cosmos-db/sql-api-sql-query#javascript-integration 查询中使用 UDF，请参阅 。 有关在 https://docs.microsoft.com/azure/cosmos-db/programming#udf JavaScript 中实现 UDF 的更多详细信息，请参阅 。

构造函数

UserDefinedFunctionProperties()

表示 Azure Cosmos 服务中的用户定义的函数。

属性

Body	获取或设置 Azure Cosmos DB 服务的用户定义函数的正文。
ETag	从 Azure Cosmos DB 服务中获取与资源关联的实体标记。
Id	获取或设置 Azure Cosmos DB 服务中资源的 ID。
SelfLink	从 Azure Cosmos DB 服务获取与资源关联的自链接。