Skip to content

Latest commit

 

History

History
96 lines (80 loc) · 3.7 KB

quickstart.mdx

File metadata and controls

96 lines (80 loc) · 3.7 KB
title Quick Start
description Connect to your first database and run a query in a few minutes

With no connections saved, the welcome window offers Open Sample Database, a bundled Chinook SQLite file that needs no server and drops you at step 4. Reset it any time from Help > Reset Sample Database….

`brew install --cask tablepro`, or the DMG from GitHub Releases. See [Installation](/installation). The first launch shows a welcome sheet; click **Continue** to reach the welcome window, and choose **Help > Getting Started** to see it again. Click **New Connection…** in the welcome window, pick a type in the **Choose a Database** sheet, then click **Continue**. A type badged **Not Installed** downloads its driver before the form opens, with no restart.
<Frame caption="Pick a database type">
  <img
    className="block dark:hidden"
    src="/images/database-type-chooser.png"
    alt="Database type chooser"
  />
  <img
    className="hidden dark:block"
    src="/images/database-type-chooser-dark.png"
    alt="Database type chooser"
  />
</Frame>

<Tip>
Already have a connection URL, another client's connections, or a repository with a `.env`? The **Import** menu under **New Connection…** takes all three. See [Switching to TablePro](/switching).
</Tip>
The host pre-fills to `localhost` and the port to the engine's default. Username is optional: leave it empty and the database applies its own default. SQLite asks for a `.sqlite` or `.db` file instead of a host, with no credentials.
<Frame caption="PostgreSQL connection form">
  <img
    className="block dark:hidden"
    src="/images/connection-form-general.png"
    alt="Connection form"
  />
  <img
    className="hidden dark:block"
    src="/images/connection-form-general-dark.png"
    alt="Connection form"
  />
</Frame>

Click **Test Connection** on the bar along the bottom. It turns into **Connected** with a green checkmark. Now click **Save & Connect** beside it.

<Frame caption="Test Connection succeeded">
  <img
    className="block dark:hidden"
    src="/images/connection-test.png"
    alt="Connection test success"
  />
  <img
    className="hidden dark:block"
    src="/images/connection-test-dark.png"
    alt="Connection test success"
  />
</Frame>

<Check>
The window switches to the main layout: databases and tables in the sidebar, the open tab in the middle, the inspector on the right.
</Check>

A failed attempt paints the window with the driver's own message and a **Try Again** button instead. [Troubleshooting](/troubleshooting) sorts refused from timed out.
Click a table in the sidebar to browse it. For SQL, press `Cmd+T` for a query tab, type, and press `Cmd+Enter` to run the statement under the cursor.
<Frame caption="A table tab showing the data grid">
  <img
    className="block dark:hidden"
    src="/images/app.png"
    alt="Main interface"
  />
  <img
    className="hidden dark:block"
    src="/images/app-dark.png"
    alt="Main interface"
  />
</Frame>

```sql
SELECT * FROM users LIMIT 10;
```

What's next

Managing connections, SSH tunneling, keyboard shortcuts, and AI features. Anything that goes wrong is worth an issue.