Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: note about sqlserver instance names #2841

Open
wants to merge 2 commits into
base: release-5.9
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions en_US/data-integration/data-bridge-sqlserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,17 +226,36 @@ This section demonstrates how to create a Connector to connect the Sink to the M
The following steps assume that you run both EMQX and Microsoft SQL Server on the local machine. If you have Microsoft SQL Server and EMQX running remotely, adjust the settings accordingly.

1. Enter the EMQX Dashboard and click **Integration** -> **Connectors**.

2. Click **Create** in the top right corner of the page.

3. On the **Create Connector** page, select **Microsoft SQL Server** and then click **Next**.

4. In the **Configuration** step, configure the following information:
- **Connector name**: Enter a name for the connector, which should be a combination of upper and lower-case letters and numbers, for example: `my_sqlserver`.

- **Server Host**: Enter `127.0.0.1:1433`, or the URL if the Microsoft SQL Server is running remotely.

::: tip

If you are using a Named Instance, you must explicitly specify the port number on which the instance runs. The driver connects to the instance using the provided port, and during health checks, EMQX attempts to infer the instance name.

Specifying only the instance name (e.g., `MYSERVER\SQL2022`) in the Server Host field does not guarantee a connection to the correct instance. Therefore, always double-check the port configuration to ensure proper connectivity.

:::

- **Database Name**: Enter `master`.

- **Username**: Enter `sa`.

- **Password**: Enter the preset password `mqtt_public1`, or use the actual password.

- **SQL Server Driver Name**: Enter `ms-sql`, as the DSN Name configured in `odbcinst.ini`

5. Advanced settings (optional): For details, see [Features of Sink](./data-bridges.md#features-of-sink).

6. Before clicking **Create**, you can click **Test Connectivity** to test if the connector can connect to the Microsoft SQL Server.

7. Click the **Create** button at the bottom to complete the creation of the connector. In the pop-up dialog, you can click **Back to Connector List** or click **Create Rule** to continue creating rules with Sinks to specify the data to be forwarded to the Microsoft SQL Server and record client events. For detailed steps, see [Create a Rule with Microsoft SQL Server Sink for Message Storage](#create-a-rule-with-microsoft-sql-server-sink-for-message-storage) and [Create a Rule with Microsoft SQL Server Sink for Events Recording](#create-a-rule-with-microsoft-sql-server-sink-for-events-recording).

## Create a Rule with Microsoft SQL Server Sink for Message Storage
Expand Down
19 changes: 19 additions & 0 deletions zh_CN/data-integration/data-bridge-sqlserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,18 +226,37 @@ Microsoft 提供的 Microsoft SQL Server 容器内已安装 `mssql-tools18`,
在创建 Microsoft SQL Server Sink 之前,您需要创建一个连接器,以便 EMQX 与 Microsoft SQL Server 服务建立连接。以下示例假定您在本地机器上同时运行 EMQX 和 Microsoft SQL Server。如果您在远程运行 Microsoft SQL Server 和 EMQX,请相应地调整设置。

1. 转到 Dashboard **集成** -> **连接器** 页面。点击页面右上角的**创建**。

2. 在连接器类型中选择 **Microsoft SQL Server**,点击**下一步**。

3. 在 **配置** 步骤,配置以下信息:

- **连接器名称**:应为大写和小写字母及数字的组合,例如:`my_sqlserver`。

- **服务器地址**: `127.0.0.1:1433`,或使用实际的 Microsoft SQL Server 地址和端口

::: tip

如果您使用的是命名实例(Named Instance),则必须明确指定实例运行的端口号。驱动程序会使用提供的端口号连接到实例,在运行健康检查时,EMQX 会尝试推断实例名称。

在服务器地址字段中仅指定实例名称(例如 `MYSERVER\SQL2022`)无法保证连接到正确的实例,因此请务必检查并确认端口配置,以确保连接正常。

:::

- **数据库名字**: `master`

- **用户名**: `sa`

- **密码**: `mqtt_public1`

- **SQL Server Driver 名称**: `ms-sql`,即您在 `odbcinst.ini` 中配置的 DSN Name

4. 高级配置(可选):详细请参考 [Sink 的特性](./data-bridges.md#sink-的特性)。

5. 在点击**创建**之前,您可以点击**测试连接**来测试连接器是否能连接到 Microsoft SQL Server 服务器。

6. 点击**创建**按钮完成连接器创建。

7. 在弹出的**创建成功**对话框中您可以点击**创建规则**,继续创建规则以指定需要写入 RocketMQ 的数据和需要记录的客户端事件。您也可以按照[创建消息存储 Sink 规则](#创建消息存储-sink-规则)和[创建事件记录 Sink 规则](#创建事件记录-sink-规则)章节的步骤来创建规则。

## 创建消息存储 Sink 规则
Expand Down