Config File

You can configure your database connections by adding a config file. The software supports both JSON and TOML formats, so you can choose the format that best fits your workflow.

Multiple databases can be connected through the same agent, which is useful for managing development, staging, and production environments.

---

JSON Example

Create a database.json file with your database information:

{
  "databases": [
    {
      "name": "devdb",
      "type": "postgresql",
      "username": "devuser",
      "password": "changeme",
      "port": 5432,
      "host": "localhost",
      "generatedId": "16678159-ff7e-4c97-8c83-0adeff214681"
    },
    {
      "name": "mariadb",
      "type": "mysql",
      "username": "mariadb",
      "password": "changeme",
      "port": 3306,
      "host": "localhost",
      "generatedId": "16678124-ff7e-4c97-8c83-0adeff214681"
    }
  ]
}

caution

For generatedId, you will need to generate it yourself using the UUID V4 format .

TOML Example

Create a database.json file with your database information:

[[databases]]
name = "devdb"
type = "postgresql"
username = "devuser"
password = "changeme"
port = 5432
host = "localhost"
generatedId = "16678159-ff7e-4c97-8c83-0adeff214681"

[[databases]]
name = "mariadb"
type = "mysql"
username = "mariadb"
password = "changeme"
port = 3306
host = "localhost"
generatedId = "16678124-ff7e-4c97-8c83-0adeff214681"

✅ Both JSON and TOML formats are fully supported.