Alibaba Cloud data source: RDS for SQL Server

更新时间:
复制 MD 格式

This topic explains how to add an RDS for SQL Server data source.

Prerequisites

  • You have created an RDS for SQL Server instance.

  • You have the username and password for the database.

Limitations

Quick BI supports SQL Server versions 2008 through 2022.

Background information

Adding an RDS for SQL Server data source is similar to adding an RDS for MySQL data source. The key differences are the schema configuration option, which is specific to SQL Server, and the default port, which is 1433.

Procedure

  1. Add Quick BI IP addresses to the whitelist.

    Before connecting to the RDS for SQL Server instance, add the IP addresses of Quick BI to the instance's whitelist. For instructions, see Configure a whitelist.

  2. Log in to the Quick BI console.

  3. Add a data source.

    1. Go to the data source creation page. See Create a data source for instructions.

    2. On the Alibaba Cloud Databases tab, select RDS for SQL Server.image

  4. In the connection dialog box, configure the following parameters.image

    Parameter

    Description

    Connection method

    RDS for SQL Server data sources support automatic and manual connections.

    If you select automatic connection, you can choose an RDS for SQL Server instance in your account, and the system automatically populates the configuration details.

    Display name

    The name of the data source as it appears in the data source list.

    Enter a descriptive name. Do not use special characters or leading or trailing spaces.

    Database endpoint

    The public endpoint of the SQL Server database. If you use a VPC data source, enter the internal endpoint and internal port of the database.

    Log in to the RDS console

    . In the Basic Information section, click View Connection Details to find the database endpoint. Example: rm-xxxxxxxxxxxxxxxxxx.sqlserver.rds.aliyuncs.com.

    For more information, see View or change the internal and public endpoints and port numbers.

    Port

    The port number. The default value is 1433.

    Database

    The name of the database to connect to.

    Schema

    The name of the schema to connect to. The default value is dbo.

    Username

    The username for the database account.

    Password

    The password for the database account.

    VPC data source

    If you connect to the database over a VPC network, select the VPC data source option and configure the following parameters.

    • AccessKey ID: The AccessKey ID of the account that owns the instance.

      For more information, see Obtain an AccessKey pair.

      Note

      Ensure that this AccessKey ID has read permissions on the target instance. If it also has write permissions, the system automatically adds the required IP addresses to the whitelist. Otherwise, you must add them manually. For more information, see Create a custom policy.

    • AccessKey Secret: The AccessKey Secret of the account that owns the instance.

      For more information, see Obtain an AccessKey pair.

    • Instance ID: The ID of the instance. You can find this on the Basic Information page on the RDS console.

    • Region: The region where the instance is located.

    Note

    If you select the VPC data source option, you must enter the internal endpoint and internal port in the database endpoint and port fields.

    Enable file upload

    If enabled, you can upload files.

    SSL

    If SSL is configured for the target data source, select this option to protect your data in transit.

    Initialization SQL

    If enabled, you can specify SQL statements that execute automatically after a connection is established.

    Only SET statements are allowed. Separate multiple statements with a semicolon (;).

  5. Click Test connection to verify connectivity to the data source.

    image

  6. After a successful connection test, click OK to add the data source.

    If a data source with the same configuration already exists, a conflict message appears. You do not need to add the data source again.

Next steps

After creating the data source, you can create datasets and analyze your data.