scaleway · Codelax · Mar 10, 2023 · Mar 10, 2023
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Add an additional ACL rule to a database instance.
+Add an additional ACL rule to a Database Instance.
 
 USAGE:
   scw rdb acl add [arg=value ...]
 
 ARGS:
-  instance-id                   UUID of the instance you want to add acl rules to
+  instance-id                   UUID of the Database Instance you want to add ACL rules to
   [rules.{index}.ip]            
   [rules.{index}.description]   
   [region=fr-par]               Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete ACL rules of a given instance.
+Delete one or more ACL rules of a Database Instance.
 
 USAGE:
   scw rdb acl delete [arg=value ...]
 
 ARGS:
-  instance-id        UUID of the instance you want to delete an ACL rules from
-  rules.{index}.ip   ACL rules IP present on the instance
+  instance-id        UUID of the Database Instance you want to delete an ACL rule from
+  rules.{index}.ip   IP addresses defined in the ACL rules of the Database Instance
   [region=fr-par]    Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List ACL rules of a given instance.
+List the ACL rules for a given Database Instance. The response is an array of ACL objects, each one representing an ACL that denies, allows or redirects traffic based on certain conditions.
 
 USAGE:
   scw rdb acl list [arg=value ...]
 
 ARGS:
-  instance-id       UUID of the instance
+  instance-id       UUID of the Database Instance
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
 
 FLAGS:

@@ -1,14 +1,14 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Network Access Control List allows to control network in and out traffic by setting up ACL rules.
+Network Access Control Lists allow you to control incoming network traffic by setting up ACL rules.
 
 USAGE:
   scw rdb acl <command>
 
 AVAILABLE COMMANDS:
-  add         Add an ACL instance to a given instance
-  delete      Delete ACL rules of a given instance
-  list        List ACL rules of a given instance
+  add         Add an ACL rule to a Database Instance
+  delete      Delete ACL rules of a Database Instance
+  list        List ACL rules of a Database Instance
 
 FLAGS:
   -h, --help   help for acl

@@ -1,15 +1,15 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create a database backup.
+Create a new backup. You must set the `instance_id`, `database_name`, `name` and `expires_at` parameters.
 
 USAGE:
   scw rdb backup create [arg=value ...]
 
 ARGS:
-  [instance-id]        UUID of the instance
-  [database-name]      Name of the database you want to make a backup of
+  [instance-id]        UUID of the Database Instance
+  [database-name]      Name of the database you want to back up
   [name=<generated>]   Name of the backup
-  [expires-at]         Expiration date (Format ISO 8601)
+  [expires-at]         Expiration date (must follow the ISO 8601 format)
   [region=fr-par]      Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete a database backup.
+Delete a backup, specified by its database backup ID and region. Deleting a backup is permanent, and cannot be undone.
 
 USAGE:
   scw rdb backup delete <database-backup-id ...> [arg=value ...]

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Export a database backup.
+Export a backup, specified by the `database_backup_id` and the `region` parameters. The download URL is returned in the response.
 
 USAGE:
   scw rdb backup export <database-backup-id ...> [arg=value ...]

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get a database backup.
+Retrieve information about a given backup, specified by its database backup ID and region. Full details about the backup, like size, URL and expiration date, are returned in the response.
 
 USAGE:
   scw rdb backup get <database-backup-id ...> [arg=value ...]

@@ -1,16 +1,16 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List database backups.
+List all backups in a specified zone, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
 
 USAGE:
   scw rdb backup list [arg=value ...]
 
 ARGS:
   [name]              Name of the database backups
   [order-by]          Criteria to use when ordering database backups listing (created_at_asc | created_at_desc | name_asc | name_desc | status_asc | status_desc)
-  [instance-id]       UUID of the instance
-  [project-id]        Project ID the database backups belongs to
-  [organization-id]   Organization ID the database backups belongs to
+  [instance-id]       UUID of the Database Instance
+  [project-id]        Project ID of the Project the database backups belong to
+  [organization-id]   Organization ID of the Organization the database backups belong to
   [region=fr-par]     Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
 
 FLAGS:

