Microsoft SQL Server & Azure SQL

组件格式

该状态存储组件适用于 Microsoft SQL Server 和 Azure SQL。

要配置此状态存储，请创建一个类型为 state.sqlserver 的组件。请参考本指南了解如何创建和应用状态存储配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: <NAME>
spec:
  type: state.sqlserver
  version: v1
  metadata:
    # 使用 SQL Server 凭据进行身份验证
    - name: connectionString
      value: |
                Server=myServerName\myInstanceName;Database=myDataBase;User Id=myUsername;Password=myPassword;

    # 使用 Microsoft Entra ID 进行身份验证（仅限 Azure SQL）
    # "useAzureAD" 设置为 "true"
    - name: useAzureAD
      value: true
    # Azure SQL 数据库的连接字符串或 URL，可选包含数据库
    - name: connectionString
      value: |
                sqlserver://myServerName.database.windows.net:1433?database=myDataBase

    # 其他可选字段（列出默认值）
    - name: tableName
      value: "state"
    - name: metadataTableName
      value: "dapr_metadata"
    - name: schema
      value: "dbo"
    - name: keyType
      value: "string"
    - name: keyLength
      value: "200"
    - name: indexedProperties
      value: ""
    - name: cleanupIntervalInSeconds
      value: "3600"
   # 如果希望使用 Microsoft SQL Server 作为 actor 的状态存储，请取消注释此行（可选）
   #- name: actorStateStore
   #  value: "true"

如果希望将 SQL Server 用作 actor 状态存储，请在元数据中添加以下内容：

  - name: actorStateStore
    value: "true"

规格元数据字段

使用 SQL Server 凭据进行身份验证

以下元数据选项是使用 SQL Server 凭据进行身份验证所必需的。这在 SQL Server 和 Azure SQL 上均受支持。

使用 Microsoft Entra ID 进行身份验证

使用 Microsoft Entra ID 进行身份验证仅在 Azure SQL 上受支持。Dapr 支持的所有身份验证方法均可使用，包括客户端凭据（“服务主体”）和托管身份。

其他元数据选项

创建 Microsoft SQL Server/Azure SQL 实例

按照说明从 Azure 文档中了解如何创建 SQL 数据库。数据库必须在 Dapr 使用之前创建。

为了将 SQL Server 设置为状态存储，您需要以下属性：

• 连接字符串：SQL Server 连接字符串。例如：server=localhost;user id=sa;password=your-password;port=1433;database=mydatabase;
• 模式：要使用的数据库模式（默认=dbo）。如果不存在，将被创建
• 表名：数据库表名。如果不存在，将被创建
• 索引属性：来自 json 数据的可选属性，将被索引并作为单独的列持久化

创建专用用户

当使用专用用户（非 sa）连接时，即使用户是所需数据库模式的所有者，也需要为用户提供以下授权：

• CREATE TABLE
• CREATE TYPE

TTL 和清理

此状态存储支持 Dapr 存储的记录的 生存时间 (TTL)。使用 Dapr 存储数据时，您可以设置 ttlInSeconds 元数据属性，以指示数据在多少秒后应被视为“过期”。

由于 SQL Server 没有内置的 TTL 支持，Dapr 通过在状态表中添加一列来实现这一点，该列指示数据何时应被视为“过期”。即使“过期”记录仍然物理存储在数据库中，也不会返回给调用者。后台“垃圾收集器”定期扫描状态表以查找过期的行并删除它们。

您可以使用 cleanupIntervalInSeconds 元数据属性设置过期记录删除的间隔，默认为 3600 秒（即 1 小时）。

• 较长的间隔需要较少频繁地扫描过期行，但可能需要更长时间存储过期记录，可能需要更多的存储空间。如果您计划在状态表中存储许多记录，并且 TTL 较短，请考虑将 cleanupIntervalInSeconds 设置为较小的值 - 例如，300（300 秒，或 5 分钟）。
• 如果您不打算在 Dapr 和 SQL Server 状态存储中使用 TTL，您应该考虑将 cleanupIntervalInSeconds 设置为 <= 0 的值（例如 0 或 -1）以禁用定期清理并减少数据库的负载。

状态存储在 ExpireDate 列上没有索引，这意味着每次清理操作都必须执行全表扫描。如果您打算在表中写入大量使用 TTL 的记录，您应该考虑在 ExpireDate 列上创建索引。索引使查询更快，但使用更多的存储空间并略微减慢写入速度。

CREATE CLUSTERED INDEX expiredate_idx ON state(ExpireDate ASC)

相关链接

• Dapr 组件的基本模式
• 阅读本指南以获取有关配置状态存储组件的说明
• 状态管理构建块