Set up MySQL service

The mysql service provides data storage. It is based on MariaDB, supporting the XtraDB storage engine (equivalent to MySQL with InnoDB).

We support MariaDB version 10.0, which includes reimplemented features from MySQL 5.6 and 5.7.

To access the MariaDB database directly, open an SSH tunnel and use the following command:

mysql -h database.internal -u user

You can use the following instructions for service setup on Magento Commerce Cloud Pro Integration environments and Starter environments including Production master. You must submit a support ticket to configure the service on Pro Production and Staging environments. See Services.

Set up multiple database users

You can optionally set up multiple databases as well as multiple users with different permissions. By default, there is one endpoint named mysql that has administrator access to all defined databases.

To set up multiple databases and users, you must specify multiple endpoints. An endpoint is a user who has privileges you specify.

You cannot use multiple databases with Magento Commerce at this time. You can create multiple endpoints to restrict access to the main database.

To specify user access, use the endpoints nested array. Each endpoint can have access to one or more schemas (databases), and can have different levels of permission on each.

The valid permission levels are:

  • ro: Only SELECT queries are allowed.
  • rw: SELECT queries as well as INSERT/UPDATE/DELETE queries are allowed.
  • admin: All queries are allowed, including DDL queries (CREATE TABLE, DROP TABLE, and so on).

If no endpoints are defined, a single endpoint named mysql has admin access to the main database.


    type: mysql:10.0
    disk: 2048
            - main
                default_schema: main
                    main: admin
                    main: ro
                    main: rw

In the preceding example, the endpoint (that is, user) reporter has ro privileges to the main database and endpoint importer has rw access to the main database. This means that:

  • The admin user has full control of the database.
  • The repoter user has SELECT privileges only.
  • The importer user has SELECT, INSERT, UPDATE, and DELETE privileges.

Add MySQL in services.yaml and

To enable MySQL, add the following code with your installed version and allocated disk space in MB to .magento/services.yaml.

    type: mysql:10.0
    disk: 2048

To configure the relationships for the environment variable, set a relationship in your in the Git branch. For example:

    database: "mydatabase:mysql"

Merge and deploy the code to set the configurations for Redis. For information on how these changes affect your environments, see services.yaml.

  • If you configure one MySQL user, you cannot use the DEFINER access control mechanism for stored procedures and views.
  • MySQL errors such as PDO Exception 'MySQL server has gone away are usually the result of exhausting your existing disk space. Be sure you have sufficient space allocated to the service in .magento/services.yaml.

Verify environment-related relationships

We use the Magento Commerce Cloud environment variable $MAGENTO_CLOUD_RELATIONSHIPS, a JSON object, to retrieve environment-related relationships.

To verify this information used for configurations and settings:

  1. SSH into the Integration environment with MySQL installed and configured.
  2. Enter the following command to pretty-print connection information for MySQL:

     php -r 'print_r(json_decode(base64_decode($_ENV["MAGENTO_CLOUD_RELATIONSHIPS"])));'

The response includes all relationships for services and configuration data for that environment. In the response, you will locate data similar to the following for MySQL:

  "database": [
      "host": "database.internal",
      "ip": "",
      "password": "",
      "path": "main",
      "port": 3306,
      "query": {
          "is_master": true
      "scheme": "mysql",
      "username": "user"