Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help


description: Learn how to connect your aimicromind instance to a database

Databases


Setup

aimicromind supports 4 database types:

  • SQLite
  • MySQL
  • PostgreSQL
  • MariaDB

SQLite (Default)

SQLite will be the default database. These databases can be configured with following env variables:

DATABASE_TYPE=sqlite
DATABASE_PATH=/root/.aimicromind #your preferred location

A database.sqlite file will be created and saved in the path specified by DATABASE_PATH. If not specified, the default store path will be in your home directory -> .aimicromind

Note: If none of the env variables is specified, SQLite will be the fallback database choice.

MySQL

DATABASE_TYPE=mysql
DATABASE_PORT=3306
DATABASE_HOST=localhost
DATABASE_NAME=aimicromind
DATABASE_USER=user
DATABASE_PASSWORD=123

PostgreSQL

DATABASE_TYPE=postgres
DATABASE_PORT=5432
DATABASE_HOST=localhost
DATABASE_NAME=aimicromind
DATABASE_USER=user
DATABASE_PASSWORD=123
PGSSLMODE=require

MariaDB

DATABASE_TYPE="mariadb"
DATABASE_PORT="3306"
DATABASE_HOST="localhost"
DATABASE_NAME="aimicromind"
DATABASE_USER="aimicromind"
DATABASE_PASSWORD="mypassword"

How to use aimicromind databases SQLite and MySQL/MariaDB (coming soon)

Backup

  1. Shut down AiMicromind application.
  2. Ensure that the database connection to other applications is turned off.
  3. Backup your database.
  4. Test backup database.

SQLite

  1. Rename file name.

    Windows:

    rename "DATABASE_PATH\database.sqlite" "DATABASE_PATH\BACKUP_FILE_NAME.sqlite"
    

    Linux:

    mv DATABASE_PATH/database.sqlite DATABASE_PATH/BACKUP_FILE_NAME.sqlite
    
  2. Backup database.

    Windows:

    copy DATABASE_PATH\BACKUP_FILE_NAME.sqlite DATABASE_PATH\database.sqlite
    

    Linux:

    cp DATABASE_PATH/BACKUP_FILE_NAME.sqlite DATABASE_PATH/database.sqlite
    
  3. Test backup database by running AiMicromind.

PostgreSQL

  1. Backup database.

    pg_dump -U USERNAME -h HOST -p PORT -d DATABASE_NAME -f /PATH/TO/BACKUP_FILE_NAME.sql
    
  2. Enter database password.

  3. Create test database.

    psql -U USERNAME -h HOST -p PORT -d TEST_DATABASE_NAME -f /PATH/TO/BACKUP_FILE_NAME.sql
    
  4. Test the backup database by running aimicromind with the .env file modified to point to the backup database.

MySQL & MariaDB

  1. Backup database.

    mysqldump -u USERNAME -p DATABASE_NAME > BACKUP_FILE_NAME.sql
    
  2. Enter database password.

  3. Create test database.

    mysql -u USERNAME -p TEST_DATABASE_NAME < BACKUP_FILE_NAME.sql
    
  4. Test the backup database by running aimicromind with the .env file modified to point to the backup database.