Skip to content

Connecting to SQL Server

Steps

Please follow the steps below to connect to a SQL Server data source.

  1. Click "New Data Connection" in the upper right corner of the data connection page.

  2. Select the SQL Server data source from the data source types.

  3. Fill in the required parameters for the data source connection as prompted.

    Connection Configuration Information Description

    FieldDescription
    NameThe name of the connection. Required and unique within the user scope
    Host AddressThe address of the database. If the url field is filled in, the value in url will be used with higher priority
    PortThe port of the database. If the url field is filled in, the value in url will be used with higher priority
    UsernameThe username for the database
    PasswordThe password for the database
    DatabaseThe name of the database
    Max ConnectionsMaximum number of connections in the connection pool
    Prefer using database comment as dataset titleWhether to display the table name or the table comment as the title
    URLThe JDBC url of the database
    Transaction isolation level for read operationsThis setting only affects reading data; writing data still uses the default isolation level
    Hierarchical loading of schema and tablesDefault is off. When enabled, schemas and tables are loaded hierarchically. Only schemas are loaded during connection; you need to click the schema to load the tables under it
    Query timeout (seconds)Default is 600. For large data volumes, you can appropriately increase the timeout
    Allow write operationsIndicates that this connection can be selected as an output connection in Data Integration and Batch Sync. You must have write permission to the database and pass verification before configuring this parameter.
    Support uploading files to specified pathIndicates the database name where the generated table will be stored when creating a local file dataset. You must have write permission to the database and pass verification before configuring this parameter.
    Show only tables under specified database/schemaWhen this option is selected and the database field is not empty, only tables under the specified db will be displayed
  4. After filling in the parameters, click the Validate button to get the validation result (this checks the connectivity between HENGSHI SENSE and the configured data connection; you cannot add the connection if validation fails).

  5. After validation passes, Allow write operations and Support uploading files to specified path will be enabled and can be optionally turned on.

  6. Click Execute Preset Code to pop up the preset code for this data source, then click the execute button.

  7. Click the Add button to add the SQL Server connection.

Please note

  1. Parameters marked with * are required; others are optional.
  2. When connecting to a data source, you must execute the preset code. Failure to do so may result in certain functions being unavailable during data analysis. In addition, when upgrading from a version prior to 4.4 to 4.4, you need to execute the preset code for existing data connections in the system.

Supported SQL Server Versions

SQL Server 2016, SQL Server 2017, SQL Server 2025, etc.

Data Connection Preview Support

Supports regular table and view.

SQL Dataset Support for SQL

All SELECT-related features are supported, and the SELECT SQL statement must comply with the SQL Server syntax specification.

Unsupported Field Types

The following data types in SQL Server cannot be processed correctly:

  • hierarchyid
  • rowversion
  • sql_variant
  • xml
  • geometry
  • geography

User Manual for Hengshi Analysis Platform