Skip to content

Databases

Native and browser, for MySQL, PostgreSQL, CockroachDB, SQL Server, Redis, MongoDB, and Cassandra. In browser mode the built-in SQL client opens automatically. See How users connect and the database options.

All engines share the same shape - here is a full PostgreSQL example, then the per-engine differences.

postgres.json
{
  "transaction_id": "txn-pg-003",
  "protocol": "postgres",
  "username": "carol@corp",
  "target_host": "mydb.abc123.us-east-1.rds.amazonaws.com",
  "target_port": 5432,
  "target_username": "app_ro",
  "target_password": "pgpass",
  "target_database": "analytics",
  "target_tls": true,
  "expires_at": 1750000000
}
terminal
broker-bridge-api.sh checkout-create --file postgres.json

For another engine, swap protocol and target_port (and drop target_tls where it doesn’t apply). target_database means the database, keyspace, or DB index as noted:

EngineprotocolDefault porttarget_databaseNative client
MySQLmysql3306databasemysql
PostgreSQLpostgres5432databasepsql
CockroachDBcockroachdb26257databasecockroach sql / psql
SQL Servermssql1433databasesqlcmd
Redisredis6379DB index (e.g. "0")redis-cli
MongoDBmongodb27017databasemongosh
Cassandracassandra9042keyspacecqlsh
  • Native - point the client above at the Bridge’s port for that engine; the picker shows the exact command.
  • Browser - the in-page SQL client via Connect.
Last updated on