Skip to the content
mantichora_/docs

Kinds of connection

Sixteen kinds of database are built in, and one form makes a connection to any of them. Most want a host and a port; two want a file, and ODBC reaches whatever driver this machine has.

The sixteen kinds

The Database kind cards, in the order the form shows them, with what each asks for and the port it fills in.

kindasks forport
PostgreSQLhost5432
MySQLhost3306
SQLitea database file—
Oraclehost; needs Oracle Instant Client1521
Microsoft SQL Serverhost1433
ClickHousehost, over HTTP8123
Snowflakethe account’s address as the host443
DuckDBa database file—
MongoDBhost27017
Redishost; the database is a number6379
Apache Cassandrahost9042
ODBCa DSN or a connection string—
Arrow Flight SQLhost31337
Trinohost8080
Elasticsearch / OpenSearchhost9200
SAP HANAhost; the database is a tenant30015

Every driver but two is built in: there is nothing to download and nothing to choose. Oracle loads Oracle Instant Client, which Oracle licenses separately: download it and add its folder to PATH on Windows or LD_LIBRARY_PATH on Linux. ODBC uses the ODBC driver installed on this machine for the database, named in the DSN or the connection string.

Servers that speak another’s protocol

A connection of the PostgreSQL kind also reaches Amazon Redshift, CockroachDB, CrateDB, YugabyteDB, Materialize, GreptimeDB, openGauss and Greenplum; one of the MySQL kind reaches MariaDB, TiDB, OceanBase, Apache Doris and GreptimeDB; Elasticsearch / OpenSearch reaches both. Once connected, the status bar names the server it found, and a command that server cannot answer is greyed with the reason: CockroachDB, for one, writes no plan to explain.

The other tabs

SSH tunnel appears when Reach it through an SSH jump host is on (SSH jump hosts). Options holds the Colour drawn beside the connection in the tree. On General, besides the address, are the marks of Production and read-only, Do not record the statements of this connection, which keeps its statements out of the history, and, for server kinds, Open one connection instead of two.

A SQLite file in two clicks

The + above the tree has New connection to a SQLite file, which picks an existing file, and New SQLite database, and a connection to it, which makes one. Neither opens the form.

Taking connections from another application

Import connections (in the File menu, and under +) reads DataGrip’s dataSources.xml, with the SSH jump hosts beside it, or a JSON file TablePlus exported. It brings PostgreSQL, MySQL, SQLite, SQL Server, Cassandra and Redis connections; the rest are listed as skipped.

Only the address, port, database, user and name come across, and from DataGrip the jump host. No password, no SSL settings and no read-only flag: the password is asked for the first time you connect. Every imported connection arrives marked Production, so it asks before a risky statement until you clear the mark.