Managed Database for PostgreSQL and MySQL API

Introduction

Managed Database for PostgreSQL and MySQL provides fully-managed relational Database Instances, with MySQL or PostgreSQL as database engines. The resource allows you to focus on development rather than administration or configuration. It comes with a high-availability mode, data replication, and automatic backups.

Compared to traditional database management, which requires customers to provide their infrastructure and resources to manage their databases, Managed Database for PostgreSQL and MySQL Instance offers the user access to Database Instances without setting up the hardware or configuring the software. Scaleway handles the provisioning, manages the configuration, and provides useful features as high availability, automated backup, user management, and more.

Concepts

Refer to our dedicated concepts page to find definitions of the different terms referring to Managed Database for PostgreSQL and MySQL.

Quickstart

1. Configure your environment variables.

   Note

   This is an optional step that seeks to simplify your usage of the APIs.

   export SCW_ACCESS_KEY="<API access key>"
   export SCW_SECRET_KEY="<API secret key>"
   export SCW_REGION="<Scaleway region>"
   

2. Edit the POST request payload you will use to create your Database Instance. Replace the parameters in the following example:

     '{
     "project_id": "d8e65f2b-cce9-40b7-80fc-6a2902db6826",
     "name": "myDB",
     "engine": "PostgreSQL-15",
     "tags": ["donnerstag"],
     "is_ha_cluster": true,
     "node_type": "db-pro2-xxs",
     "disable_backup": false,
     "user_name": "my_initial_user",
     "password": "thiZ_is_v0ry_s3cret",
     "volume_type": "sbs_5k",
     "volume_size": "30000000000"
     }'
   

   Parameter	Description
   project_id	The ID of the Project you want to create your Database Instance in. To find your Project ID you can list the projects or consult the Scaleway console.
   engine	REQUIRED Version ID of the database engine. To check the list of available engines you can use the folowing endpoint: https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/database-engines
   name	Name of the Database Instance
   node_type	REQUIRED The node type. To check the list of available node types you can use the folowing endpoint: https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/node-types
   is_ha_cluster	BOOLEAN Defines whether High Availability is enabled for the Database Instance
   disable_backup	BOOLEAN Defines whether automated backups are disabled for the Database Instance
   tags	The list of tags ["tag1", "tag2", ...] that will be associated with the Database Instance. Tags can be appended to the query of the List Database Instances call to show results for only the Database Instances using a specific tag. You can also combine tags to list Database Instances that posess all the appended tags.
   user_name	REQUIRED Identifier of the default user, which is created concurrently with the Database Instance
   password	REQUIRED Password for the default user
   volume_type	Type of volume where data is stored. You can specify either local volume (lssd) or block volume (bssd, sbs_5k or sbs_15k). The default value is lssd
   volume_size	Volume size when volume_type is bssd, sbs_5k or sbs_15k. The value should be expressed in bytes. For example 30GB is expressed as 30000000000

3. Create a Database Instance by running the following command. Make sure you include the payload you edited in the previous step.

   curl -X POST \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     "Content-Type: application/json" \
     https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/instances \
     -d '{
       "project_id": "d8e65f2b-cce9-40b7-80fc-6a2902db6826",
       "name": "myDB",
       "engine": "PostgreSQL-15",
       "tags": ["donnerstag"],
       "is_ha_cluster": true,
       "node_type": "db-pro2-xxs",
       "disable_backup": false,
       "user_name": "my_initial_user",
       "password": "thiZ_is_v0ry_s3cret",
       "volume_type": "sbs_5k",
       "volume_size": "30000000000"
     }'
   

