feat: add db schema (#1839)

Added the query to look in the schemas and not in the database.

* Replace the default value of schema by public

alerta/database/backends/mongodb/base.py

@@ -19,7 +19,7 @@
 
 class Backend(Database):
 
-    def create_engine(self, app, uri, dbname=None, raise_on_error=True):
+    def create_engine(self, app, uri, dbname=None, schema=None, raise_on_error=True):
         self.uri = uri
         self.dbname = dbname
 

alerta/database/backends/postgres/base.py

@@ -6,7 +6,7 @@
 import psycopg2
 from flask import current_app
 from psycopg2.extensions import AsIs, adapt, register_adapter
-from psycopg2.extras import Json, NamedTupleCursor, register_composite
+from psycopg2.extras import Json, NamedTupleCursor, register_composite, CompositeCaster
 
 from alerta.app import alarm_model
 from alerta.database.base import Database
@@ -62,26 +62,29 @@ def __str__(self):
 
 class Backend(Database):
 
-    def create_engine(self, app, uri, dbname=None, raise_on_error=True):
+    def create_engine(self, app, uri, dbname=None, schema='public', raise_on_error=True):
         self.uri = uri
         self.dbname = dbname
+        self.schema = schema
 
         lock = threading.Lock()
         with lock:
             conn = self.connect()
+
             with app.open_resource('sql/schema.sql') as f:
                 try:
                     conn.cursor().execute(f.read())
                     conn.commit()
                 except Exception as e:
+                    print("\n\n\n\nErreur\n\n\n\n")
                     if raise_on_error:
                         raise
                     app.logger.warning(e)
 
         register_adapter(dict, Json)
         register_adapter(datetime, self._adapt_datetime)
         register_composite(
-            'history',
+            schema + '.history' if schema else 'history',
             conn,
             globally=True
         )
@@ -97,6 +100,7 @@ def connect(self):
                     dbname=self.dbname,
                     cursor_factory=NamedTupleCursor
                 )
+
                 conn.set_client_encoding('UTF8')
                 break
             except Exception as e:
@@ -111,6 +115,8 @@ def connect(self):
                     time.sleep(backoff)
 
         if conn:
+            conn.cursor().execute("SET search_path TO {}".format(self.schema))
+            conn.commit()
             return conn
         else:
             raise RuntimeError(f'Database connect error. Failed to connect after {MAX_RETRIES} retries.')

alerta/database/base.py

@@ -56,7 +56,7 @@ def init_db(self, app):
         self.__class__ = type('DatabaseImpl', (cls.Backend, Database), {})
 
         try:
-            self.create_engine(app, uri=app.config['DATABASE_URL'], dbname=app.config['DATABASE_NAME'],
+            self.create_engine(app, uri=app.config['DATABASE_URL'], dbname=app.config['DATABASE_NAME'], schema=app.config['DATABASE_SCHEMA'],
                                raise_on_error=app.config['DATABASE_RAISE_ON_ERROR'])
         except Exception as e:
             if app.config['DATABASE_RAISE_ON_ERROR']:
@@ -65,7 +65,7 @@ def init_db(self, app):
 
         app.teardown_appcontext(self.teardown_db)
 
-    def create_engine(self, app, uri, dbname=None, raise_on_error=True):
+    def create_engine(self, app, uri, dbname=None, schema=None, raise_on_error=True):
         raise NotImplementedError('Database engine has no create_engine() method')
 
     def connect(self):

alerta/settings.py

@@ -45,6 +45,7 @@
 DATABASE_URL = MONGO_URI  # default: MongoDB
 DATABASE_NAME = MONGO_DATABASE or POSTGRES_DB
 DATABASE_RAISE_ON_ERROR = MONGO_RAISE_ON_ERROR  # True - terminate, False - ignore and continue
+DATABASE_SCHEMA = 'public'  # default: None to use default schema
 
 # Search
 DEFAULT_FIELD = 'text'  # default field if no search prefix specified (Postgres only)

alerta/sql/schema.sql

@@ -1,7 +1,7 @@
 
 DO $$
 BEGIN
-    IF NOT EXISTS (SELECT 1 FROM pg_type WHERE typname = 'history') THEN
+    IF NOT EXISTS (SELECT 1 FROM pg_type WHERE typname = 'history' AND typnamespace = (SELECT oid FROM pg_namespace WHERE nspname = current_schema())) THEN
         CREATE TYPE history AS (
             id text,
             event text,

alerta/utils/config.py

@@ -38,6 +38,7 @@ def get_user_config():
         # Use app config for DATABASE_URL if no env var from above override it
         config['DATABASE_URL'] = get_config('DATABASE_URL', default=database_url, type=str, config=config)
         config['DATABASE_NAME'] = get_config('DATABASE_NAME', default=None, type=str, config=config)
+        config['DATABASE_SCHEMA'] = get_config('DATABASE_SCHEMA', default='public', type=str, config=config)
 
         config['AUTH_REQUIRED'] = get_config('AUTH_REQUIRED', default=None, type=bool, config=config)
         config['AUTH_PROVIDER'] = get_config('AUTH_PROVIDER', default=None, type=str, config=config)