SQL 数据库

注意：除非专用要求部分另有说明，否则这些要求适用于所有 Automation Suite 产品。

您必须引入外部 SQL Server 才能安装 Automation Suite 和 UiPath™ 产品。支持 Microsoft SQL Server 2016、2017、2019 和 2022 标准版和企业版。

Additional Microsoft SQL platforms, such as Azure SQL Database, Azure SQL Managed Instance, or Amazon Relational Database Service, are also supported as long as the Microsoft SQL Server database engine meets the requirements. For details, see Compatibility matrix.

备注：

确保可以从集群节点访问 SQL Server。

各个产品支持的配置各不相同。

对于计划部署的每个产品，您必须：

• 根据产品的要求检查 SQL Server 的支持版本；
• 满足产品要求的 SQL Server 配置要求，包括 SQL Server 用户权限。

Microsoft SQL Server 的一般最低硬件要求如下：

• 8 (v-)CPU
• 32 GB RAM
• 256 GB 固态硬盘

The minimum requirements are general guidance and do not guarantee reliable operation in a production deployment. Capacity planning is required to determine the hardware requirements that are needed for reliable operation. For details, see Capacity planning.

每个 UiPath™ 产品都需要有自己的 SQL 数据库。

数据库创建工作流

交互式安装程序使用以下工作流自动创建数据库：

1. 交互式安装程序脚本会检查input.json文件中sql.create_db参数的值。
   • 如果sql.create_db参数设置为true ，则安装程序会代表您自动生成所有数据库。 在这种情况下，安装程序将使用默认数据库名称和默认模板，并忽略您提供的任何自定义数据库名称。

     For details, see Automatically create the necessary databases.

   • 如果将sql.create_db设置为false ，则您必须使用自己的数据库。 在这种情况下，您必须手动设置数据库。 请注意，您可以使用自定义数据库名称，前提是遵循提供的命名约定。 此步骤至关重要，因为我们将数据库名称与连接模板结合使用来构成数据库连接字符串。 如果您不遵循建议的命名约定，则必须自己提供 SQL 连接字符串。

     For details, see Bring your own databases.

2. 交互式安装程序会生成连接字符串，如下所示：

   • 如果您没有为服务定义连接字符串，则安装程序将使用连接模板生成所有数据库连接字符串。

   • 如果您为服务定义了连接字符串，则安装程序将使用为数据库提供的连接字符串。

自动创建必要的数据库

如果您希望安装程序创建数据库，请填写input.json文件的以下字段：

参数	描述
sql.create_db	设置为true以允许安装程序创建数据库。 请注意，安装程序将使用默认数据库名称和默认模板，并忽略您提供的任何自定义数据库名称。
sql.server_url	您希望安装程序在其中配置数据库的 SQL Server 的 FQDN。
sql.port	SQL Server 中应托管数据库实例的端口号。
sql.username	用于连接到 SQL Server 的用户名/用户 ID。
sql.password	之前提供的用于连接到 SQL Server 的用户名密码。

备注：

• 确保用户具有 dbcreator 角色。这将授予他们在 SQL Server 中创建数据库的权限。否则，安装将失败。
• ODBC 连接不支持包含特殊字符的用户名。对于 AI Center、Document Understanding 和 Apps 的数据库用户名，请仅使用大写和小写字母。

请自带数据库

如果您选择为新安装的 Automation Suite 使用自己的数据库，我们强烈建议设置新的数据库，而不是使用现有数据库。此预防措施有必要，以防止旧数据库中的剩余元数据与 Automation Suite 的操作发生任何冲突。

如果您有自己的数据库，则必须为每个数据库提供 SQL 连接字符串。Automation Suite 支持以下 SQL 连接字符串格式：

参数	描述	产品
sql_connection_string_template	完整的 ADO.NET 连接字符串，其中目录名称设置为 DB_NAME_PLACEHOLDER。安装程序将使用已安装的套件服务的默认数据库名称替换此占位符。	平台、Orchestrator、Automation Suite Robot、Test Manager、Automation Hub、Automation Ops、Insights、Task Mining、Data Service、Process Mining、Document Understanding
sql_connection_string_template_jdbc	完整的 JDBC 连接字符串，其中数据库名称设置为 DB_NAME_PLACEHOLDER。安装程序将使用已安装的套件服务的默认数据库名称替换此占位符。	AI Center
sql_connection_string_template_odbc	完整的 ODBC 连接字符串，其中数据库名称设置为 DB_NAME_PLACEHOLDER。安装程序将使用已安装的套件服务的默认数据库名称替换此占位符。	Document Understanding、Apps
sql_connection_string_template_sqlalchemy_pyodbc	完整的 SQL alchemy ODBC 连接字符串，其中数据库名称设置为 DB_NAME_PLACEHOLDER。安装程序将使用已安装的套件服务的默认数据库名称替换此占位符。	Process Mining

重要提示：

