Database configuration.
This section provides general information about database configuration. The configuration is split into two main parts:
- Connection configuration - defines how to connect to your database
- 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
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
name | string | Yes | Descriptive name for the connection | "mysql-production" |
type | string | Yes | Database type (mysql or postgresql ) | "mysql" |
host | string | Yes | Database server hostname or IP | "localhost" |
port | integer | Yes | Database server port | 3306 |
username | string | Yes | Database user name | "root" |
password | string | Yes | Database user password | "123456" |
database | string | Yes | Database name | "source_db" |
schema | string | PostgreSQL only | Database 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:
- MySQL/ MariaDB
- Amazon RDS for MySQL
- Amazon Aurora (MySQL Compatible)
- PostgreSQL/ CockroachDB
- Amazon RDS for PostgreSQL
- Amazon Aurora (PostgreSQL Compatible)
For specific configuration details for each source type, please refer to their respective documentation sections.