@@ -1,14 +1,14 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Restore a database backup.
+Launch the process of restoring database backup. You must specify the `instance_id` of the Database Instance of destination, where the backup will be restored. Note that large database backups can take up to several hours to restore.
 
 USAGE:
   scw rdb backup restore <database-backup-id ...> [arg=value ...]
 
 ARGS:
-  [database-name]      Defines the destination database in order to restore into a specified database, the default destination is set to the origin database of the backup
+  [database-name]      Defines the destination database to restore into a specified database (the default destination is set to the origin database of the backup)
   database-backup-id   Backup of a logical database
-  instance-id          Defines the rdb instance where the backup has to be restored
+  instance-id          Defines the Database Instance where the backup has to be restored
   [region=fr-par]      Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:

@@ -1,14 +1,14 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update a database backup.
+Update the parameters of a backup, including name and expiration date.
 
 USAGE:
   scw rdb backup update <database-backup-id ...> [arg=value ...]
 
 ARGS:
   database-backup-id   UUID of the database backup to update
   [name]               Name of the Database Backup
-  [expires-at]         Expiration date (Format ISO 8601)
+  [expires-at]         Expiration date (must follow the ISO 8601 format)
   [region=fr-par]      Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Save and restore backups of your database instance.
+A database backup is a dated export of a Database Instance stored on an offsite backend located in a different region than your database, by default. Once a backup is created, it can be used to restore the database. Each logical database in a Database Instance is backed up and can be restored separately.
 
 USAGE:
   scw rdb backup <command>

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create a database in a given instance.
+Create a new database. You must define the `name` parameter in the request.
 
 USAGE:
   scw rdb database create [arg=value ...]
 
 ARGS:
-  instance-id       UUID of the instance where to create the database
+  instance-id       UUID of the Database Instance where to create the database
   [name]            Name of the database
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete a database in a given instance.
+Delete a given database on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the database you want to delete.
 
 USAGE:
   scw rdb database delete [arg=value ...]
 
 ARGS:
-  instance-id       UUID of the instance where to delete the database
+  instance-id       UUID of the Database Instance where to delete the database
   name              Name of the database to delete
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 

@@ -1,16 +1,16 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all database in a given instance.
+List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `name`, `managed` and `owner`.
 
 USAGE:
   scw rdb database list [arg=value ...]
 
 ARGS:
   [name]            Name of the database
-  [managed]         Whether or not the database is managed
+  [managed]         Defines whether or not the database is managed
   [owner]           User that owns this database
   [order-by]        Criteria to use when ordering database listing (name_asc | name_desc | size_asc | size_desc)
-  instance-id       UUID of the instance to list database of
+  instance-id       UUID of the Database Instance to list the databases of
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
 
 FLAGS:

@@ -1,14 +1,14 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Manage logical databases on your instance
+Databases can be used to store and manage sets of structured information, or data. The interaction between the user and a database is done using a Database Engine, which provides a structured query language to add, modify or delete information from the database.
 
 USAGE:
   scw rdb database <command>
 
 AVAILABLE COMMANDS:
-  create      Create a database in a given instance
-  delete      Delete a database in a given instance
-  list        List all database in a given instance
+  create      Create a database in a Database Instance
+  delete      Delete a database in a Database Instance
+  list        List databases in a Database Instance
 
 FLAGS:
   -h, --help   help for database

@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List available database engines.
+List the PostgreSQL and MySQL database engines available at Scaleway.
 
 USAGE:
   scw rdb engine list [arg=value ...]
 
 ARGS:
-  [name]            Name of the Database Engine
-  [version]         Version of the Database Engine
+  [name]            Name of the database engine
+  [version]         Version of the database engine
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
 
 FLAGS:

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Software that stores and retrieves data from a database. Each database engine has a name and versions.
+A database engine is the software component that stores and retrieves your data from a database. Currently PostgreSQL 11, 12, 13 and 14 are available. MySQL is available in version 8.
 
 USAGE:
   scw rdb engine <command>

