Getting Started

1. Create a Connection

You need to prepare your host, port, username, and password to get connected.

How to connect

• Open TablePlus app, from the welcome screen, click Create a New Connection at the bottom, or right-click on the connection view and choose New.

• Choose database type and hit Create

• Configure your connection using standard properties such as host, port, user credentials, etc;

Or you can choose to import from URL, just copy and paste your URL. You can find and copy the URL from your server configuration.

For example, you can connect to our demo PostgreSQL database by importing this URL: (if you already have the PostgreSQL Server running locally or you can get one here with just a few clicks: https://dbngin.com)

postgresql://[email protected]

2. Open anything

You can open anything using ⌘ + P, including database, table, schema, view, function…

3. Edit data

From the table view, you can edit data inline by double-clicking on the data cell or using the toggle view in the right sidebar. The toggle view can be enabled using the toggle button at the top right or by pressing Space.

After editing, press Commit icon near the top left segment panel or use ⌘ + S to commit the changes to the database.

4. Save Changes to the Database

TablePlus does not send the queries that modify the database automatically to the server unless you confirm the changes. Therefore, after querying and editing your data from the app, you’ll need to commit the change to the database. That’s when your database actually gets modified. There are two ways to commit the changes:

• Using the commit button on the top left action control.

• Using the shortcut key: ⌘ + S.

Noted: All the changes will be recorded in the history tab. TablePlus supports 3 safe mode levels to prevent human mistakes. Click on the clock icon (near edit action control) to enable it.

5. Open SQL Query Editor

You can click on the SQL Query Editor icon near the top left, or use ⌘ + Return (or ⌘ + E) to open query editor. TablePlus will open the editor with the most recent script. SQL Query features.

• Auto code-completion.

• Query params: demo.

• Show invisible characters.

• Multiple carets: demo.

6. Execute Queries

After writing your queries, press Run All button, or use ⌘ + Enter, and TablePlus will execute all the SQL code in the editor.

• You can change the default button to Run Current from the dropdown near Run All, Tableplus will only run the statement under the cursor.

• If you want to split results into tabs, click on query setting on the left, there are also many other settings (font, auto suggestion…)

• Some shortcut keys (Replace Command with Control on Windows):

  • Command + Shift + D: Split the Query Editor Horizontally.

  • Command + D: Duplicate the cursor by searching the current word.

  • Command + W: Close the current query editor.

• You can enable the Query Params by clicking the settings button at the bottom left of the Editor.

7. Create Tables

When viewing the items tab in the left sidebar, right-click on the sidebar and choose New Table, or you can use + Table button near the bottom left to create a new table.

After creating, press Commit icon near the top left segment panel or use ⌘ + S to commit the changes to the database.

8. Show Data from Selected Columns

You can show data from the selected rows by the column name. Click the Column button at the bottom of the workspace window and choose which columns to show.

9. Filter Data

To open filter, press the filter button at the bottom of the window or use ⌘ + F Each filter contains there simple boxes:

• a dropdown list of the column names

• common conditions such as equal, contain, IS NULL,…

• one text box to fill the value.

You can apply multiple filters to quickly filter out the records you want to see.

Press filter button again or use shortcut key esc to turn off the filter.

10. Import Data

To import a CSV file to a current table:

• Choose File > Import CSV from the menu bar

• Right-click on the table in the left sidebar or right-click in the data content and choose Import CSV

After importing, press Command + R to reload current workspace.

11. Export Data

To export a table, right-click on the table name in the left sidebar and choose Export Table. Note that if you right-click on the data browser view, it will export only the current page of results, not the whole table.

The output file can be CSV, JSON or SQL.

Read more on 11 tips to boost your productivity with TablePlus.