Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions connections/connection-form.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,29 @@ description: The four sections of the connection editor and the fields each driv

import LocalCredentialConsent from "/snippets/local-credential-consent.mdx";

The editor's sidebar lists the same four sections whatever the driver. Only Network is ever absent, and only for a driver that connects directly and cannot negotiate TLS.
The editor is one scrolling form. General, Network and Appearance read top to bottom; the less-common Options sit behind **Advanced Options** near the end. Network is absent only for a driver that connects directly and cannot negotiate TLS.

<Frame caption="A PostgreSQL connection on the General tab">
<img className="block dark:hidden" src="/images/connection-form-fields.png" alt="Connection editor with a General, Network, Options and Appearance sidebar, credential fields filling the pane, and Test, Cancel and Save along the bottom" />
<img className="hidden dark:block" src="/images/connection-form-fields-dark.png" alt="Connection editor with a General, Network, Options and Appearance sidebar, credential fields filling the pane, and Test, Cancel and Save along the bottom" />
<Frame caption="A PostgreSQL connection, General section">
<img className="block dark:hidden" src="/images/connection-form-fields.png" alt="Connection editor as one scrolling form showing the General section's identity, connection and authentication fields, with Test, Cancel and Save along the bottom" />
<img className="hidden dark:block" src="/images/connection-form-fields-dark.png" alt="Connection editor as one scrolling form showing the General section's identity, connection and authentication fields, with Test, Cancel and Save along the bottom" />
</Frame>

| Section | Contents |
|------|----------|
| **General** | Name, database type, host, port, database, credentials |
| **General** | Name, type, environment, where the database lives, and the sign-in |
| **Network** | How the connection reaches the server, and how it is encrypted |
| **Options** | Timeouts, driver options, startup SQL, Safe Mode, Manual Commit, external and AI access, iCloud |
| **Appearance** | Icon, color, tags, group |
| **Advanced Options** | Timeouts, driver options, startup SQL, Safe Mode, Manual Commit, external and AI access, iCloud. Collapsed until you expand it |

The bar along the bottom carries **Test Connection**, **Cancel** and **Save**, plus **Save & Connect** on a new connection and **Delete** on a saved one. The space to their left holds the reason **Save** is dimmed, prefixed with the tab that holds the empty field, or the warning the last test brought back from the server.
The bar along the bottom carries **Test Connection**, **Cancel** and **Save**, plus **Save & Connect** on a new connection and **Delete** on a saved one. The space to their left holds the reason **Save** is dimmed, prefixed with the section that holds the empty field, or the warning the last test brought back from the server. A required field inside **Advanced Options** reveals that section so the error is reachable.

## General