4. List your Database Instances.

   curl -X GET \
     -H "Content-Type: application/json" \
     -H "X-Auth-Token: $SCW_SECRET_KEY" https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/instances
   

   You should get a response like the following:

   Note

   This is a response example, the UUIDs and IP address displayed are not real.

   {
         "id": "f5122f66-fb50-4cef-aa02-487ef4fc1af0",
         "name": "myDB",
         "organization_id": "895693aa-3915-4896-8761-c2923b008be7",
         "project_id": "d8e65f2b-cce9-40b7-80fc-6a2902db6826",
         "status": "ready",
         "engine": "PostgreSQL-15",
         "endpoint": {
           "ip": "198.51.100.0",
           "port": 22245,
           "name": null
         },
         "tags": [
           "donnerstag"
         ],
         "settings": [],
         "backup_schedule": {
           "frequency": 24,
           "retention": 7,
           "disabled": true
         },
         "is_ha_cluster": true,
         "read_replicas": [],
         "node_type": "db-pro2-xxs",
         "volume": {
           "type": "sbs_5k",
           "size": 30000000000
         }
         "created_at": "2019-04-19T16:24:52.591417Z",
         "region": "fr-par"
   }
   

5. Retrieve your Database Instance IP and port from the response.

   Note

   In the example above, the IP and port are 198.51.100.0 and 22245, respectively.

6. Connect to your Database Instance with the database client of the engine you selected. For MySQL, run the following command:

   mysql -h <ip-address> --port <port> -p -u <user_name>
   

   For PostgreSQL, run:

   psql -h <ip-address> -p <port> -U <username> -d rdb
   

   For the recurring example, the command would look like:

   psql -h 198.51.100.0 -p 22245 -U my_initial_user -d rdb
   

7. Enter the database password that you defined upon creation.

You are now connected to your Managed Database.

Technical Information

Regions

Scaleway's infrastructure is spread across different regions and Availability Zones.

Managed Database for PostgreSQL and MySQL is available in the Paris, Amsterdam and Warsaw regions, which are represented by the following path parameters:

• fr-par
• nl-ams
• pl-waw

PostgreSQL specifications

Versions

Scaleway Database for PostgreSQL supports PostgreSQL versions 11, 12, 13, 14 and 15.

System

Different modules are available for installation, including TimescaleDB and PostGIS. Refer to the Managed Database for PostgreSQL and MySQL FAQ page for an extensive list of PostgreSQL extensions.

Database Management

You can create logical databases through the Scaleway console, the Scaleway APIs or SQL.

• databases created using the Scaleway console or the API are owned by an internal system user. These are called "managed databases".
• databases created using SQL will be owned by the creator. These are called "unmanaged databases".

MySQL specifications

Versions

Scaleway Database for MySQL supports MySQL 8.

System

• only the InnoDB engine is supported
• the Global Transaction Identifier (GTID) is enabled.
• mysql_native_password (default) and caching_sha2_password authentication are supported.

User Management

• users with an admin role have access to all logical databases and can create new ones.
• users created via the API are authenticated using the default authentication plugin, which can be changed in the settings.

Technical Limitations

PostgreSQL

User Management

• users with an admin role have CREATEROLE and CREATEDB privileges.
• users do NOT have SUPERUSER nor REPLICATION privileges.
• permission management through the Scaleway console or API is only possible for the "managed databases".

Backup and restoration

Databases that have been backed up and then restored retain the user permission settings in use at the time of backup. If you delete users after backup and then restore your backup in the same database, or if you restore a backup to a different database with different or no users, the permissions configured for them continue to exist, but with no associated owner. This error will put a stop to the restoration process.

To avoid this issue, we recommmend you re-create the users you deleted. In the occasion you restore the backup to a new database, you must create new users with the same names.

Going Further

For more information about Managed Database for PostgreSQL and MySQL, you can check out the following pages:

• Managed Database for PostgreSQL and MySQL Documentation
• Managed Database for PostgreSQL and MySQL FAQ
• Scaleway Slack Community join the #database channel
• Contact our support team

How to migrate a database

If you wish to migrate existing databases to a Managed Database for PostgreSQL or MySQL, you can refer to the Migrating existing databases to a Database Instance tutorial page.

Troubleshoooting

Disk full status

If your Database Instance uses local storage, your local volume might eventually approach full capacity and shift to disk_full mode. This mode grants you enough space to either upgrade your node type or clear out space in your volume.

Backups

Engines

Database Instances

Read Replicas

ACLs

Instance Settings

Privileges

Users

Databases

NodeTypes

Snapshots

Endpoints