Connect to a Serverless SQL Database

Jump toUpdate content

How to connect to a Serverless SQL Database

Reviewed on 11 August 2023 • Published on 11 August 2023

This page shows you how to set up the connection to a Serverless SQL Database using the Scaleway console.

Security & Identity (IAM):

You may need certain IAM permissions to carry out some actions described on this page. This means:

you are the Owner of the Scaleway Organization in which the actions will be carried out, or
you are an IAM user of the Organization, with a policy granting you the necessary permission sets

Requirements:

You have an account and are logged into the Scaleway console
You have signed up to the private beta and received a confirmation email.
You have created a Serverless SQL Database

How to set up credentials

From the Overview tab of your database, click the Set up credentials button. The setup wizard displays.
Select the principal to connect to the database:
- Yourself, as an IAM user.
- An application that you previously created in the IAM section of the console.
Note:
Refer to the IAM documentation for more information on identities and access rights.
Set up the connection string or connection parameters:
- If you already have a secret key, replace the [INSERT_SECRET_KEY_HERE] placeholder with your key.
- If you do not have a secret key, click Generate new secret key.
Copy your connection string or parameters and store them securely.

How to connect to a database as a user

Run the following command in a terminal:

psql "[YOUR_CONNECTION_STRING]"

An output similar to the following response displays:

psql (15.3, server 14.8 (Debian 14.8-1pgsg120+1))
SSL connection (protocol: TLSv1.3, cipher: TLS_AES_128_GCM_SHA256, compression: off)
Type "help" for help.

Run the following command to see the version of your Serverless SQL Database:

SELECT version();

An output similar to the following displays:

PostgreSQL 14.8 (Debian 14.8-1.pgdg120+1) on x86_64-pc-linux-gnu,
compiled by gcc (Debian 12.2.0-14) 12.2.0, 64-bit

Press q to quit the version overview.

You can now perform the authorized actions in the database.

How to connect an application to a database

Use the connection parameters (host, port, user, password, database name) previously saved to connect your application to the database.

Note:

Connection methods may vary depending on the framework or library used in your application. Refer to the corresponding official documentation for more information.