# Database

## **Overview**

The **Database Connector** in **DBSync Cloud Workflow** enables seamless integration between relational databases and other systems such as CRM platforms, accounting software, e-commerce applications, and SaaS platforms. It provides secure access to process data from databases by exposing database tables, views, and queries as usable objects within DBSync workflows.

Using the database connector, organizations can automate database-driven workflows, synchronize data in real time or batch, and eliminate manual database exports or imports.

## **Key Benefits**

**For Business Users:**

* **Unified Data Flows:** Integrate critical data stored in databases with other enterprise systems for consistent insights.
* **Automated Processes:** Eliminate manual tasks like exporting, transforming, and loading data.
* **Improved Decision-Making:** Enable real-time access to database information across applications.

**For Technical Teams:**

* **Broad Database Support:** Connect to multiple database types, such as MySQL, SQL Server, Oracle, PostgreSQL, and more.
* **Flexible Configuration:** Use custom SQL queries, table releases, and dynamic field mappings.
* **Secure Access:** Leverages secure connections (SSL/TLS) and credential-based authentication.

## **Uses**

Use the Database connector to facilitate tasks. For example,

* **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.

**PRO TIP**

Always ensure your database credentials have the necessary privileges to perform the desired operations to avoid permission-related issues during execution.

## **Supported Databases**

The Database Connector supports all databases that are JDBC or ODBC compliant. Some of the supported databases are listed below:

* Access
* AWS Athena
* DB2
* FileMaker
* MySQL
* Oracle
* Pervasive Btrieve
* PostgreSQL
* Redshift
* SQL Server
* Sybase

<figure><img src="https://content.gitbook.com/content/v9avy716UiAsS24zOznZ/blobs/2r3AUJzNt1hwaDXlEgG1/Unknown%20image" alt=""><figcaption></figcaption></figure>

Whether your database is on-premises or hosted in the cloud, the Database Connector can securely connect to it and expose tables and views for workflow use.

## **Prerequisites**

Before configuring the Database Connector, ensure the following prerequisites are met:

1. **DBSync Access**

* A valid DBSync Cloud Workflow account with access to the Database connector.

2. **Database Credentials**

* Valid database credentials, including username, password, host/IP address, port and other database specific credentials with sufficient privileges to access that particular database.

**Note:** The on-demand version of DBSync cannot connect to databases hosted locally; the database must be accessible over the network, or you can use DBSync remote agent to configure it.

## **Connector Configuration**

Each database connection in DBSync represents a single database instance. If you need to connect to multiple databases (for example, development, QA, and production), you must create separate connector entries for each.

### **Connection Parameters**