@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Clone an instance.
+Clone a given Database Instance, specified by the `region` and `instance_id` parameters. The clone feature allows you to create a new Database Instance from an existing one. The clone includes all existing databases, users and permissions. You can create a clone on a Database Instance bigger than your current one.
 
 USAGE:
   scw rdb instance clone <instance-id ...> [arg=value ...]
 
 ARGS:
-  instance-id       UUID of the instance you want to clone
-  [name]            Name of the clone instance
+  instance-id       UUID of the Database Instance you want to clone
+  [name]            Name of the Database Instance clone
   [node-type]       Node type of the clone
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 

@@ -1,27 +1,27 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create an instance.
+Create a new Database Instance. You must set the `engine`, `user_name`, `password` and `node_type` parameters. Optionally, you can specify the volume type and size.
 
 USAGE:
   scw rdb instance create [arg=value ...]
 
 ARGS:
   [project-id]                                                  Project ID to use. If none is passed the default project ID will be used
-  [name=<generated>]                                            Name of the instance
-  engine                                                        Database engine of the database (PostgreSQL, MySQL, ...)
-  user-name                                                     Name of the user created when the instance is created
+  [name=<generated>]                                            Name of the Database Instance
+  engine                                                        Database engine of the Database Instance (PostgreSQL, MySQL, ...)
+  user-name                                                     Username created when the Database Instance is created
   password                                                      Password of the user
-  node-type=DB-DEV-S                                            Type of node to use for the instance
-  [is-ha-cluster]                                               Whether or not High-Availability is enabled
-  [disable-backup]                                              Whether or not backups are disabled
-  [tags.{index}]                                                Tags to apply to the instance
+  node-type=DB-DEV-S                                            Type of node to use for the Database Instance
+  [is-ha-cluster]                                               Defines whether or not High-Availability is enabled
+  [disable-backup]                                              Defines whether or not backups are disabled
+  [tags.{index}]                                                Tags to apply to the Database Instance
   [init-settings.{index}.name]                                  
   [init-settings.{index}.value]                                 
-  [volume-type]                                                 Type of volume where data are stored (lssd, bssd, ...) (lssd | bssd)
+  [volume-type]                                                 Type of volume where data is stored (lssd, bssd, ...) (lssd | bssd)
   [volume-size]                                                 Volume size when volume_type is not lssd
-  [init-endpoints.{index}.private-network.private-network-id]   UUID of the private network to be connected to the database instance
-  [init-endpoints.{index}.private-network.service-ip]           Endpoint IPv4 adress with a CIDR notation. Check documentation about IP and subnet limitation.
-  [backup-same-region]                                          Store logical backups in the same region as the database instance
+  [init-endpoints.{index}.private-network.private-network-id]   UUID of the Private Network to be connected to the Database Instance
+  [init-endpoints.{index}.private-network.service-ip]           Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations.
+  [backup-same-region]                                          Defines whether to or not to store logical backups in the same region as the Database Instance
   [organization-id]                                             Organization ID to use. If none is passed the default organization ID will be used
   [region=fr-par]                                               Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete an instance.
+Delete a given Database Instance, specified by the `region` and `instance_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
 
 USAGE:
   scw rdb instance delete <instance-id ...> [arg=value ...]
 
 ARGS:
-  instance-id       UUID of the instance to delete
+  instance-id       UUID of the Database Instance to delete
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get the TLS certificate of an instance.
+Retrieve information about the TLS certificate of a given Database Instance. Details like name and content are returned in the response.
 
 USAGE:
   scw rdb instance get-certificate <instance-id ...> [arg=value ...]
 
 ARGS:
-  instance-id       UUID of the instance
+  instance-id       UUID of the Database Instance
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get an instance.
+Retrieve information about a given Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object.
 
 USAGE:
   scw rdb instance get <instance-id ...> [arg=value ...]
 
 ARGS:
-  instance-id       UUID of the instance
+  instance-id       UUID of the Database Instance
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS: