Documentation
Connect to the Database With Sequel Ace
Connecting to your project's database with Sequel Ace is super easy, and a great way to get a clear idea about Craft's database content and structure.
Note: If you're looking to import data, we'd recommend taking a look at the Import Database documentation.
1. Start an SSH Tunnel #
-
Go to your project's Access Control page.
-
Create a new SSH Session. You can read more about SSH Sessions here.
-
In the "SSH Connection" section, select an environment and check the "Include database port forward" option.
-
Copy the supplied SSH Connection string into a terminal on your local machine.
Run it to open an SSH connection with an included port forward for the database.
2. Connect to the Database #
-
Open up Sequel Ace.
-
Click the "+" button to create a new favourite.
-
In the TCP/IP tab, copy the database credentials over from the "Database Connection" section in the Access Control page.
Give the connection a good name. If you prefer, you can select a color that indicates the environment you're connecting to - we like red for production. 🚨
-
Click the "Test connection" button to double check the connection is successful. You should see a "Connection succeeded" message appear.
-
Click the "Connect" button.
-
You're now connected to your database. ✅ Watch what you delete now!