Skip to content

Database configuration.

This section provides general information about database configuration. The configuration is split into two main parts:

  1. Connection configuration - defines how to connect to your database
  2. Stream configuration - defines what data to read and how to process it

Connection Configuration

First, you need to create a connection to your database. Here's an example:

json
{
    "name": "mysql-database",
    "type": "mysql",
    "host": "localhost",
    "port": 3306,
    "username": "root",
    "password": "123456",
    "database": "source_db"
}

Connection Parameters

ParameterTypeRequiredDescriptionExample
namestringYesDescriptive name for the connection"mysql-production"
typestringYesDatabase type (mysql or postgresql)"mysql"
hoststringYesDatabase server hostname or IP"localhost"
portintegerYesDatabase server port3306
usernamestringYesDatabase user name"root"
passwordstringYesDatabase user password"123456"
databasestringYesDatabase name"source_db"
schemastringPostgreSQL onlyDatabase schema name"public"

For PostgreSQL connections, you can also specify a schema:

json
{
    "name": "postgresql-database",
    "type": "postgresql",
    "host": "localhost"
    "port": 5432,
    "username": "postgres",
    "password": "postgres",
    "database": "postgres",
    "schema": "public"
}

Supported Database Types

DBConvert Streams currently supports the following database types:

For specific configuration details for each source type, please refer to their respective documentation sections.

DBConvert Streams - event driven replication for databases