确保已向连接字符串中指定的 SQL 帐户授予所有 Automation Suite 数据库的 db_securityadmin 和 db_owner 角色。如果安全限制不允许使用 db_owner，则 SQL 帐户应在所有数据库上具有以下角色和权限：

• db_securityadmin
• db_ddladmin
• db_datawriter
• db_datareader
• 对 dbo 架构的 EXECUTE 权限

我们仅在安装期间或重新配置数据库时使用 db_securityadmin 和 db_ddladmin 角色，因此之后您可以撤销该权限。

需要为 Insights 分配 db_owner 角色才能成功安装。

重要提示：

如果在配置文件中手动设置连接字符串，则可以对 SQL、JDBC、ODBC 或 PYODBC 密码进行转义，如下所示：

• 对于 SQL：在密码的开头和结尾添加' ，并将任何其他'加倍。
• 对于 JDBC/ODBC：在密码的开头添加{ ，在密码的末尾添加} ，并将其他任何}加倍。
• 对于 PYODBC：username 和 password 应对 URL 进行编码，以解决特殊字符。Document Understanding 数据库密码不能以 { 开头。

重要提示：Process Mining 产品的 AutomationSuite_ProcessMining_Airflow 数据库必须启用 READ_COMMITTED_SNAPSHOT。

备注：

默认情况下将 TrustServerCertificate 设置为 False，并且您必须为 SQL Server 提供其他 CA 证书。如果 SQL Server 证书是自签名证书或由内部 CA 签名，则此为必要项。如果在这种情况下不提供 SQL Server 证书，先决条件检查将无法通过。

sql_connection_string_template 示例

Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net:1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;

sql_connection_string_template_jdbc 示例

jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net:1433;database=DB_NAME_PLACEHOLDER;user=testadmin;password=***;encrypt=true;trustServerCertificate=false;Connection Timeout=30;hostNameInCertificate=sfdev1804627-c83f074b-sql.database.windows.net"

sql_connection_string_template_odbc 示例

SERVER=sfdev1804627-c83f074b-sql.database.windows.net,1433;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD=***;MultipleActiveResultSets=False;Encrypt=YES;TrustServerCertificate=NO;Connection Timeout=30;"

sql_connection_string_template_sqlalchemy_pyodbc 示例

mssql+pyodbc://testuser%40sfdev3082457-sql.database.windows.net:[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"

sql_connection_string_template 和 sql_connection_string_template_sqlalchemy_pyodbc 示例 (Process Mining)

"sql_connection_string_template": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=[e-mail];Password='***';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"

"sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://testadmin%40sfdev4515230-sql.database.windows.net:07%3Cl%5Bxj-%3D~[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"

Automation Suite 服务的默认和可选 DB 名称

{
  "orchestrator": "AutomationSuite_Orchestrator",
  "orchestrator_ta": "AutomationSuite_Orchestrator",
  "asrobots": "AutomationSuite_Orchestrator",
  "orchestrator_upd": "AutomationSuite_Platform",
  "platform": "AutomationSuite_Platform",
  "test_manager": "AutomationSuite_Test_Manager",
  "automation_ops": "AutomationSuite_Platform",
  "automation_hub": "AutomationSuite_Automation_Hub",
  "insights": "AutomationSuite_Insights",
  "task_mining": "AutomationSuite_Task_Mining",
  "dataservice": "AutomationSuite_DataService", 
  "aicenter": "AutomationSuite_AICenter",
  "documentunderstanding": "AutomationSuite_DU_Datamanager",
  "processmining_airflow": "AutomationSuite_Airflow",
  "processmining_metadata": "AutomationSuite_ProcessMining_Metadata",
  "processmining_warehouse": "AutomationSuite_ProcessMining_Warehouse",
  "apps": "AutomationSuite_Apps",
  
}

备注：

如果要覆盖上述任何服务的连接字符串，请为该特定服务设置 sql_connection_str。

在运行安装程序之前，您仍然必须手动创建这些数据库。

覆盖 Orchestrator 和平台的默认连接字符串

{
  "orchestrator": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomOrchDB;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  },
  "platform": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomIDDB;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  }
}

要覆盖其他产品的数据库连接字符串，请在相应的产品块中设置 sql_connection_str。连接字符串应具有相应产品支持的格式。

为 AI Center 设置数据库连接字符串的示例

参数	描述
aicenter.sql_connection_str	AI Center JDBC 连接字符串（有关 JDBC 格式，请参阅下文）

注意：确保 JDBC 连接字符串具有以下示例中的格式：

"aicenter": {
    "enabled": true,
    "sql_connection_str": "jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net;database=aicenter;user=[e-mail];password=TFgID_9GsE7_P@srCQp0WemXX_euHQZJ"
}

Document Understanding 连接字符串示例

"documentunderstanding": {
"enabled": true,
"sql_connection_str": "" // dotnet connection string,
"datamanager": {
 "sql_connection_str": "" // odbc connection string
 }
}

