Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 3.43 KB

sql-editors.md

File metadata and controls

86 lines (54 loc) · 3.43 KB
Raw
title
SQL Editors

SQL Editors

Dolt comes with a built-in MySQL compatible server, making it easy to connect to your Dolt databases with existing SQL tooling. Here are a list of notable MySQL Editors and our compatibility status.

Editor Supported Notes and limitations
Tableplus ✅ Recommended (see below)
Datagrip ✅ Potential information schema and backup compatibility issues.
MySQL Workbench ✅ Potential information schema issues.

If you experience any issues using the supported SQL editors above, please file an issue on GitHub so we can investigate and help.

Setting up Dolt with Tableplus

Tableplus is the recommended SQL editor to use with Dolt. Let's clone a Dolt database and connect it to Tableplus. We have a video that walks through this experience as well.

Step 1: Cloning a database.

Open your terminal and clone the following database.

dolt clone dolthub/ip-to-country && cd ip-to-country

Now run: dolt sql -q 'show tables' and you should see the following output

> dolt sql -q 'show tables'
+---------------+
| Table         |
+---------------+
| IPv4ToCountry |
| IPv6ToCountry |
+---------------+

Step 2: Setting up your server

Dolt's sql server can be started with one command.

> dolt sql-server
Starting server with Config HP="0.0.0.0:3306"|U="root"|P=""|T="28800000"|R="false"|L="info"

The default configuration for our server uses a username of root and an empty password. You can configure access settings, logging, and timeouts by following additional documentation here.

Step 3: Connecting our server with Tableplus

If you haven't already go ahead and install Tableplus from here:

Click on create a new connection:

Hit MySQL in the selection box and fill in the following information. All the parameters are the same as for any MySQL database.

When you hit Test you should see all the boxes turn green like in the above image. Finally, hit connect to access the Dolt server.

Step 4: Writing queries with Tableplus

Let's start by selecting a database in the Dolt server and writing queries against it.

Select the ip_to_country database. You should see tables populate to the left like below.

Now click on the table IPv4ToCountry and see the screen populate. We just read from our Dolt database!

Finally, let's write a quick query on the dataset. Click the SQL button in the top left and write the query in the box. Hit the Run Current button to execute it and the results should appear:

That's it! You've successfully connected Dolt to Tableplus and ran your first query.

If you have any additional issues please file them here.