| Property      | Description                                                                             | Required | **Default Values** |
| ------------- | --------------------------------------------------------------------------------------- | -------- | ------------------ |
| Database Type | JDBC Driver for the database (For example, sqlserver, oracle, mysql, etc.).             | Yes      |                    |
| 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      |                    |
| Database URL  | JDBC connection string (For example, jdbc:mysql://\[hostname]:\[port]/\[databasename]). | Yes      |                    |

**Note:** Depending on the database you use, additional database specific parameters might be required for completing the database connector configuration.

Once configured, the connector enables secure and managed access to your database within DBSync workflows.

## **Supported Operations**

DBSync Database connector supports the following database operations:

* **Select:** Retrieve data from the database.
* **Insert:** Add new records to the database.
* **Upsert:** Update/insert records in the database
* **Update:** Modify existing records.

## **Quick Setup Guide**

Follow these steps to configure the database connector:

1. **Login to DBSync Cloud Workflow**

* Use your DBSync credentials to access the platform.

2. **Add a New Connector**

* Navigate to the connectors list in the Apps pane and select Database Connector.

3. **Provide Connection Details**

* In the Database connector configuration page, enter the required configuration details:
  * **Database Type:** Select the appropriate JDBC driver for your database.
  * **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.
  * **Database URL**: Enter the JDBC connection string..

4. **Test Connection**

* Use the **Test Connection** button to verify connectivity and credentials.

5. **Save Configuration**

* Once the connection is successful, save your configuration.

Once saved, your database is available for use in workflows and data synchronization tasks.

## Additional Properties

Drag and drop the **Transform and Write** Flow action and click **Configure** to define the following additional properties for the target database:

* **Write Type:** Select whether you want to insert, update, or upsert data from the target database.
* **Table:** Provide details for the table in which you want to perform the Write Operation.
  * Either select the name of the table to write data into,
  * Or, select *Auto Create* to perform the write operations into a new table.&#x20;

**Note:** In case you select *Auto Create* from the dropdown, specify the name of the new table that will be created in a new **Table** field that appears.

* **Prefix:** The prefix excluding the '.' operator used for the field names.
* **Ignore Key Generation**: Controls how primary keys (IDs) are handled during inserts.
* **Batch Size**: Number of records DBSync processes in a single commit
* **Pkey:** Comma-separated list of primary key column names (required if update or upsert).

  <figure><img src="https://1036205596-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv9avy716UiAsS24zOznZ%2Fuploads%2FiC2MaUcwZjta7FeIGSyK%2Fimage.png?alt=media&#x26;token=5253e7b7-ddaa-42ae-a9f0-8d88d270ed33" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1036205596-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv9avy716UiAsS24zOznZ%2Fuploads%2F3FTtFmgX9ty3z2kr8wnv%2Fimage.png?alt=media&#x26;token=75ffb98b-a15b-4c33-bdd6-79b0b2a23179" alt=""><figcaption></figcaption></figure>

## **Common Use Cases**

* **Data Replication:** Replicate database tables into cloud applications or data warehouses.
* **Real-Time Dashboards:** Push database updates to BI and analytics systems.
* **ETL Workflows:** Extract, transform, and load data between databases and target systems.
* **Cross-System Sync:** Keep master and transaction records synchronized across multiple apps.

## **Summary**

The **Database Connector** in **DBSync Cloud Workflow** delivers powerful and flexible integration capabilities with relational databases. It supports querying, transforming, and synchronizing database data with external systems through secure and configurable connections. With broad database support and flexible query options, organizations can automate data flows and maintain data consistency throughout their technology ecosystem.

## **Frequently Asked Questions (FAQ)**

**Can I connect to multiple databases?**

Yes - define separate connector entries for each database instance.

**Does the Database Connector support bi-directional data flow?**

Yes, the Database Connector can be configured for both bi-directional and uni-directional data flows.

**How frequently can data be synced with the supported databases?**

Data synchronization can be performed every minute.

**Is this connector available in both on-demand and on-premise versions?**

Yes, the Database Connector can be used with both on-demand and on-premise versions of DBSync Cloud Workflow.

**How can I try the Database Connector before purchasing a license?**

DBSync offers a free trial after completing the signup process.

**Can both source and target act as Database?**

Yes, you can use the Database Connector to communicate with different databases or the same database with different user instances.

**Do I need to install drivers?**

DBSync Cloud Workflow manages drivers automatically for cloud-accessible databases; for on-premise connectivity, ensure drivers and firewall rules are configured correctly.

**Is data encrypted in transit?**

Yes, connections can use SSL/TLS to secure data movement.

**Can I use schema names with tables?**

Yes, if your database supports schemas (For example, PostgreSQL), you can specify schema names in queries.

**Does the connector support stored procedures?**&#x20;

Yes, you can invoke stored procedures via SQL within workflow tasks.

### **Related Content**

* [DBSync SQL Server Integration](https://www.mydbsync.com/workflow/sql-server): Guide to configure SQL Server with DBSync Cloud Workflow.
* [Remote agent](https://docs.mydbsync.com/cloud-workflow/ipaas/remote-agent): If your database is hosted on a local or on-premise machine (i.e., behind a firewall or not publicly accessible)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mydbsync.com/cloud-workflow/2026_connectors_new/database.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.