Aiven MySQL and Koyeb
Aiven for MySQL (opens in a new tab) allows you to get a fully managed MySQL database deployed in the cloud of your choice in a few minutes. Aiven takes care of everything for you including installing security patches, upgrades, automatic backups, and allows you to scale your MySQL databases up or down as needed.
This guide explains how to connect an Aiven managed MySQL database to an application running on Koyeb. To successfully follow this documentation, you will need to have:
- A Koyeb account (opens in a new tab) to deploy the application. You can optionally install the Koyeb CLI to deploy the application from the command line.
- An Aiven account (opens in a new tab) to deploy the Aiven MySQL database.
The application that connects to the Aiven managed MySQL database uses Prisma as an ORM. Prisma is an open-source ORM. We use it to synchronize our database schema with our Prisma schema.
If you already have a freshly created Aiven managed MySQL database running and want to quickly preview how to connect your database to an application running on Koyeb, use the Deploy to Koyeb button below.
Make sure to replace the DATABASE_URL
environment variable with the connection string of your Aiven
database.
Create an Aiven MySQL database
To create an Aiven managed MySQL database, sign in to your Aiven account (opens in a new tab).
On the Aiven control panel, click the Create Service button to provision a database and access the service creation page.
- Select MySQL as the service you want to create.
- Choose the Cloud Provider where your Aiven database will run. You can choose between AWS, GCP, Azure, DigitalOcean, and UpCloud. For this guide, we use Google Cloud.
- Pick the Region to run the database in. Here, we selected google-europe-west3 (Frankfurt) as our compute will be deployed in this region on Koyeb.
- Select the service Plan. Different plans are available depending on what resources and features you need. For this guide, we use the Hobbyist plan.
- Give your service a name, e.g.
aiven-koyeb
.
When you are done configuring your database, click the Create service button. Your database will be provisioned.
Retrieve your Aiven MySQL connection string
From your Aiven MySQL service page, click the Copy button icon on the right side of the Service URI field. The connection string should be similar to the following:
mysql://<USER>:<PASSWORD>@<HOST>:<PORT>/defaultdb?ssl-mode=REQUIRED
Save it in a safe place, we will need it in the next step to connect our application to the database.
Deploy the application to Koyeb
You can deploy on Koyeb using the control panel or via the Koyeb CLI.
To deploy the example application (opens in a new tab) using the control panel (opens in a new tab), follow these steps:
- Click Create Web Service on the Overview tab of the Koyeb control panel.
- Select GitHub as the deployment option.
- Set
https://github.com/koyeb/example-express-prisma
as the GitHub repository to deploy. - Expand the Builder section. Click the override toggle associated with the Build command and enter
npm run mysql:init
in the field. - Expand the Environment variables section. Add a
DATABASE_URL
environment variable to tell the application how to connect to the Aiven MySQL database. Give the environment variable the nameDATABASE_URL
and enter the connection string from earlier as the value. - Name your App and Service, for instance
express-aiven-mysql
. - Click the Deploy button.
A Koyeb App and Service will be created. Your application will be built and deployed to Koyeb. Once the build has finished, you will be able to access your application running on Koyeb by clicking the URL ending with .koyeb.app
.
The example application exposes a /planets
endpoint that you can use to list planets from the database. Once your Deployment is live, you should see the following results when navigating to https://<YOUR_APP_URL>.koyeb.app/planets
:
[
{
"id": 1,
"name": "Mercury"
},
{
"id": 2,
"name": "Venus"
},
{
"id": 3,
"name": "Mars"
}
]
Delete the example application and Aiven MySQL database
To delete the example application and the Aiven MySQL database and avoid incurring any charges, follow these steps:
- From the Aiven MySQL dashboard (opens in a new tab), click on the service you created and click Delete service. Follow the instructions.
- From the Koyeb control panel (opens in a new tab), select the App to delete. Under the Settings tab, click the Delete button and follow the instructions.