Quickstart

1. Log in to the SkySQL Portal and click "+ Launch a Service".

   

   Log in to the SkySQL Portal with your MariaDB ID and launch a service.
   ^{https://cloud.mariadb.com}

2. When you click "Launch a service", you'll need to specify the service details from the available selections.

   • For this quickstart experience, choose "Transactions" service and "Distributed" topology.

   • You can name this service "quickstart-1".

   • Additional guidance is available, if needed:

     • Basic test configuration

     • Visual walkthrough of launch screens

3. By default, access to your service is blocked by a firewall. To allow access from your IP address:

   • From "Your services", click the gear icon for your service, then choose "Security Access".

   • Click "Add my current ip address", then click the "Done" button.

4. Once the service state is "Healthy", the service has been launched, and the connection parameters can be retrieved.

   To retrieve the hostname, port, username, and password needed to connect to your service:

   • From "Your services", expand the view to see the "Fully Qualified Domain Name" (hostname) and "Read-write port" (port).

   • Click the "Connect to Service" globe icon for your service to display the username and default password.

   • Download the SkySQL certificate authority (CA) chain file for your service, which depends on the cloud provider selected:

     • For AWS services

     • For GCP services

The SkySQL DBaaS REST API is currently available as a Technical Preview. This REST API for service management is an alternative to the SkySQL Portal.

For information on how to launch a service by manually interacting with the REST API, see "API Launch Walkthrough".

The SkySQL DBaaS REST API is currently available as a Technical Preview. skysqlcli is a command-line service management utility which uses the REST API.

For information on how to launch a service by manually executing skysqlcli, see "CLI Launch Walkthrough".

Many desktop database clients are compatible with SkySQL services.

In this Quickstart we cover DBeaver, which is available for Linux, macOS, and MS Windows.

1. Download DBeaver and install.

2. After running DBeaver, from the Database menu, select New Database Connection

3. Choose MariaDB and click Next>

4. On the Main tab, enter the hostname, port, username, and password for your SkySQL service.

5. On the Driver properties tab, you will be prompted to download Connector/J if it is not already installed. Once Connector/J is installed, continue with configuration:

   • Set the useSsl driver property to true

   • Set the serverSslCert driver property to the absolute path for the certificate authority chain .pem file you downloaded.

6. On the SSL tab, do not enter any values. TLS/SSL configuration was completed through driver properties.

7. Click the Finish button.

8. You can now connect to and interact with your database.

   For example:

   • Expand the SkySQL hostname in the left sidebar to connect to the DB

   • Right-click on the "Databases" line in the left sidebar, choose "Create New Database", and enter the name "quickstart" in the dialog

   • Right-click on the "quickstart" line in the left sidebar, choose "Create > Table", and enter the name "programming_language"

     • In the dialog that pops up, use the "Create New Column" button twice: first to add the "name" column with the default "VARCHAR(100)" type and then to add the "rating" column with an "INT" type

     • Click on the Save button, review the SQL preview, and click on the Persist button to create the new table

     • Click on the Data tab and use the "Add New Row" button to add a new row with whatever programming language name & rating integer values you want

     • Repeat the prior step to add several rows

     • Click on the Save button and the new rows will be committed

   • You can now run arbitrary SQL using the SQL Editor menu to create a new SQL script

     • For instance, start a new script, enter "SELECT * FROM quickstart.programming_language WHERE rating > 5;" in the dialog, and then use the button with the Play symbol on it to run the SELECT and see the output

   • When you're done with the database, you can right-click the DB hostname and choose "Disconnect" and/or close DBeaver.

When connecting to SkySQL services from Java applications, we recommend using MariaDB Connector/J.

For a step-by-step explanation of a Java code example, see "Java Code Walkthrough".

Additional guidance is available:

• MariaDB Connector/J documentation

When connecting to SkySQL services from Node.js applications, we recommend using MariaDB Connector/Node.js.

For a step-by-step explanation of a Node.js code example, see "Node.js Code Walkthrough".

Additional guidance is available:

• MariaDB Connector/Node.js documentation

When connecting to SkySQL services from PHP applications, community-supported mysqli or PDO_MYSQL can be used.

For a step-by-step explanation of a PHP code example, see "PHP Code Walkthrough".

When connecting to SkySQL services from Python applications, we recommend using MariaDB Connector/Python.

For a step-by-step explanation of a Python code example, see "Python Code Walkthrough".

Additional guidance is available:

• MariaDB Connector/Python documentation