ContextQMD
Back to Graphql Engine

Getting Started with MariaDB in Hasura Cloud

docs/docs/databases/mariadb/cloud.mdx

2.50.13.2 KB
Original Source

import Thumbnail from '@site/src/components/Thumbnail'; import ProductBadge from '@site/src/components/ProductBadge';

Getting Started with MariaDB in Hasura Cloud

<ProductBadge free pro ee />

Introduction

This guide will help you get set up with Hasura Cloud and our MariaDB integration. This is the easiest way to set up Hasura Engine and the MariaDB GraphQL Data Connector.

:::tip Supported versions:

  1. Hasura GraphQL Engine v2.24.0 onwards
  2. Hasura supports most databases with standard implementations of MariaDB 10.6 and higher including: Amazon RDS, Amazon Aurora, Digital Ocean and SkySQL.

:::

:::tip Supported features

Hasura currently supports queries, mutations (INSERT, UPDATE, DELETE), table relationships, remote relationships and permissions on MariaDB.

Note that Hasura doesn't yet support the ability to modify the database schema for MariaDB, so the database you connect to should already contain tables and data. You should also ideally have access to it outside of Hasura to modify the schema.

:::

Try it out

Step 1: Create an account on Hasura Cloud and create a new Hasura Project

Navigate to cloud.hasura.io, and create a new Hasura Cloud account.

Once you create a project on Hasura Cloud, hit the "Launch Console" button to open the Hasura Console for your project.

<Thumbnail src="/img/databases/data-connector/create-project.png" alt="Connect new or existing database" width="1000px" />

Step 2: Connect to a MariaDB database

From the Console, click the Data tab:

<Thumbnail src="/img/getting-started/connect-db-console.png" alt="Connect database" width="1000px" />

Select the MariaDB data source driver. Enter a database display name and the JDBC Connection URL for your MariaDB instance.

The JDBC connection URL should look like this:

yaml
jdbc:mariadb://<hostname>:<port>/<database name>?user=<username>&password=<password>

For example:

yaml
jdbc:mariadb://myhost.mycompany.com/mariadbtest?user=abc&password=pqr  # assuming the default port 3306
jdbc:mariadb://localhost:4533/mariadbtest?user=abc&password=pqr        # assuming MariaDB is running on port 4533

For more information see MariaDB Connection URL syntax.

Click Connect Database.

:::info Ensure your password escapes special characters

Due to the potential variations in drivers, it's crucial to escape special characters used in the password of the connection string. These include { } % & #. To escape a character, use the appropriate escape sequence based on your database's driver's documentation.

:::

Step 3: Track tables and run GraphQL API queries

Now that you have successfully connected your MariaDB database to Hasura, you can track tables and use Hasura to automatically build a GraphQL API on top of it.

Keep up to date

If you'd like to stay informed about the status of MariaDB support, subscribe to our newsletter and join our discord!