| Field | Description |
|-------|-------------|
| **Name** | Display name in the connection list |
| **Type** | The database type. **Change…** retypes the connection and resets the fields the old type owned |
| **Environment** | Optional label: Production, Staging, Development or Local |
| **Connect Using** | MySQL, MariaDB, and PostgreSQL. **Host and Port**, or **Socket** for a server on this Mac. See Unix socket for [MySQL](/databases/mysql#unix-socket) and [PostgreSQL](/databases/postgresql#unix-socket) |
| **Host** | Empty falls back to the driver's own default, usually `localhost` |
| **Port** | Pre-filled from the database type |
Expand Down Expand Up @@ -67,7 +68,7 @@ Encryption sits below the transport. [SSL/TLS](/connections/ssl) covers the mode

## Options

**Safe Mode**, **Manual Commit**, **AI Policy** and **External Clients** share the **Access** section.
Click **Advanced Options** near the end of the form to reveal these fields. **Safe Mode**, **Manual Commit**, **AI Policy** and **External Clients** share the **Access** section.

| Field | Description |
|-------|-------------|
Expand Down
2 changes: 1 addition & 1 deletion connections/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The connection form's **Appearance** tab holds **Icon**, **Color**, **Tags** and
</Frame>

<Tip>
Red for production, green for development. On production, set **Safe Mode** to **Read-Only** under **Access** on the **Options** tab to block accidental writes. See [Safe Mode](/features/safe-mode).
Red for production, green for development. On production, set **Safe Mode** to **Read-Only** under **Access** in the **Options** section to block accidental writes. See [Safe Mode](/features/safe-mode).
</Tip>

| | How it works |
Expand Down
2 changes: 1 addition & 1 deletion connections/ssl.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ A new connection starts on the mode that matches the driver's own default, and s
| SQL Server | Preferred | FreeTDS `encryption=request`: the login over TLS, the rest in plain TCP unless the server forces encryption |
| Teradata | Disabled | Opens a TLS transport, retries on a plain socket if it fails to come up |
| MongoDB, Redis, Cassandra, ClickHouse, Elasticsearch, Typesense, SurrealDB, Weaviate, Qdrant | Disabled | Nothing. No fallback exists, so Preferred forces TLS exactly like Required |
| etcd | Disabled | Nothing. The driver never reads these fields. Set **TLS Mode** on the Options section instead, and see [etcd](/databases/etcd) |
| etcd | Disabled | Nothing. The driver never reads these fields. Set **TLS Mode** in the Options section instead, and see [etcd](/databases/etcd) |
| Trino, Presto | Disabled | Sends every request over HTTPS with no fallback, again like Required |
| SAP HANA | Verify Identity | Nothing. No fallback exists, so Preferred forces TLS exactly like Required |
| Oracle | Disabled | Connects in plain TCP, so it behaves like Disabled. A red warning appears under the picker; use Required to enforce TCPS |
Expand Down
2 changes: 1 addition & 1 deletion databases/beancount.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ After connecting, TablePro's database version display names the backend it selec

## Ledger plugins

With the Python backend, **Run Ledger Plugins** on the connection's **Options** tab starts off.
With the Python backend, **Run Ledger Plugins** on the connection's **Options** section starts off.
Only modules named `beancount.plugins.<name>` with no configuration argument run in that state.
Other Python modules and configured plugins are skipped. A ledger's `insert_pythonpath` option
does not add its folders to Python's import path while plugins run.
Expand Down
2 changes: 1 addition & 1 deletion databases/bigquery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Click **New Connection…**, select **BigQuery**, pick an auth method, enter you
| **OAuth Client ID**, **OAuth Client Secret** | OAuth only | From GCP Console > APIs & Services > Credentials |
| **OAuth Refresh Token** | No | OAuth only. Tried before the token saved by sign-in |
| **Location** | No | Processing location (`US`, `EU`, `us-central1`), sent with every query |
| **Max Bytes Billed** | No | Options tab. A query over the cap fails instead of billing |
| **Max Bytes Billed** | No | Options section. A query over the cap fails instead of billing |

There is no Database field and no URL scheme. Datasets stand in for databases: the sidebar lists them as expandable nodes, `Cmd+K` and **Database > Open Database…** move between them, and **Database > New Database…** runs `CREATE SCHEMA`. Switching does not move tabs you already have open; each stays on its own dataset. See [Tabs](/features/tabs#where-a-tab-points).

Expand Down
2 changes: 1 addition & 1 deletion databases/bigtable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The toolbar's **Instance** switcher moves between the project's instances withou
| **Service Account Key** | A path to the JSON key file, or the JSON pasted in. Stored in the Keychain |
| **Project ID** | The Google Cloud project. Empty takes the project the key names. Under Application Default Credentials, empty takes the credentials file's project, then `GOOGLE_CLOUD_PROJECT` |
| **Instance ID** | The Bigtable instance. Empty opens the instance whose ID sorts first |
| **App Profile ID** | Options tab. Routes reads and writes through that app profile. The instance's default profile when empty |
| **App Profile ID** | Options section. Routes reads and writes through that app profile. The instance's default profile when empty |

**Project ID** and **Instance ID** stand in for a host, a port and the Database field. Any instance connects, no connection URL opens one, and [SSH Tunnel](/connections/ssh-tunneling) is not offered.

Expand Down
2 changes: 1 addition & 1 deletion databases/cassandra.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ There is no Keyspace field. Pick one in the sidebar after connecting, or put it

## Consistency

Statements in the CQL editor, table browsing and grid saves run at the **Consistency** level on the connection's **Options** tab. **Default** is `LOCAL_ONE`, or `LOCAL_QUORUM` on Amazon Keyspaces. **Serial Consistency** is the level a lightweight transaction (`IF NOT EXISTS`, `IF EXISTS`, `IF` a condition) checks its condition at: `SERIAL` or `LOCAL_SERIAL`. Its **Default** leaves the choice to the server, which uses `SERIAL`.
Statements in the CQL editor, table browsing and grid saves run at the **Consistency** level on the connection's **Options** section. **Default** is `LOCAL_ONE`, or `LOCAL_QUORUM` on Amazon Keyspaces. **Serial Consistency** is the level a lightweight transaction (`IF NOT EXISTS`, `IF EXISTS`, `IF` a condition) checks its condition at: `SERIAL` or `LOCAL_SERIAL`. Its **Default** leaves the choice to the server, which uses `SERIAL`.

The result footer names the level each statement ran at, and both levels after a lightweight transaction:

Expand Down
2 changes: 1 addition & 1 deletion databases/cockroachdb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ cockroachdb://user:password@host:26257/defaultdb

## CockroachDB Cloud

A Cloud connection string carries a cluster routing parameter that the form has no field for. Copy the host, port, user, password, and database from the Cloud console, then put the routing value in **Connection Options** on the Options tab:
A Cloud connection string carries a cluster routing parameter that the form has no field for. Copy the host, port, user, password, and database from the Cloud console, then put the routing value in **Connection Options** in the Options section:

```text
--cluster=my-cluster-1234
Expand Down
2 changes: 1 addition & 1 deletion databases/elasticsearch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The connection uses the first node that answers and stays on it:
| **Hosts** | One or more nodes of the cluster, `localhost:9200` for a local node. A host without a port uses `9200`, a URL without one uses `443` or `80` |
| **Auth Method** | Username & Password, API Key, or None |
| **API Key** | Base64-encoded key. Shown when **Auth Method** is API Key |
| **Skip TLS Verification** | Options tab. Trusts any certificate, even under **Verify CA** or **Verify Identity** |
| **Skip TLS Verification** | Options section. Trusts any certificate, even under **Verify CA** or **Verify Identity** |

## Authentication

Expand Down
6 changes: 3 additions & 3 deletions databases/etcd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Click **New Connection…**, select **etcd**, enter host and port, then click **
| **Port** | Client port, `2379` by default |
| **Username / Password** | The etcd user to authenticate as. Leave both empty on a server that has no authentication |

### Options tab fields
### Options section fields

| Field | Description |
|-------|-------------|
Expand All @@ -45,7 +45,7 @@ etcd://127.0.0.1:2379
etcds://127.0.0.1:2379
```

Both schemes import. Neither switches TLS on by itself; set **TLS Mode** on the Options tab.
Both schemes import. Neither switches TLS on by itself; set **TLS Mode** in the Options section.

## Browsing keys

Expand Down Expand Up @@ -87,7 +87,7 @@ Quote a key that holds a space, a quote or an invisible character. Inside quotes

## SSL/TLS

TLS here is set by **TLS Mode** on the Options tab, not by the connection's SSL mode, and it starts **Disabled**. **Required (skip verify)** encrypts without checking the certificate, **Verify CA** checks it against the **CA Certificate** you name, and **Verify Identity** adds the hostname check. **Client Certificate** and **Client Key** cover mutual TLS under either verifying mode. See [SSL/TLS](/connections/ssl) for the concepts.
TLS here is set by **TLS Mode** in the Options section, not by the connection's SSL mode, and it starts **Disabled**. **Required (skip verify)** encrypts without checking the certificate, **Verify CA** checks it against the **CA Certificate** you name, and **Verify Identity** adds the hostname check. **Client Certificate** and **Client Key** cover mutual TLS under either verifying mode. See [SSL/TLS](/connections/ssl) for the concepts.

The **CA Certificate** may be PEM or DER. **Verify CA** needs one, since it checks no hostname, and a connection without it is refused. **Verify Identity** with no **CA Certificate** checks the system trust store. A file that cannot be read fails the connection rather than falling back to the system trust store.

Expand Down
2 changes: 1 addition & 1 deletion databases/influxdb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For a server on a private network, open the **Network** tab and set **Connect vi
| **Token** | An API token. Leave it empty for a 3.x server started with `--without-auth` |
| **Database** | The database (3.x) or bucket (2.x) the sidebar opens. Switch it later from the database list |
| **Organization** | 2.x only. Optional when the token sees one organization |
| **Skip TLS Verification** | Options tab. Trusts any certificate, even under **Verify CA** or **Verify Identity** |
| **Skip TLS Verification** | Options section. Trusts any certificate, even under **Verify CA** or **Verify Identity** |

TablePro reads the server version from `/ping` when it connects, and picks the API from it: `/api/v3` on 3.x, `/api/v2` and the v1 `/query` endpoint on 2.x. A wrong token fails the connection instead of the first query: 3.x checks it on `/ping`, and on 2.x TablePro lists one bucket with it. A 1.x server is refused at connect.

Expand Down
8 changes: 4 additions & 4 deletions databases/mongodb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The query tab is a JavaScript shell. Write `db.orders.find({status: "new"})` the
| **Username** | - | Leave empty for local dev without auth |
| **Password** | - | |
| **Database** | - | Opens straight into that database. Leave it empty to browse them all |
| **Auth Database** | - | Options tab. Where your user account lives, usually `admin` |
| **Auth Database** | - | Options section. Where your user account lives, usually `admin` |
| **Auth Mechanism** | Default | SCRAM-SHA-1, SCRAM-SHA-256, X.509, or AWS IAM, under Authentication |
| **AWS Session Token** | - | Under Authentication, once **Auth Mechanism** is AWS IAM. Kept in the Keychain |

Expand All @@ -38,7 +38,7 @@ Naming a **Database** skips listing every database on the server, which is worth

AWS IAM takes the access key ID in **Username** and the secret access key in **Password**. Temporary credentials also need their session token in **AWS Session Token**.

Also on the Options tab: **Read Preference**, **Write Concern**, **Use SRV Record**, **Replica Set** name, and **Legacy UUID Encoding**. The server has to be MongoDB 4.0 or later; the driver refuses to connect to anything older.
Also in the Options section: **Read Preference**, **Write Concern**, **Use SRV Record**, **Replica Set** name, and **Legacy UUID Encoding**. The server has to be MongoDB 4.0 or later; the driver refuses to connect to anything older.

**Write Concern** covers every insert, update and delete, from a query tab or from a save in the data grid, unless the statement passes its own `writeConcern`. Index, collection and database commands, and `db.runCommand`, go to the server as written. On a server that is not a replica set, pick **Default**, **Majority** or **1**: with **2** or **3** every write fails with `cannot use 'w' > 1 when a host is not replicated`. `journal` and `wtimeoutMS` in a pasted connection URL go out with every write too.

Expand Down Expand Up @@ -68,7 +68,7 @@ An SRV connection does not open through an SSH tunnel or another tunnel. The rec

## Replica sets

The **Hosts** field takes comma-separated pairs (`host1:27017,host2:27017,host3:27017`), the primary is discovered, and writes are routed to it. Set the replica set name on the Options tab. A multi-host URI pastes in directly:
The **Hosts** field takes comma-separated pairs (`host1:27017,host2:27017,host3:27017`), the primary is discovered, and writes are routed to it. Set the replica set name in the Options section. A multi-host URI pastes in directly:

```text
mongodb://user:pass@host1:27017,host2:27017,host3:27017/db?replicaSet=rs0
Expand Down Expand Up @@ -425,7 +425,7 @@ The MongoDB driver is compiled into TablePro Mobile, with the same C driver and

**Connection refused**: check MongoDB is running (`brew services start mongodb-community`) and that the port and `bindIp` in `mongod.conf` match what you entered.

**Authentication fails on connect**: the error names the database that was authenticated against. If your user does not live there, set **Auth Database** on the Options tab; otherwise check the username, password, and auth mechanism. The MQL editor does not parse `db.getUsers()` or `db.createUser()`; read users with `db.runCommand({"usersInfo": 1})`.
**Authentication fails on connect**: the error names the database that was authenticated against. If your user does not live there, set **Auth Database** in the Options section; otherwise check the username, password, and auth mechanism. The MQL editor does not parse `db.getUsers()` or `db.createUser()`; read users with `db.runCommand({"usersInfo": 1})`.

**Timeout**: for Atlas, add your IP to the cluster's access list first. Otherwise verify host and port and check the network and firewall.

Expand Down
2 changes: 1 addition & 1 deletion databases/oceanbase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The tenant goes in the user name: `root@test` on an observer's port 2881, `root@
| **Database** | empty | Optional. Leave it empty and open one in the tenant with `Cmd+K` |
| **SSL Mode** | Preferred | TLS first, plain text if the server refuses |

**Release the Server Connection After** is on the Options tab. AWS IAM, Cloud SQL Auth Proxy and Unix socket are not offered; reach a private cluster through an [SSH tunnel](/connections/ssh-tunneling).
**Release the Server Connection After** is in the Options section. AWS IAM, Cloud SQL Auth Proxy and Unix socket are not offered; reach a private cluster through an [SSH tunnel](/connections/ssh-tunneling).

## Connection URL

Expand Down
6 changes: 3 additions & 3 deletions databases/redis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ The sidebar splits keys into folders at every `:`, and each key gets a grid row
| **Port** | `6379` | Standalone only |
| **Username** | - | Redis 6 ACL user, sent as `AUTH username password`. Empty signs in as `default` |
| **Password** | - | Empty for a server with no `requirepass`, and for a `nopass` ACL user |
| **Database Index** | `0` | Options tab. Type the index or use the stepper; connecting fails with the server's error if it has no such database |
| **Key Separator** | `:` | Options tab. What the sidebar splits key names on |
| **Database Index** | `0` | Options section. Type the index or use the stepper; connecting fails with the server's error if it has no such database |
| **Key Separator** | `:` | Options section. What the sidebar splits key names on |

No minimum server version. ACL users need Redis 6, a Sentinel ACL user needs 6.2, and Cluster mode reads routing tips from Redis 7 where they exist.

Expand Down Expand Up @@ -86,7 +86,7 @@ Set **Authentication** to an AWS IAM mode (Access Key, Profile, or SSO). A short

## Browsing keys

`user:1` and `user:2` sit under a `user` folder, nested as deep as the key goes (`app:cache:session:1`). Change the separator on the Options tab. When the tree cannot load, the server's error takes its place; right-click **Keys** and choose **Refresh** to try again.
`user:1` and `user:2` sit under a `user` folder, nested as deep as the key goes (`app:cache:session:1`). Change the separator in the Options section. When the tree cannot load, the server's error takes its place; right-click **Keys** and choose **Refresh** to try again.

<Frame caption="Keys grouped by namespace with type-aware values">
<img className="block dark:hidden" src="/images/redis-key-browser.png" alt="Redis keys grouped by namespace in the sidebar with values in the data grid" />
Expand Down
Loading
Loading