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
11 changes: 10 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -457,14 +457,23 @@
]
},
{
"tab": "Windows preview",
"tab": "Windows",
"icon": "windows",
"groups": [
{
"group": "TablePro for Windows",
"pages": [
"windows/install",
"windows/connect",
"windows/sql-editor",
"windows/data-grid",
"windows/browsing",
"windows/import-export",
"windows/mcp",
"windows/command-line",
"windows/links",
"windows/settings",
"windows/keyboard-shortcuts",
"windows/account"
]
}
Expand Down
2 changes: 1 addition & 1 deletion faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Yes. The public beta has its own [supported engines](/linux/connect#engines). [I
</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).
Yes, for Windows 10 version 1809 and later and Windows 11. [Install on Windows](/windows/install) covers App Installer, winget and the release bundle, and lists what the Mac app has that Windows does not yet. Its engines are on [Connect](/windows/connect#engines).
</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 @@ -23,7 +23,7 @@ There are two paid plans, Pro and Team. Team includes everything in Pro. Starter
| [Team Catalog](/features/connection-sharing) | Team | Menu item hidden |
| [Team Library](/features/team) | Team | Menu item hidden |

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 Windows preview signs in to the same accounts: see [TablePro account](/windows/account). The [iPhone and iPad app](/ios) needs no plan.
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 [Windows app](/windows/install) signs in to the same accounts: see [TablePro account](/windows/account). The [iPhone and iPad app](/ios) needs no plan.

Signed out, a row, overlay or dialog offers **Sign In** and **Purchase License**. Signed in to an account without the feature, it offers **Upgrade Plan**, which opens the pricing page. A plan you already hold is never offered for sale: when it could not be checked, the gate says what **Settings > Account** says and offers **Try Again**, and past the [device limit](#devices) it offers **Open Account Settings…**. Everything else in the app works without a plan.

Expand Down
Binary file added images/windows-connection-form-dark.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 added images/windows-connection-form.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 added images/windows-csv-import-dark.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 added images/windows-csv-import.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 added images/windows-import-from-app-dark.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 added images/windows-import-from-app.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 added images/windows-link-query-dark.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 added images/windows-link-query.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 added images/windows-mcp-settings-dark.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 added images/windows-mcp-settings.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 added images/windows-new-connection-dark.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 added images/windows-new-connection.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 added images/windows-results-json-dark.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 added images/windows-results-json.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 added images/windows-row-details-dark.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 added images/windows-row-details.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 added images/windows-settings-dark.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 added images/windows-settings.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 added images/windows-sql-editor-dark.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 added images/windows-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.
8 changes: 4 additions & 4 deletions index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Introduction
description: Database guides for macOS, iPhone and iPad, and the Linux beta
description: Database guides for macOS, Windows, iPhone and iPad, and the Linux beta
---

Choose your platform to install the app, connect to a database, and run your first query. Database support and features differ by platform.
Expand All @@ -15,8 +15,8 @@ Choose your platform to install the app, connect to a database, and run your fir
<Card title="Linux beta" icon="linux" href="/linux/install">
Install from the beta PPA, COPR, or Flatpak repository.
</Card>
<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 title="Windows" icon="windows" href="/windows/install">
Install with App Installer or winget on Windows 10 1809 or later and Windows 11.
</Card>
</CardGroup>

Expand All @@ -27,7 +27,7 @@ Choose your platform to install the app, connect to a database, and run your fir
<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).
[Run your first query](/quickstart), [import existing connections](/switching), or find your engine in [Supported databases](/databases). For other platforms, use the [Windows guide](/windows/install), the [iPhone and iPad guide](/ios) or the [Linux connection guide](/linux/connect).

## Free and paid

Expand Down
2 changes: 1 addition & 1 deletion snippets/platform-guides.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
For another platform, follow the [iPhone and iPad guide](/ios) or the [Linux guide](/linux/install). [All platforms](/) lists availability.
For another platform, follow the [Windows guide](/windows/install), the [iPhone and iPad guide](/ios) or the [Linux guide](/linux/install). [All platforms](/) lists availability.
1 change: 0 additions & 1 deletion windows/account.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: TablePro account
description: Sign in to your TablePro account on Windows, check your plan, and remove a device from the license
tag: "Preview"
---

Connections, queries and every other part of the app work signed out. [Shared links](/features/shared-links) need an account, and signing in puts your Free or Pro plan on this computer. The account is the one the Mac and Linux apps use.
Expand Down
44 changes: 15 additions & 29 deletions windows/browsing.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
---
title: Browsing a connection
description: Filter a table, read its structure and DDL, open routines and triggers, export or share results, and find past queries in TablePro for Windows
tag: "Preview"
description: Work in the object tree, filter a table, read its structure and DDL, open routines and triggers, share results, and find past queries in TablePro for Windows
---

Every object in the tree opens in a tab. Tables and views open as rows, and functions, procedures, triggers and sequences open as their source, read only.

## The object tree

Objects sit in a folder per kind, with their count. Schemas show only when there is more than one besides the system ones. A folder lists its first 500 objects; **Show all** opens the rest in a list. Type in **Filter objects** (`Ctrl+P`) to find any object across schemas, names that start with the text first. `Ctrl+B` hides or shows the tree, and `F5` reads it again.

Click a table or view to open its rows, or bring its open tab forward. Right-click it for **Open in new tab**, **Show structure**, **Show DDL**, **Copy name** and **Import CSV...**, and, where the engine has them and the connection is not read only, **Truncate...** and **Drop...**.

A schema's menu has **New schema...** and **Drop schema**, or **New database...** and **Drop database** where the server's databases are its schemas. **New database...** and **New schema...** are in the **Database** menu too. Each shows its statements under Safe Mode and runs once you confirm. The engine's own databases and schemas, and the one you are in, are never offered for a drop.

## Filter rows

Click **Filter** in a table tab, or press `Ctrl+Shift+F`, to show the filter bar above the rows.
Expand All @@ -32,7 +39,9 @@ Add a rule with **+**. With two or more rules, choose **Match all** or **Match a
- A rule missing its value is pointed out before anything runs.
- A filter the database refuses keeps the filter you had, and the results say why. Refresh reads the rows again.
- Changing the filter while edits are pending asks before it discards them.
- The filter stays with the tab when TablePro restarts.
- Each table keeps the filter it was last read with, per connection, database and schema. Opening the table again applies it; **Clear** forgets it.

To filter by a value in the grid, right-click the cell and open **Filter**. It offers equal and not equal to the value, greater and less than where the column orders, and **is NULL** or **is not NULL** on a NULL cell, each where the engine has the operator. Under **Match all**, the rule joins the ones you have and applies at once. Under **Match any** with two or more rules, it replaces them all, raw SQL included, so check the filter bar before you export or share the rows. A query result has no **Filter**.

## Read a table's structure

Expand Down Expand Up @@ -82,29 +91,6 @@ A script whose statements return rows lists each result in the picker above the

Earlier results are dropped as the script runs, and the status line says how many: `Rows: 1 · 12 ms · 990 earlier results were dropped.` A statement that returns no rows never counts toward the limit. A change applies from the next run.

## Export results

Choose **File > Export results** or press `Ctrl+Shift+E`.

<Frame caption="Export results from a query tab">
<img className="block dark:hidden" src="/images/windows-export-results.png" alt="Export results dialog with CSV selected among JSON, Excel, Markdown, HTML and XML" />
<img className="hidden dark:block" src="/images/windows-export-results-dark.png" alt="Export results dialog with CSV selected among JSON, Excel, Markdown, HTML and XML" />
</Frame>

<Steps>
<Step title="Pick a format">
CSV, JSON, Excel, Markdown, HTML or XML. From a table tab, **SQL INSERT** writes one statement per row for that table.
</Step>
<Step title="Pick the rows, in a table tab">
**Current page** writes the rows on screen. **Entire table** reads every row the filter and sort pick, however many pages they span.
</Step>
<Step title="Choose where to save">
The file appears only once every row is written. A failed or cancelled export leaves no file behind.
</Step>
</Steps>

From a query tab, export writes the result shown. Export waits until the run has finished. CSV is the default; pick Excel for a spreadsheet, which holds up to 1,048,575 rows.

## Share a result or query

Sharing needs a signed-in [TablePro account](/windows/account); signed out, the share dialog offers **Sign in...**.
Expand All @@ -123,15 +109,15 @@ Opening a `tablepro://share` link puts its SQL in a new query tab without runnin

## Find a past query

Choose **View > Show query history** to open the history beside the tabs. Every query you run in a query tab is kept with its time, duration and outcome, newest first. Type in the search box to find one by any words it contains.
Choose **Show query history** in the **View** menu to open the history beside the tabs. Every query you run in a query tab is kept with its time, duration and outcome, newest first. Type in the search box to find one by any words it contains.

<Frame caption="The query history beside the tabs">
<img className="block dark:hidden" src="/images/windows-query-history.png" alt="Query history pane listing a SELECT COUNT query with its time and duration" />
<img className="hidden dark:block" src="/images/windows-query-history-dark.png" alt="Query history pane listing a SELECT COUNT query with its time and duration" />
</Frame>

- Double-click a query, or select it and press `Enter`, to open it in a new query tab.
- Right-click a query to copy or delete it.
- Right-click a query to copy, save, pin or delete it. A pinned run comes first and is never removed by the history limits in Settings.
- **Clear history** removes the history of every connection, after asking.

A statement that can hold a password, such as one that creates a user, is never kept. Sorting a result and committing or rolling back a transaction are not kept either.
Expand All @@ -142,4 +128,4 @@ A statement that can hold a password, such as one that creates a user, is never
|---|---|
| Show or hide the filter bar | `Ctrl+Shift+F` |
| Apply the filter | `Enter` in a value box |
| Export results | `Ctrl+Shift+E` |
| Filter objects in the tree | `Ctrl+P` |
116 changes: 116 additions & 0 deletions windows/command-line.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
title: Command line
description: Query, browse and export saved connections from PowerShell or Command Prompt, and open files and links in TablePro for Windows
---

import CliExitStatus from "/snippets/cli-exit-status.mdx";
import CliOutputFormats from "/snippets/cli-output-formats.mdx";
import CliSchemaCommands from "/snippets/cli-schema-commands.mdx";

Installing TablePro adds a `tablepro` command to every terminal. A file or link argument opens in the app; a command such as `query` or `export` prints to standard output.

## Set up

```powershell
tablepro --help
tablepro help query
```

`tablepro --version` prints the version. The command is an app execution alias: if a terminal does not find it, check that **tablepro.exe** is on under **Apps > Advanced app settings > App execution aliases** in Windows Settings.

Commands work through the app's [MCP server](/windows/mcp). Before querying, open TablePro and turn on **Enable MCP server** under **Settings > MCP server**. Commands never start the app. Each run reads the access token from Credential Manager, so there is nothing to pair, and after **Regenerate token...** the next command reads the new one.

## Open files and links

```powershell
tablepro
tablepro .\app.sqlite3 .\sales.duckdb
tablepro .\report.sql
tablepro "postgresql://ada@db.example.com:5432/shop"
```

With no arguments, the command starts the app or brings it forward. Database files open as [SQLite or DuckDB sessions](/windows/connect#sqlite-and-duckdb-files), a SQL file opens in a query tab without running, and a link opens as [Links and files](/windows/links) describes.

`tablepro open <target>` opens a file or link too. Use it, or a path such as `.\tables`, for a file named like a command. A word that is neither an existing file nor a link exits 2.

## Run a query

```powershell
tablepro query -c Staging "SELECT id, email FROM users LIMIT 5"
tablepro query -c Staging -f report.sql --format csv > report.csv
"SELECT count(*) FROM orders" | tablepro query -c Staging --format json
```

Pass SQL as an argument, with `-f` (`--file`), or on standard input with `-f -`.

| Option | Use |
|---|---|
| `-c`, `--connection` | Saved connection name or id; find it with the [browse commands](#browse-a-connection) |
| `--database` | A database open beside the connection in the app; the connection's own by default |
| `--format` | Choose an [output format](#output-formats) |
| `--limit` | Rows per result set, 100 by default; accepts 1 to 1,000 |
| `--timeout` | Seconds per statement, 30 by default; accepts 1 to 300 |
| `--read-only` | Refuse any statement that is not a read |

On PostgreSQL and SQL Server, a database is open beside the connection once you switch to it in the app, which opens it as a rail item of its own. There is no `--schema` option on `query`: qualify names in SQL, such as `public.orders`. A result cut short says so on standard error. The limit bounds returned rows, not how many rows a write changes.

### Open the connection

Commands use connections open in the app. With standard error attached to a terminal, a command opens a closed connection and waits up to five minutes; answer any password prompt in the app.

Without that terminal, as in a scheduled task, a closed connection exits 1. Open it in the app before the script runs.

## Browse a connection

<CliSchemaCommands />

As with `query`, `--database` picks only a database open beside the connection. Omit `--schema` to use the connection's default schema.

## Export

```powershell
tablepro export -c Staging --format csv orders > orders.csv
tablepro export -c Staging --schema public --format sql --limit 1000 orders users > shop.sql
```

`--format` is required: `csv`, `json` or `sql`. SQL writes `INSERT` statements in the engine's dialect. Pass table names without SQL quotes, and `--schema` for the schema.

The [query row limit](#run-a-query) applies to each table; set `--limit` to change it. A call takes up to 20 tables, and standard error names any table cut short. For every row, use [Export results](/windows/import-export#export-results) in the app.

PowerShell 5.1's `>` writes UTF-16. Pipe to `Out-File -Encoding utf8` for a UTF-8 file there; PowerShell 7 writes UTF-8 already.

## Check status

```powershell
tablepro status --format json
```

The report holds the app version, whether it is running, the MCP setting and port, whether a token was found, and whether the server is ready. It starts nothing.

A ready server exits 0. A stopped or unreachable app exits 1. A server that is off, or a token it refuses, exits 3.

## Shell completion

```powershell
tablepro completion powershell | Out-String | Invoke-Expression
```

Add that line to your `$PROFILE` to complete commands, options and format names in every new PowerShell window. Connection names are not completed. `bash`, `zsh` and `fish` scripts print too, for a shell such as Git Bash.

## Output formats

<CliOutputFormats />

JSON keeps the value types the server returned, numbers and booleans included.

## Exit status

<CliExitStatus />

## What a query may do

A connection's [External clients](/windows/mcp#external-clients) level applies to every command that uses it. **Blocked** hides the connection, and naming it exits 2. **Read only** is the default and refuses writes.

With **Read and write**, each write still waits for **Run** in the connection's window, and Safe Mode's **Read only** refuses it. `--read-only` refuses a write before anything is asked.

Send one statement, or one SQL Server batch, per query. The SQL is limited to 100 KiB. A transaction a write leaves open is rolled back when the call ends.
Loading
Loading