Skip to main content

How To Choose, Configure, and Update Your Database

One important part of setting up your Amplication service is choosing and configuring your database. Your database is a plugin in Amplication, so you can operate it like other plugins.

This guide will walk you through the process of selecting, configuring, and updating your database in Amplication.

note

Amplication's Import Prisma Schema feature lets you use your existing databases and utilize the data you've already had in your existing app or service.

Choosing Your Database​

Amplication supports multiple database options. Here are the steps to choose your database:

  1. When creating a new service using the wizard in Amplication, you'll be required to select a database. If you're using Jovu to create your service, you can specify a different database than the default.
  2. Choose from the available options, which may include:
    • Microsoft SQL Server (default for .NET)
    • PostgreSQL (default for Node.js)
    • MongoDB
    • MySQL

Consider factors such as your team's familiarity with the database, scalability needs, and specific feature requirements when making your choice.

Configuring Your Database​

Once you've chosen your database, you'll need to configure it for your Amplication project.

  1. In your Amplication service's dashboard, navigate to the "Plugins" tab and click on "Installed Plugins" in the left sidebar.

  2. You'll see all your installed plugins. Find your database and click on the Settings button to get taken to its configuration page. These JSON configuration options can include:

    • Host
    • Port
    • Database name
    • Username
    • Password

  3. Replace the host, port, user, dbName, and password values with your specific database credentials. Click the Save button and your credentials will be applied by the plugin.

  4. To apply these changes to your generated code, click on the Generate the code button in the right sidebar.

Amplication Database Settings Configuration Page

Updating Your Database​

In Amplication, updating your database is as easy as uninstalling that specific db plugin and installing another.

  1. Proceed to the Installed Plugins tab. Uninstall your current database plugin.
  2. Click on the Database plugin category in the left sidebar and install a new database plugin.
  3. When you're ready to apply the changes click on the Generate the code button in the right sidebar.

Amplication Database Update DB

That's it! The generated code will include all the changes required to use the new database instead of the old one.

Best Practices​

  1. Testing: Always test database changes in a development or staging environment before applying them to production.
  2. Backups: Regularly backup your database, especially before applying significant schema changes.
  3. Performance: Monitor your database performance and optimize queries as your application grows.