This short guide describes how to get the Postgres version of the database up and running.

1. Create empty database

As mentioned in the project's preliminary notes we’re currently using PostgreSQL version 10.12. Once postgres is up and running, create an empty postgres database. Remember the name of this database as it will be needed in the next steps.

2. Adjust database connection settings

Now You need to tell openIMIS to use the newly created database. The easiest way to do this is to re-run the dev tools installation with the new parameters. Those parameters are at the top of the file. Assuming You’re running the database on the same machine as the program and assuming You’re using the default port and user, it should look something like this (note that in this example the database is named openimis):

$db_host="localhost"
$db_port="5432"
$db_name="openimis"
$db_user="postgres"
$db_password="P@ssw0rd!"

Next You will need to edit the settings.py file of Your openIMIS installation. It should be located in <openIMIS base path>\openimis-be_py\openIMIS\openIMIS\
In this file, you need to import the appropriate driver for our new database. Add this line to all the import statements at the top:

import psycopg2.extensions

If you have not yet installed psycopg2 or it is not ye part of the project’s requirements.txt, do so now. From a command line (preferably in Your openIMIS' virtual environment), run the following command:

pip install psycopg2

In the Database section of the settings the following change to the database options. Only the parameters in the elif statement are different

Then, just below change the default settings (just in case). Only the ENGINE has been changed, as all other settings are loaded from variables:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': os.environ.get('DB_NAME'),
        'USER': os.environ.get('DB_USER'),
        'PASSWORD': os.environ.get('DB_PASSWORD'),
        'HOST': os.environ.get('DB_HOST'),
        'PORT': os.environ.get('DB_PORT'),
        'OPTIONS': DATABASE_OPTIONS}
}

3. Manage (almost) all tables with Django

In every module except api_fhir (openimis-be-api_fhir_py) go through each table and in the subclass meta set managed to True. The only exception is in the core module: the table core_User_Groups (the class is named UserGroup) should still have managed set to False.

4. Create this table in the new databse

In order to get Django to make the migration, the table auth_group must exist in Your new database and have the two users user and spiderman. I don’t know why (yet), but Django refuses to make the migrations unless this table exists. Just execute the following SQL query in your postgres database

CREATE TABLE public.auth_group
(
    id integer NOT NULL DEFAULT nextval('auth_group_id_seq'::regclass),
    name character varying(80) COLLATE pg_catalog."default" NOT NULL,
    CONSTRAINT auth_group_pkey PRIMARY KEY (id),
    CONSTRAINT auth_group_name_key UNIQUE (name)
)
WITH (
    OIDS = FALSE
)
TABLESPACE pg_default;
ALTER TABLE public.auth_group
    OWNER to postgres;
CREATE INDEX auth_group_name_a6ea08ec_like
    ON public.auth_group USING btree
    (name COLLATE pg_catalog."default" varchar_pattern_ops ASC NULLS LAST)
    TABLESPACE pg_default;
INSERT INTO public.auth_group (id, name) VALUES (1, 'spiderman');
INSERT INTO public.auth_group (id, name) VALUES (2, 'user');

5. Make the migration

Now make the migration. In Your <openIMIS base path>\openimis-be_py\openIMIS\ directory, run the following command from a command line:

python manage.py makemigrations

Depending on Your system setup You may need to run python3 instead of python.

You can keep this command line window open as we need to run another command in the same directory later.

6. Delete the table created in step 3

Now, drop the table we have created (auth_group) so that Django actually applies the migration. Yes, Django wants this table to exist to make the migrations but needs it to be gone when applying the migration.

In your postgres Database, run the following query:

DROP TABLE public.auth_group;

7. Adjust Migration Dependency

Django wants to run the migration for the policy module before the product module. This will lead to errors. In Your product module’s directory (where this module’s models.py file is located) there is a migrations folder. And in there is a file called 0001_initial.py. In that file Add the following lines at the top of the Migration class, just below initial = True:

run_before = [
     ('policy', '0001_initial'),
]

8. Apply the migration

Now You can apply the migration. Go back to Your command line window from step 5. In the same directory run the following command:

python manage.py migrate

The basic database structure of the openIMIS database should now exist in Your PostgreSQL database.