MariaDB support

[wickham-c]

Thanks for contributing this VS Code extension; it certainly looks very promising. How easy would it be to auto-detect DB_HOST=mariadb from the .env file so as to provide support for MariaDB?

[damms005]

Thank you!

This is actually surprisingly easy to support MariaDB. I think I should write a short guide at this point being the second time I am asked this question haha.

Check my comment here if you want to give a stab at it and submit a PR so we look at it together: #38 (comment)

You can also ask follow up questions here if needed

Thanks again.

[damms005]

@cmwickham-pse2 I decided to implement this.

Although you mentioned DB_HOST=mariadb but I believe you meant DB_CONNECTION=mariadb, because Laravel Sail does not currently ship with support for MariaDB.

So, for MariaDB, simply use DB_CONNECTION=mysql in your .env file. This follows Laravel convention.

If instead you are using .devdbrc config file, simply create an entry similar to a MySQL entry.

[wickham-c]

Thanks for your reply Damilola.

Laravel Sail does support MariaDB (see this build script): the generated docker-compose.yml file references a mariadb:10 container image:

    mariadb:
        image: 'mariadb:10'
        ports:
            - '${FORWARD_DB_PORT:-3306}:3306'
        environment:
            MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}'
            MYSQL_ROOT_HOST: '%'
            MYSQL_DATABASE: '${DB_DATABASE}'
            MYSQL_USER: '${DB_USERNAME}'
            MYSQL_PASSWORD: '${DB_PASSWORD}'
            MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
        volumes:
            - 'sail-mariadb:/var/lib/mysql'
            - './vendor/laravel/sail/database/mysql/create-testing-database.sh:/docker-entrypoint-initdb.d/10-create-testing-database.sh'
        networks:
            - sail

The generated .env file includes the following variables:

DB_CONNECTION=mysql
DB_HOST=mariadb
DB_POST=3306
DB_DATABASE=projectname
DB_USERNAME=sail
DB_PASSWORD=password

Unfortunately, DevDB only seems to offer me a "SQLite Database File Picker" option and nothing specific to MySQL/MariaDB, so I'm guessing zero-config is tripping up on something.

I've also tried creating a .devdbrc file in my project root, containing the following:

[
  {
    "name": "My MariaDB database", // <-- to identify the connection
    "type": "mysql", // <- or "mariadb" if you are using MariaDB
    "host": "mariadb",
    "port": "3306",
    "username": "sail",
    "password": "password",
    "database": "projectname" // <-- the database to show in VS Code DevDb view
  }
]

...and have tried the "type": "mariadb", variation, but still only see the "SQLite Database File Picker" option.

Am I doing something obviously wrong?

[damms005]

Yes you are correct. Laravel Sail does support MariaDB.

However, I said it "does not currently ship with support for MariaDB", to mean you have to set it up yourself because fresh Laravel Sail installation defaults to MySQL. Although, it now uses Laravel Prompt to ask for the services to install and MariaDB is now listed among the defaults.

I intentionally focused on supporting "defaults" at the launch of DevDb, so that I can later focus on non-default setups as well as edge cases.

That said, please ensure you are running DevDb v1.2.0 or later because it has full MariaDB support, including bug fixes.

v1.2.0 or later also ensures that most setup/connection errors are now shown as standard VS Code notifications. If the issues persists even after you upgrade to v1.2.0 or later, please open a bug report with full details so this can be properly handled. Do not forget to include any notifications that is shown by DevDb too. e.g.:

NOTE
You may need to click on the little dot on the bell icon as shown in the screenshot below in order to see the notifications

Many thanks!