Update content

How to create a Document Database Instance

Reviewed on 01 August 2023Published on 01 August 2023

Managed Document Databases provide fully-managed document Database Instances, with FerretDB as a database engine.

Document databases enable users to store and retrieve data in a document format, such as json. Compared to traditional relational databases where data is stored in a table-like format, document-type storage supports storing multiple nested keys and values in each document key.

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
  1. Click Document Databases under Managed Databases on the side menu, if you do not have a Database Instance already created, the creation page displays.

  2. Click Create a Database Instance. The creation wizard displays.

  3. Complete the following steps in the wizard:

    • Select FerretDB as a database engine.
    • Choose a region. This is the geographical location where your database will be deployed.
    • Select a database configuration. You can choose between:
      • High Availability: creates a secondary node with an up-to-date replica of the database. If the primary Instance fails, the secondary takes over requests.
      • Standalone: creates a standalone database provisioned on a single node.
    • Select a node type.
    • Define the size of your Block Storage volume. You can increase your storage space without changing your node type, with no downtime. You can increase your volume to up to 10 TB.
    • Enable automatic backups, if necessary.
    • Add a name and set a password for your user.

    Your username must adhere to specific criteria.

    • Length must be between 1 and 63 characters
    • First character must be an alphabetic character (a-Za-Z)
    • It cannot start with _rdb
    • Only a-zA-Z0-9_$- characters are accepted
    • Enter a name for your Database Instance.
    • Tick the checkbox if you wish to share telemetry data with FerretDB.

    This option is available during the Public Beta phase of Document Databases. It allows you to contribute with the FerretDB Open Source project. Only request types, such as find and aggregate, will be collected and shared. Request parameters or response content are neither collected nor shared. Refer to the official Ferret DB documentation page on telemetry for more information.

  4. Click Create a Database Instance to confirm your choices and launch creation.

    You are taken to the Overview tab for your Database Instance, where you can see information including the Endpoint to enable you to connect to it.

See Also