Group the different parts of database initialisation more clearly by changing

the order of SQL commands in the file "00-initialize.sql" to be more logical.

Add SQL comment lines to separate initialisation of roles and different
databases.

Author: jarkkoka

azuredbmock/00-initialize.sql

@@ -2,6 +2,10 @@
 -- Initializations, which are needed locally, but not in the cloud / prod environments,
 -- go here.
 
+--
+-- DATABASE ROLES
+--
+
 -- These database roles are also created in the azure-infra-jore4aks (Azure
 -- DevOps) repository.
 CREATE USER xxx_db_auth_username_xxx PASSWORD 'xxx_db_auth_password_xxx';
@@ -10,6 +14,16 @@ CREATE USER xxx_db_hasura_username_xxx PASSWORD 'xxx_db_hasura_password_xxx';
 CREATE USER xxx_db_tiamat_username_xxx PASSWORD 'xxx_db_tiamat_password_xxx';
 CREATE USER xxx_db_timetables_api_username_xxx PASSWORD 'xxx_db_timetables_api_password_xxx';
 
+-- Make hasura role a member of jore3importer role because both roles must have
+-- ownership of tables and sequences since both are responsible for populating
+-- and truncating tables in the network & routes database. In particular,
+-- sequence reset requires an ownership and cannot be granted as a privilege.
+GRANT xxx_db_jore3importer_username_xxx TO xxx_db_hasura_username_xxx;
+
+--
+-- NETWORK & ROUTES DATABASE
+--
+
 -- Create the extensions used, see https://hasura.io/docs/latest/graphql/core/deployment/postgres-requirements.html
 -- Create the extensions in the public schema, since we'd need to give additional privileges ("use schema") to any
 -- user who wishes to use these in the future. Also, Hasura would require additional setup to be able to use the
@@ -21,36 +35,46 @@ CREATE EXTENSION IF NOT EXISTS btree_gist WITH SCHEMA public;
 -- allow hasura to create new schemas
 GRANT CREATE ON DATABASE xxx_db_hasura_name_xxx TO xxx_db_hasura_username_xxx;
 
--- create database for auth and give ALL privileges to auth db user
+--
+-- AUTH DATABASE
+--
+
+-- create database and give ALL privileges to auth db user
 CREATE DATABASE xxx_db_auth_name_xxx;
 GRANT ALL ON DATABASE xxx_db_auth_name_xxx TO xxx_db_auth_username_xxx;
 
--- Make hasura role a member of jore3importer role because both roles must have
--- ownership of tables and sequences since both are responsible for populating
--- and truncating tables. In particular, sequence reset requires an ownership
--- and cannot be granted as a privilege.
-GRANT xxx_db_jore3importer_username_xxx TO xxx_db_hasura_username_xxx;
+--
+-- JORE3 IMPORTER DATABASE
+--
 
--- create database for jore3 importer and give ALL privileges to jore3importer db user
+-- create database and give ALL privileges to jore3importer db user
 CREATE DATABASE xxx_db_jore3importer_name_xxx;
 GRANT ALL ON DATABASE xxx_db_jore3importer_name_xxx TO xxx_db_jore3importer_username_xxx;
 
--- create database for timetables and allow hasura to create new schemas in it
+--
+-- TIMETABLES DATABASE
+--
+
+-- create database and allow hasura to create new schemas in it
 CREATE DATABASE xxx_db_timetables_name_xxx;
 GRANT CREATE ON DATABASE xxx_db_timetables_name_xxx TO xxx_db_hasura_username_xxx;
 
--- create database for stop registry and give ALL privileges to Tiamat in it
-CREATE DATABASE xxx_db_tiamat_name_xxx;
-GRANT ALL ON DATABASE xxx_db_tiamat_name_xxx TO xxx_db_tiamat_username_xxx;
+-- interval outputs by default are using the sql format ('3 4:05:06'). Here we are switching to ISO 8601 format ('P3DT4H5M6S')
+ALTER DATABASE xxx_db_timetables_name_xxx SET intervalstyle = 'iso_8601';
 
 -- switch database context to timetables db to be able to add extensions there
 \connect xxx_db_timetables_name_xxx;
 
 CREATE EXTENSION IF NOT EXISTS pgcrypto WITH SCHEMA public;
 CREATE EXTENSION IF NOT EXISTS btree_gist WITH SCHEMA public;
 
--- interval outputs by default are using the sql format ('3 4:05:06'). Here we are switching to ISO 8601 format ('P3DT4H5M6S')
-ALTER DATABASE xxx_db_timetables_name_xxx SET intervalstyle = 'iso_8601';
+--
+-- STOP REGISTRY DATABASE
+--
+
+-- create database and give ALL privileges to Tiamat in it
+CREATE DATABASE xxx_db_tiamat_name_xxx;
+GRANT ALL ON DATABASE xxx_db_tiamat_name_xxx TO xxx_db_tiamat_username_xxx;
 
 -- switch database context to stop db to initialize it to the state where tiamat can use it
 \connect xxx_db_tiamat_name_xxx;