Skip to content
Merged
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
8 changes: 6 additions & 2 deletions beta-updates.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Beta updates
description: "Get each new version before it reaches everyone, and go back to stable releases"
title: Beta updates on macOS
description: "Choose the Mac beta channel or return to stable releases"
---

import PlatformGuides from "/snippets/platform-guides.mdx";

Every new minor version ships as one or more betas before its stable release, such as `0.82.0-beta.1` ahead of `0.82.0`. Patch releases skip the beta and go straight to stable.

## Getting betas
Expand Down Expand Up @@ -31,3 +33,5 @@ Open an issue on [GitHub](https://github.com/TableProApp/TablePro/issues) with t
## For administrators

The channel is the `com.TablePro.updates.receivesBetaUpdates` key, `true` for Beta, which a configuration profile can pin for a fleet. See [Managed updates](/security/managed-updates).

<PlatformGuides />
6 changes: 4 additions & 2 deletions databases/index.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
---
title: Supported Databases
description: All 47 engines TablePro connects to, their default ports, and which ones need a plugin
description: All 47 engines on macOS, their default ports, and which ones need a plugin
---

import DriverCounts from "/snippets/driver-counts.mdx";

Forty-seven engines, and every one of them is free to use. What differs between them is where the
On macOS, every engine in this list is free to use. What differs between them is where the
driver comes from, not what the license covers.

<DriverCounts />

For other platforms, see [Linux engines](/linux/connect#engines) or [iPhone and iPad engines](/ios#supported-databases).

## The full list

| Database | Default port | Driver |
Expand Down
14 changes: 9 additions & 5 deletions development/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@ title: Contributing
description: Build TablePro from source, contribute a change, or write a database driver plugin
---

Building and contributing to the app is documented in the app repository, next to the code it describes:
Choose the source guide for the platform you want to work on:

- [apple/CONTRIBUTING.md](https://github.com/TableProApp/TablePro/blob/main/apple/CONTRIBUTING.md): setup, building, tests, code style, architecture, pull requests and translation.
- [AGENTS.md](https://github.com/TableProApp/TablePro/blob/main/AGENTS.md) and [apple/AGENTS.md](https://github.com/TableProApp/TablePro/blob/main/apple/AGENTS.md): the invariants and rules every change has to meet.
- [apple/RELEASING.md](https://github.com/TableProApp/TablePro/blob/main/apple/RELEASING.md): release builds, notarization and the release tag.
| Platform | Start here | Covers |
|---|---|---|
| macOS and iOS | [Apple contributing guide](https://github.com/TableProApp/TablePro/blob/main/apple/CONTRIBUTING.md) | Setup, builds, tests, code style, and translation |
| Linux | [Linux contributing guide](https://github.com/TableProApp/TablePro/blob/main/linux/CONTRIBUTING.md) | Development workflow, checks, and pull requests |
| Windows, in development | [Windows source](https://github.com/TableProApp/TablePro/tree/main/windows) | App, interop library, tests, and build instructions |

Read the repository's [AGENTS.md](https://github.com/TableProApp/TablePro/blob/main/AGENTS.md) and the platform's own rules before making a change. For Mac releases, follow [apple/RELEASING.md](https://github.com/TableProApp/TablePro/blob/main/apple/RELEASING.md).

These pages live in [TableProApp/docs](https://github.com/TableProApp/docs). A docs change that goes with an app change is a pull request there.

## Plugins
## macOS plugins

<CardGroup cols={3}>
<Card title="Plugin Development" icon="puzzle-piece" href="/development/plugin-development">
Expand Down
44 changes: 31 additions & 13 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "https://mintlify.com/docs.json",
"theme": "aspen",
"name": "TablePro",
"description": "TablePro is a native macOS database client for MySQL, PostgreSQL, SQLite, MongoDB, Redis and more, built on AppKit and SwiftUI with a plugin-based driver system.",
"description": "Database guides for TablePro on macOS, iPhone and iPad, and Linux beta. Windows is in development.",
"colors": {
"primary": "#A85A00",
"light": "#FFBB6B",
Expand Down Expand Up @@ -196,19 +196,30 @@
"navigation": {
"tabs": [
{
"tab": "Documentation",
"tab": "Overview",
"icon": "house",
"groups": [
{
"group": "Start here",
"pages": [
"index",
"faq",
"changelog"
]
}
]
},
{
"tab": "macOS",
"groups": [
{
"group": "Start here",
"pages": [
"installation",
"beta-updates",
"quickstart",
"switching",
"faq",
"troubleshooting",
"changelog"
"troubleshooting"
]
},
{
Expand Down Expand Up @@ -395,13 +406,6 @@
"customization/notifications"
]
},
{
"group": "iPhone and iPad",
"icon": "mobile",
"pages": [
"ios/index"
]
},
{
"group": "Security and privacy",
"icon": "shield",
Expand All @@ -413,10 +417,24 @@
"features/acknowledgements"
]
}
],
"icon": "apple"
},
{
"tab": "iPhone and iPad",
"icon": "mobile",
"groups": [
{
"group": "iPhone and iPad",
"icon": "mobile",
"pages": [
"ios/index"
]
}
]
},
{
"tab": "Linux",
"tab": "Linux beta",
"icon": "linux",
"groups": [
{
Expand Down
10 changes: 7 additions & 3 deletions faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Short answers on licensing, privacy, offline use, database coverage

import DriverCounts from "/snippets/driver-counts.mdx";

Short answers only, each linking to the page that carries the detail. Anything not covered is worth an issue on [GitHub](https://github.com/TableProApp/TablePro/issues), where driver requests and support questions are tracked in the open.
Start with [your platform](/). Unless a question names another platform, these answers describe macOS. For Linux setup and support, use the [Linux guides](/linux/install). Report unanswered questions on [GitHub](https://github.com/TableProApp/TablePro/issues).

## Cost and licensing

Expand Down Expand Up @@ -88,11 +88,15 @@ Through iCloud, with a Pro or Team license. Sync is off by default and each cate
</Accordion>

<Accordion title="Is there an iPhone app?">
Yes, for iPhone and iPad on iOS 18 or later. It reads the same CloudKit data as the Mac app but carries connections, groups, and tags only. See [iPhone and iPad](/ios).
Yes. The stable iPhone and iPad app needs no license. See [iPhone and iPad](/ios) for requirements, connections, queries, and sync.
</Accordion>

<Accordion title="Is there a Linux version?">
Yes, in beta: packages for Ubuntu 26.04 and 26.10 and Fedora 44 and later, and a Flatpak bundle for other distributions. It is a separate app with its own [engines](/linux/connect#engines), and none of the [paid features](/features/licensing) yet. See [Install on Linux](/linux/install).
Yes. The public beta has its own [supported engines](/linux/connect#engines). [Install on Linux](/linux/install) covers the beta PPA, COPR, Flatpak repository, and release packages. [Licensing](/features/licensing) links to Linux account details.
</Accordion>

<Accordion title="Is there a Windows version?">
The Windows app is in development and has no release yet. Follow progress in the [Windows source directory](https://github.com/TableProApp/TablePro/tree/main/windows).
</Accordion>

<Accordion title="How often does TablePro release, and will it keep interrupting me?">
Expand Down
2 changes: 1 addition & 1 deletion features/licensing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ There are two tiers, Pro and Team. Team includes everything in Pro. Starter was
| [Team Catalog](/features/connection-sharing) | Team | Menu item hidden |
| [Team Library](/features/team) | Team | Menu item hidden |

The [Linux beta](/linux/install) follows the same licensing model as the Mac. The paid features listed here are Mac-only for now and come to Linux later.
The table describes macOS features. The [Linux beta](/linux/install) uses the same plans and accounts; its [account guide](https://github.com/TableProApp/TablePro/blob/main/linux/README.md#tablepro-account) covers device limits and sign-in. The [iPhone and iPad app](/ios) needs no license.

The activation instructions on this page apply to the Mac.

Expand Down
6 changes: 3 additions & 3 deletions features/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Features Overview
description: Every feature page, grouped the way the sidebar groups them
title: macOS features
description: Mac feature guides, grouped by task
---

First time here: [Quick Start](/quickstart) gets you from install to a query without a database server of your own, using the bundled Chinook sample.
Expand All @@ -15,7 +15,7 @@ First time here: [Quick Start](/quickstart) gets you from install to a query wit
Connect and run a query, sample database included.
</Card>
<Card title="Switching to TablePro" icon="right-left" href="/switching">
Import from TablePlus, Sequel Ace, DBeaver, and others.
Import connections from another database client.
</Card>
<Card title="FAQ" icon="circle-question" href="/faq">
Licensing, privacy, offline use, coverage.
Expand Down
Binary file removed images/linux-connect-dialog-dark.png
Binary file not shown.
Binary file modified images/linux-connect-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/linux-data-grid-dark.png
Binary file not shown.
Binary file modified images/linux-data-grid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/linux-shortcuts-dialog-dark.png
Binary file not shown.
Binary file removed images/linux-shortcuts-dialog.png
Binary file not shown.
Binary file removed images/linux-sql-editor-dark.png
Binary file not shown.
Binary file modified images/linux-sql-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 25 additions & 24 deletions index.mdx
Original file line number Diff line number Diff line change
@@ -1,41 +1,42 @@
---
title: Introduction
description: Native database apps for Mac, iPhone, iPad and Linux (beta)
description: Database guides for macOS, iPhone and iPad, and the Linux beta
---

import DriverCounts from "/snippets/driver-counts.mdx";
Choose your platform to install the app, connect to a database, and run your first query. Database support and features differ by platform.

Every engine, the SQL editor, the data grid, import, export, and the AI assistant cost nothing, and there is no trial countdown. Paid tiers cover iCloud sync, encrypted connection export, environment variables in connection fields, Linked Folders, Query Insights, result charts, and team sharing ([Licensing](/features/licensing)). Use the Mac app, the [iPhone and iPad app](/ios), or the [Linux beta](/linux/install). Paid features are Mac-only for now.

<Frame caption="TablePro - Native macOS Database Client">
<img className="block dark:hidden" src="/images/app.png" alt="TablePro main interface" />
<img className="hidden dark:block" src="/images/app-dark.png" alt="TablePro main interface" />
</Frame>

<CardGroup cols={3}>
<Card title="Install it" icon="download" href="/installation">
Homebrew or the DMG, on macOS 13 and later.
<CardGroup cols={2}>
<Card title="macOS" icon="apple" href="/installation">
Stable. Install with Homebrew or a DMG, then follow the Mac quickstart.
</Card>
<Card title="iPhone and iPad" icon="mobile" href="/ios">
Stable. Set up connections, browse tables, and run queries. No license required.
</Card>
<Card title="Connect to something" icon="plug" href="/quickstart">
A first connection and a first query, or the bundled sample database if you have no server.
<Card title="Linux beta" icon="linux" href="/linux/install">
Install from the beta PPA, COPR, or Flatpak repository.
</Card>
<Card title="Coming from another client" icon="right-left" href="/switching">
Import connections from TablePlus, Sequel Ace, DBeaver, DataGrip and others.
<Card title="Windows" icon="windows" href="https://github.com/TableProApp/TablePro/tree/main/windows">
In development. No release is available. Follow the source repository for progress.
</Card>
</CardGroup>

## Supported databases
## Start on macOS

<Frame caption="Browse and edit a table on macOS">
<img className="block dark:hidden" src="/images/app.png" alt="Mac connection window with a table sidebar and data grid" />
<img className="hidden dark:block" src="/images/app-dark.png" alt="Mac connection window with a table sidebar and data grid" />
</Frame>

[Run your first query](/quickstart), [import existing connections](/switching), or find your engine in [Supported databases](/databases). For other platforms, use the [iPhone and iPad guide](/ios) or the [Linux connection guide](/linux/connect).

<DriverCounts />
## Free and paid

From MySQL and PostgreSQL to DynamoDB, Spanner and Redis, each engine has its own page.
[Supported Databases](/databases) lists them all with their default ports and says which ones
arrive as a plugin.
Connect, query, and edit data without a trial countdown. [Licensing](/features/licensing) covers the Mac's Pro and Team features and links to Linux account details.

## Open source

The source, plugins included, is under the [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.html). A TablePro license key is a separate thing: it activates the paid features, not the app.
The source, plugins included, is under the [GNU Affero General Public License v3.0 or later](https://www.gnu.org/licenses/agpl-3.0.html). A TablePro license key activates paid features; it is separate from the source license.

<Card title="GitHub Repository" icon="github" href="https://github.com/TableProApp/TablePro">
View source code, report issues, and contribute to TablePro.
<Card title="GitHub repository" icon="github" href="https://github.com/TableProApp/TablePro">
Read the source, report an issue, or contribute a change.
</Card>
6 changes: 5 additions & 1 deletion installation.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Installation
title: Install on macOS
description: Install TablePro via Homebrew or DMG on macOS 13.0+
---

import PlatformGuides from "/snippets/platform-guides.mdx";

Homebrew is the short route: `brew install --cask tablepro`. Everyone else takes the DMG.

## System requirements
Expand Down Expand Up @@ -51,3 +53,5 @@ rm ~/Library/Preferences/com.TablePro.plist
Connection passwords are in the macOS Keychain and survive both commands. Delete them in Keychain Access by searching for `com.TablePro`. Data already synced through iCloud stays in your iCloud account.

Building from source is in [apple/CONTRIBUTING.md](https://github.com/TableProApp/TablePro/blob/main/apple/CONTRIBUTING.md#setup). A launch that fails or a connection that will not open is in [Troubleshooting](/troubleshooting).

<PlatformGuides />
22 changes: 16 additions & 6 deletions linux/connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ A window holds several connection sessions and their tabs. The selected tab deci

Opening a connection that is already open brings its window and session forward. **New Window** (`Ctrl+Shift+N`) starts another with the connection list. **Open Database…** on a connection's sidebar row opens another database as a session in the same window.

<Frame caption="A PostgreSQL connection through an SSH tunnel">
<img className="block dark:hidden" src="/images/linux-connect-dialog.png" alt="The connect dialog with Connection, Authentication, Security, SSH Tunnel and Options groups for a PostgreSQL server" />
<img className="hidden dark:block" src="/images/linux-connect-dialog-dark.png" alt="The connect dialog with Connection, Authentication, Security, SSH Tunnel and Options groups for a PostgreSQL server" />
<Frame caption="Configure a PostgreSQL SSH tunnel before testing the connection">
<img src="/images/linux-connect-dialog.png" alt="PostgreSQL dialog with SSH enabled for bastion.example.com, username deploy, and password authentication" />
</Frame>

## Engines
Expand All @@ -36,7 +35,7 @@ Redshift, CockroachDB, TiDB, OceanBase and Databend are untested on Linux. Suppo
## Limits

- Binary, array, spatial, composite and variant cells are read-only. Inspect or copy them in the grid; use a query to change them.
- Enter time and timestamp values as text, such as `13:45:00` or `2026-11-05 13:45:00`. Include an offset for types that store one. Invalid values stay in the editor with an error; correct them before saving.
- Duration values, such as MySQL TIME values longer than a day, need text entry. For times of day and timestamps, use the clock in Row Details or enter text. Include an offset for types that store one.
- Redis Cluster and Sentinel are unsupported. Connect to a standalone Redis server instead.

## Add a connection
Expand Down Expand Up @@ -84,11 +83,22 @@ Pick **Read-Only** for a production server you only read. Moving to or from it r
| Mode | Connection |
|---|---|
| **Disable** | Plain, no TLS |
| **Prefer** | PostgreSQL, MySQL and MariaDB only. Encrypted if the server offers TLS; otherwise unencrypted. The server certificate is not checked |
| **Require** | Encrypted. The server certificate is not checked |
| **Verify full**, the default | Encrypted. The certificate must be valid for the server name |
| **Verify full** | Encrypted. The certificate must be valid for the server name |
| **Strict** | SQL Server only. TLS before the login, as TDS 8.0 needs. SQL Server 2022 or later on Windows, 2025 or later on Linux |

Keep **Verify full** unless the server has no certificate this computer can check. For a server signed by your own certificate authority, choose its PEM file in **CA certificate** rather than dropping to **Require**.
Choose **Verify full** to check the server certificate. For a server signed by your own certificate authority, choose its PEM file in **CA certificate** rather than dropping to **Require**.

New connections start with these defaults:

| Engine | Default encryption | Changes with connection options |
|---|---|---|
| PostgreSQL, MySQL, MariaDB | **Prefer** | None |
| SQL Server | **Verify full** | None |
| ClickHouse | **Disable** | **Verify full** on ports 443 and 8443 |
| MongoDB | **Disable** | **Verify full** with **DNS Seed List** on |
| Cassandra, ScyllaDB, Redis | **Disable** | None |

- **Client certificate** and **Client key** log in with a certificate, on every network engine but SQL Server.
- **TLS server name** checks the certificate against another name than the host. MySQL and MongoDB take it only through an SSH tunnel.
Expand Down
7 changes: 3 additions & 4 deletions linux/data-grid.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@ tag: "Beta"

A table opened from the sidebar fills a table tab one page at a time, 1,000 rows by default. The bottom bar switches the tab between 100 and 10,000 rows per page, and **Preferences > General > Default page size** sets where new tabs start.

<Frame caption="An edited cell and a new row wait in the pending changes bar until Save">
<img className="block dark:hidden" src="/images/linux-data-grid.png" alt="A table tab with a filter rule above the grid, one modified cell, one new row and the pending changes bar with Discard and Save" />
<img className="hidden dark:block" src="/images/linux-data-grid-dark.png" alt="A table tab with a filter rule above the grid, one modified cell, one new row and the pending changes bar with Discard and Save" />
<Frame caption="Review the pending stock edit before choosing Save">
<img src="/images/linux-data-grid.png" alt="Products table with the Hand Grinder stock cell changed to 24 and one unsaved change" />
</Frame>

## Pages and row counts
Expand All @@ -32,7 +31,7 @@ A table's filter is kept, and so is each tab's across a restart.

## Edit rows

Editing works in a table tab on a table with a primary key. Rows a query returns in the SQL editor are read-only, and so are key, generated and auto-increment columns. Check the [cell type limits](/linux/connect#limits) before editing other columns.
Editing works in a table tab on a table with a primary key. Query results have separate [editing requirements](/linux/sql-editor#edit-query-results). Key, generated and auto-increment columns are read-only. Check the [cell type limits](/linux/connect#limits) before editing other columns.

| To | Press |
|---|---|
Expand Down
Loading
Loading