Help Center/ ROMA Connect/ User Guide(new)/ Connectors/ Databases/ SQL Server
Updated on 2024-11-25 GMT+08:00
View PDF
Share

SQL Server

The SQL Server connector allows you to connect applications with the SQL Server database, and manage data transmission.

  • SQL Server is an easy-to-use relational database featuring high scalability.
  • The default SQL Server port number is 1433. The administrator can change the port number as required.

Creating an SQL Server Connection

  1. Log in to the new ROMA Connect console.
  2. In the navigation pane on the left, choose Connector. On the page displayed, click New Connection.
  3. Select the SQL Server connector.
  4. In the dialog box displayed, configure the connector and click OK.

    Parameter

    Description

    Name

    Enter the connector instance name.

    Region

    Select a region.

    Project

    Select a project.

    Instance

    Select an instance for subsequent connectivity verification.

    Connection and Security

    Select the connection mode for the database. Currently, the Default mode is supported.

    • Default: The system automatically concatenates data source connection character strings based on configured data.
    • Professional: You need to specify the data source connection string manually.

    IP Address

    Required when Connection and Security is set to Default.

    Enter the IP address of the database.

    Port

    Required when Connection and Security is set to Default.

    Enter the port number to which the database is connected.

    Database Name

    Required when Connection and Security is set to Default.

    Enter the name of the database to be connected.

    Connection String

    Required when Connection and Security is set to Professional.

    Enter the JDBC connection string of the SQL Server database, for example, jdbc:sqlserver://{hostname}:{port};DatabaseName={dbname}.

    Username

    Enter the username used to connect to the database.

    Password

    Enter the password used to connect to the database.

    Description

    Enter the description of the connector to identify it.

Action

  • Obtaining records
  • Obtaining incremental records
  • Adding records
  • Updating records
  • Replicating records
  • Deleting records
  • Custom SQL

Configuring Parameters

Table 1 Obtaining records

Parameter

Description

Table Name

Select or enter the table name in the database to be queried.

Field Name

Select the field name of the data table to be queried.

WHERE Condition

Set the condition value in single quotation marks.

Order By Field

Enter the sorting field of the returned result.

Limits

Enter the number of records on each page in the returned result.

Offset

Enter the offset of the pagination query.
Table 2 Obtaining incremental records

Parameter

Description

Table Name

Select or enter the name of the table to obtain incremental records.

Field Name

Select the field name of the data table to be queried.

WHERE Condition

Set the condition value in single quotation marks.

Order By Field

Enter the sorting field of the returned result.

Start Timezone for incremental database selection

Start time zone for obtaining incremental data.

Incremental Selection Timestamp Field Name

Timestamp field for obtaining incremental data.

Incremental Selection Timestamp Initial Value

Initial timestamp for obtaining incremental data.

Reset Initial Incremental Selection Time

Whether to enable the reset of the initial time for obtaining incremental data.

Incremental Selection Compensation Period (ms)

Time compensation for obtaining incremental data.
Table 3 Adding records

Parameter

Description

Table Name

Select or enter the name of the table to which data is to be inserted.

Data to Insert

Enter the target field value in single quotation marks.
Table 4 Updating records

Parameter

Description

Table Name

Select or enter the name of the table where data is to be updated.

Data to Update

Enter the target field value in single quotation marks.

WHERE Condition

Set the condition value in single quotation marks.
Table 5 Replicating records

Parameter

Description

Table Name

Select or enter the name of the table where data is to be replicated.

Clear Table

Whether to clear the table each time data is replicated.
Table 6 Deleting records

Parameter

Description

Table Name

Select or enter the name of the table where data is to be deleted.

WHERE Condition

Set the condition value in single quotation marks.
Table 7 Custom SQL

Parameter

Description

Statement

Enter the native SQL statement for operating the database.

  • Statements display all your inputs as plain text. Do not include sensitive information.
  • Be careful when using non-query statements such as drop and truncate.
Parent topic: Databases