注意：仅当您要用自己的连接字符串覆盖默认值时，Data Manager SQL 连接字符串才为可选。

在线安装时始终启用手写功能。

max_cpu_per-pod 的默认值为 2，但您可以根据需要进行调整。

Process Mining 连接字符串示例

"processmining": {
    "enabled": true,
    "warehouse": {
        "sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;User Id=[e-mail];Password='***';Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
	"sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@sfdev4515230-sql.database.windows.net:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes",
        "master_sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=master;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
    },
    "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://testadmin%40sfdev4515230-sql.database.windows.net:07%3Cl%5Bxj-%3D~[e-mail]:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES"
    "sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Metadata;User Id=[e-mail];Password='***';Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",  
},

注意：模板 PYODBC 连接字符串 sql_connection_string_template_sqlalchemy_pyodbc 与您自带数据库时使用的 PYODBC 连接字符串 sqlalchemy_pyodbc_sql_connection_str 的名称不同。此外，当您使用自己的数据库时，模板 SQL sql_connection_string_template 和 sql_connection_str 的连接字符串名称也不同。

重要提示：

如果您有自己的数据库，并且您在input.json文件的processmining部分中使用sql_connection_str和sqlalchemy_pyodbc_sql_connection_str连接字符串配置，则模板连接字符串sql_connection_string_template和sql_connection_string_template_sqlalchemy_pyodbc如果指定）将被忽略。

注意：

不支持 MultiSubnetFailover=True。确保从任何 Process Mining 连接字符串中删除 MultiSubnetFailover=True。

备注：

Depending on the app_security_mode setting either a new SQL user is created for every Process Mining app by the system (app_security_mode="system_managed"), or a single SQL user account is created that is used for all process apps (app_security_mode="single_account"). Note that app_security_mode="system_managed" is the default setting, and that this requires advanced permissions for the database user. See Configuring process app security.

Process Mining 连接字符串示例

• 场景：使用 Kerberos 身份验证进行设置。

"processmining": {
    "enabled": true,
    "warehouse": {
        "sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
        "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes",
        "master_sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=master;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
      },
    "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes"
  },

Process Mining 连接字符串示例

• 场景：元数据数据库和数据仓库使用单独的 SQL Server（非 Kerberos 身份验证）。

"processmining": {
    "enabled": true,
    "warehouse": {
      "sql_connection_str": "Server=tcp:uipath-integration1.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;Persist Security Info=False;User Id=userid;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
      "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://userid:[e-mail]:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES",
      "master_sql_connection_str": "Server=tcp:uipath-integration1.database.windows.net,1433;Initial Catalog=master;Persist Security Info=False;User Id=userid;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
    },
    "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://userid:[e-mail]:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES"
    "sql_connection_str": "Server=tcp:uipath-integration2.database.windows.net,1433;Initial Catalog=AutomationSuite_Airflow;Persist Security Info=False;User Id=userid;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",  
},

Process Mining 连接字符串示例

• 场景：使用自定义 app_security_mode。

"processmining": {
    "enabled": true,
    "app_security_mode": "system_managed",
    "warehouse": {
        "sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
        "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes",
        "master_sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=master;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
      },
    "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=YES"
  },

SQL 身份验证

从 AKS 对 SQL 的基于 Azure Active Directory 的访问

您可以选择从 AKS 集群通过 Azure Active Directory 访问 Microsoft SQL Server。 以下示例显示了使用 AAD 访问方法的一些连接字符串：

"sql_connection_string_template": "Server=tcp:sfdev3888449-sql.database.windows.net,1433;Authentication=Active Directory Service Principal;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=5c6b8ff1-efb4-48ca-a530-f744f1d438df;Password='I5V8Q~srSTWf0onUYeHLK..qLO69pP7MZ3KIMaB2';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;",
  "sql_connection_string_template_jdbc": "jdbc:sqlserver://sfdev3888449-sql.database.windows.net;authentication=ActiveDirectoryServicePrincipal;database=DB_NAME_PLACEHOLDER;user=5c6b8ff1-efb4-48ca-a530-f744f1d438df;password={I5V8Q~srSTWf0onUYeHLK..qLO69pP7MZ3KIMaB2};encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.database.windows.net;loginTimeout=30;",
  "sql_connection_string_template_odbc": "SERVER=sfdev3888449-sql.database.windows.net;Authentication=ActiveDirectoryServicePrincipal;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=5c6b8ff1-efb4-48ca-a530-f744f1d438df;PWD={I5V8Q~srSTWf0onUYeHLK..qLO69pP7MZ3KIMaB2};Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;hostNameInCertificate=sfdev3888449-sql.database.windows.net",
  "sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://5c6b8ff1-efb4-48ca-a530-f744f1d438df:I5V8Q~[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server&authentication=ActiveDirectoryServicePrincipal",