Skip to content

Commit

Permalink
Merge pull request #55 from skysqlinc/GUIconnect
Browse files Browse the repository at this point in the history
GUIconnect
  • Loading branch information
bryan-skysql authored Sep 20, 2024
2 parents c769714 + a0c8745 commit b38fbcc
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 10 deletions.
13 changes: 13 additions & 0 deletions docs/Connecting to Sky DBs/Connect using DBGate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Connecting to SkySQL Using [DBGate](https://dbgate.org/)

## Steps:
1. Open DBGate and create a new connection.
2. Select **MariaDB** as the database type.
3. Enter the SkySQL hostname, port, username, and password.
4. Navigate to the **SSL** tab in the Connection window.
5. Check the **Use SSL** option.
6. Click **Connect** to establish the connection.

## Notes:
- No need to configure additional SSL certificate files in most cases, just select **Use SSL** and you're good to go.
- Make sure DBGate is updated to the latest version for best compatibility.
15 changes: 15 additions & 0 deletions docs/Connecting to Sky DBs/Connect using DBeaver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Connecting to SkySQL Using [DBeaver](https://dbeaver.io/download/)

## Steps:
1. Open DBeaver and create a new connection.
2. Select **MariaDB** as the database type.
3. Enter the hostname, port, username, and password provided by your SkySQL instance.
4. Navigate to the **SSL** tab.
5. Check the **Use SSL** option if SSL is enabled for your SkySQL instance.
6. Click **Test Connection** to ensure everything is set up correctly.

![image (1)](https://github.com/user-attachments/assets/fead6067-9a5a-4e75-bcf2-2d20e0a4b727)

## Notes:
- Ensure you are using the latest MariaDB driver in DBeaver to avoid compatibility issues.
- If you experience connection issues, verify your firewall settings and database credentials.
15 changes: 15 additions & 0 deletions docs/Connecting to Sky DBs/Connect using HeidiSQL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Connecting to SkySQL Using [HeidiSQL](https://www.heidisql.com/download.php)

## Steps:
1. Open HeidiSQL and create a new session.
2. Choose **MySQL** as the connection type.
3. Enter the SkySQL credentials including hostname, port, username, and password.
4. If SSL is enabled, go to the **SSL** tab.
5. Check **Use SSL**.
6. Test the connection and click **Open**.

![heidi](https://github.com/user-attachments/assets/37685278-b228-4387-9d48-8673d1d39e2d)

## Notes:
- Ensure your HeidiSQL client is up to date.
- Using updated drivers on new MariaDB versions is essential as out of date drivers will return "Authentication failed" errors. It may be nessecary to manually install new drivers on Windows.
10 changes: 10 additions & 0 deletions docs/Connecting to Sky DBs/Connect using TablePlus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Connecting to SkySQL Using [TablePlus](https://tableplus.com/download)

## Steps:
1. Open TablePlus and create a new connection.
2. Select **MariaDB** as the connection type.
3. Input the connection details (hostname, port, username, and password) from your SkySQL instance.
4. If SSL is configured, set the **SSL Mode** to **ENFORCE**.
5. Click **Connect** to test the connection.

## Notes:
19 changes: 9 additions & 10 deletions docs/Connecting to Sky DBs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,15 @@ Most of the SQL clients and editors natively support MariaDB. Most often you can

- [Connecting using Java clients like Squirrel SQL](https://squirrel-sql.sourceforge.io/)
- All you need to do is to make sure the "useSsl" property is set to 'true' if SSL is ON.
- [TablePlus](https://tableplus.com/download)
- If SSL was configured, you should set the SSL Mode option to 'ENFORCE' and not 'VERIFY-SERVER-CERT'.
- When using the "ENFORCE" SSL mode in TablePlus or any MySQL client, the client will still verify that the SSL certificate presented by the server is valid and trusted. This includes verifying that the certificate is issued by a trusted Certificate Authority (CA) and that it has not expired or been revoked.
- In the "ENFORCE" mode, the client requires the server to present a valid SSL certificate during the SSL handshake process. - The client will then verify the following aspects of the certificate:
- Certificate Chain: The client will check if the server's SSL certificate is part of a valid certificate chain, leading back to a trusted root CA certificate.
- Certificate Expiry: The client will verify that the server's SSL certificate has not expired.
- Certificate Revocation: The client may also check if the certificate has been revoked by the issuing CA.
- If any of these checks fail, the client will not establish the SSL connection and may display an error indicating that the certificate is not valid or trusted.
- MariaDB CLI
- [DBGate](https://dbgate.org/)
- When using SSL, you only have to switch to the SSL Tab in the Connection window and select 'use SSL' and click Connect.
- [Sequel Ace](https://sequel-ace.com/) - Connect to MariaDB from MacOS
- In the connection window, you should select 'Require SSL' if your SkySQL database has SSL turned ON (the default).

### Graphical User Interfaces (GUIs)

The following GUI clients have been tested to properly connect with SkySQL and execute queries. Most SQL clients and editors natively support MariaDB. You can often select 'MySQL' as the connection type to connect to your SkySQL DB service.

- [Connect using DBeaver](Connect%20using%20DBeaver.md) SkyDBA Recommended
- [Connect using DBGate](Connect%20using%20DBGate.md)
- [Connect using HeidiSQL](Connect%20using%20HeidiSQL.md)
- [Connect using TablePlus](Connect%20using%20TablePlus.md)

0 comments on commit b38fbcc

Please sign in to comment.