Database
Overview
DBSync's Database Connector provides support for various JDBC-compliant databases, including Oracle, MySQL, DB2, and more. This connector enables users to perform operations such as selecting, inserting, updating, and deleting records in databases. A single connector instance can be reused across different processes within the same project.
Prerequisites
To establish a connection to a database via the DBSync Database Connector, a user must:
Have a valid license for the DBSync Database Connector, along with a username and password to connect to the DBSync platform.
Have valid database credentials, including username, password, host/IP address, and port.
Ensure that the username and password used have sufficient privileges to access the database.
Connector Configuration
The following parameters are required to configure the Database Connector:
Property
Description
Required
Default Values
Username
The username for the database.
Yes
Password
The password for the database.
Yes
Host
The hostname or IP address of the database server.
Yes
Port
The port number used to connect to the database server.
Yes
Database
The name of the database to connect to.
Yes
Type
JDBC Driver for the database (e.g., sqlserver, oracle, mysql, etc.).
Yes
Database URL
JDBC connection string (e.g., jdbc:mysql://[hostname]:[port]/[databasename]).
Yes
Steps to Use the Database Connector
Login to DBSync Cloud Workflow
Navigate to the DBSync website and click on Login.
Choose Cloud Workflow from the options.
Enter Login Credentials
Provide your User Name and Password and click Login.
Configure the Database Connector
Enter the required configuration details:
Username: Your database username.
Password: Your database password.
Host: The database server's hostname or IP address.
Port: The port number for the database connection.
Database: The name of the database.
Type: Select the appropriate JDBC driver for your database.
Database URL: Enter the JDBC connection string.
Define Operations
Choose the operations you want to perform, such as:
Select: Retrieve data from the database.
Insert: Add new records to the database.
Update: Modify existing records.
Delete: Remove records from the database.
Set Additional Properties (Optional)
Configure additional properties such as:
Auto Create: Set to true if you want the table to be created automatically.
Table: Specify the name of the table to write into.
Write Type: Choose between create, update, or upsert operations.
Prefix: The prefix excluding the '.' operator used for the field names.
Pkey: Comma-separated list of primary key column names (required if update or upsert).
Advanced Properties for Updating the Source
The table below lists the advanced properties that are required while updating the source.
Property
Description
Required
Default Value
Table
Name of the table to write into.
Yes
Empty
Prefix
The prefix excluding the '.' used for the field names.
No
Empty
Pkey
Comma separated list of primary key column names (required if update or upsert).
Required if Update or Upsert
True
Supported Databases
The Database connector supports all databases that are JDBC or ODBC compliant. Some of the supported databases are listed below:
Access
DB2
MySQL
Oracle
Pervasive Btrieve
PostgreSQL
Redshift
SQL Server
Save and Run the Workflow
Click Save to store your configuration.
Click the Run icon to execute the workflow. Monitor the console output for any errors or confirmation messages regarding the database operations.
Review Logs
After running the integration, check the logs to verify that the operations were successfully executed. This will help you identify any issues that may have occurred during the process.
Data Masking Support
To enhance data security and ensure compliance with regulations (such as avoiding storage of PHI in logs), DBSync provides a Log Masking feature for the Database Connector.
How It Works
Each Connection now includes a dedicated “Log Masking” tab that allows users to specify which fields should be masked in the logs. This ensures that sensitive data is never exposed during execution or troubleshooting.
Steps to Configure Log Masking
Navigate to the Connection associated with your Database Connector.
Click on the “Log Settings” tab.
In the provided input area, enter the field names that need to be masked, each separated by a new line (
Enter
).Click “Save” to apply the masking to the specified fields.
If needed, click “Reset To Default Fields” to clear custom entries and restore the default masked fields defined per application.
Benefits
Prevents exposure of sensitive or Personally Identifiable Information (PII/PHI) in system logs.
Supports compliance with data security standards.
Provides flexibility to customize masking based on integration needs.
Uses of the Database Connector
Data Synchronization: Automate the synchronization of data between different databases.
Data Migration: Facilitate the migration of data from one database to another.
Data Backup: Create backups of critical data by exporting it to another database.
Related Content
Last updated