databases.md

Creating a database to use with Riprap

These instructions assume you have the database engine installed installed and configured properly, with the appropriate PHP drivers.

SQLite

Follow these instructions from within the riprap directory:

1. Edit the .env file so that the line DATABASE_URL=sqlite:///%kernel.project_dir%/var/data.db is uncommented and the other lines starting with DATABASE_URL are commented out.
2. rm var/data.db (might not exist)
3. rm src/Migrations/* (might be empty)
4. php bin/console -n make:migration
5. php bin/console -n doctrine:migrations:migrate
6. Optional: When you run the check_fixity command as described below, it will create events based on the fixity checks. If you want to populate the database with some sample fixity events prior to running check_fixity (you don't need to), run php bin/console -n doctrine:fixtures:load

MySQL

In config/packages/doctrine.yaml, make sure you have:

doctrine:
    dbal:
        driver: 'pdo_mysql'
        server_version: '5.7' # Or whatever version you are running.
        charset: utf8mb4
        default_table_options:
            charset: utf8mb4
            collate: utf8mb4_unicode_ci

Then follow these instructions from within the riprap directory:

1. Create a MySQL user with create privileges
2. Edit the .env file so that this line contains the user, password, and database name you want: DATABASE_URL=mysql://user:[email protected]:3306/riprap and the other lines starting with DATABASE_URL are commented out. You can also use a remote database by specifying its hostname like this: DATABASE_URL=mysql://user:[email protected]:3306/riprap.
3. rm src/Migrations/* (might be empty)
4. php bin/console doctrine:database:create
5. php bin/console -n make:migration
6. php bin/console -n doctrine:migrations:migrate
7. Optional: When you run the check_fixity command as described below, it will create events based on the fixity checks. If you want to populate the database with some sample fixity events prior to running check_fixity (you don't need to), run php bin/console -n doctrine:fixtures:load

PostgreSQL

In config/packages/doctrine.yaml, make sure you have:

doctrine:
    dbal:
        driver: 'pdo_pgsql'
        charset: utf8

Then follow these instructions from within the riprap directory:

1. Create a PostgreSQL user with 'createdb' privileges
2. Edit the .env file so that this line contains the user, password, and database name you want: DATABASE_URL=pgsql://user:[email protected]:5432/riprap and the other lines starting with DATABASE_URL are commented out. You can also use a remote database by specifying its hostname like this: DATABASE_URL=pgsql://user:[email protected]:5432/riprap.
3. rm src/Migrations/* (might be empty)
4. php bin/console doctrine:database:create
5. php bin/console -n make:migration
6. php bin/console -n doctrine:migrations:migrate
7. Optional: When you run the check_fixity command as described below, it will create events based on the fixity checks. If you want to populate the database with some sample fixity events prior to running check_fixity (you don't need to), run php bin/console -n doctrine:fixtures:load