Add a script to be able to clone a schema

doc/integrator/database.rst

@@ -0,0 +1,44 @@
+.. _integrator_database:
+
+========
+Database
+========
+
+To be able to do a rollback the integration and the production data should be in the same database,
+but the schema will be different.
+
+For the static schema will have one for the integration and one for the production environments, e.-g.:
+``integration_static`` for the integration environment,
+and ``production_static`` for the production environment.
+
+For the main schema will have one for each version of the application. We will have the following livecycle:
+
+Current version:
+integration and production => ``main_2017``
+
+Start an upgrade (application or admin (layertree)), create an new schema and use it on integration:
+integration = ``main_2018``, and production => ``main_2017``
+
+Do the changes or the upgrade.
+
+Publish the new version:
+integration and production => ``main_2018``
+
+The schema ``main_2017`` still exists to be able to rollback the production.
+
+To do that we should manage the ``PGSCHEMA`` and the ``PGSCHEMA_STATIC`` variable in your makefiles.
+
+The ``PGSCHEMA`` should be set in the ``Makefile`` and the ``PGSCHEMA_STATIC`` for the production should be
+set in a specific makefile for the production e.-g. ``production.mk``.
+
+To to the schema we provide a Postgres function, to create it:
+
+.. prompt:: bash
+
+   sudo -u postgres psql <database> --file=scripts/CONST_clone_schema.sql
+
+To use it:
+
+.. code:: sql
+
+   SELECT clone_schema('<current_schema_name>', '<new_schema_name>', TRUE);

doc/integrator/index.rst

@@ -17,6 +17,7 @@ Content:
    create_application
    install_application
    upgrade_application
+   database
    configuration
    customise
    security

geoportal/c2cgeoportal_geoportal/scaffolds/create/Makefile_tmpl

@@ -5,4 +5,7 @@ VARS_FILE = vars.yaml
 VARS_FILES += ${VARS_FILE}
 endif
 
+PGSCHEMA ?= main
+PGSCHEMA_STATIC ?= main_static
+
 include CONST_Makefile

geoportal/c2cgeoportal_geoportal/scaffolds/update/scripts/CONST_clone_schema.sql

@@ -0,0 +1,204 @@
+CREATE OR REPLACE FUNCTION clone_schema(
+    source_schema text,
+    dest_schema text,
+    include_recs boolean)
+  RETURNS void AS
+$BODY$
+
+-- This function will clone all sequences, tables, data, views & functions from any existing schema to a
+-- new one, just call:
+-- SELECT clone_schema('current_schema', 'new_schema', TRUE);
+-- See also: https://www.postgresql.org/message-id/CANu8FiyJtt-0q%3DbkUxyra66tHi6FFzgU8TqVR2aahseCBDDntA%40mail.gmail.com
+
+DECLARE
+  src_oid oid;
+  func_oid oid;
+  object text;
+  buffer text;
+  srctbl text;
+  default_ text;
+  column_ text;
+  qry text;
+  dest_qry text;
+  v_def text;
+  owner text;
+  grantor text;
+  privilege_type text;
+  sq_last_value bigint;
+  sq_max_value bigint;
+  sq_start_value bigint;
+  sq_increment_by bigint;
+  sq_min_value bigint;
+  sq_cache_value bigint;
+  sq_is_called boolean;
+  sq_is_cycled boolean;
+  sq_cycled char(10);
+
+BEGIN
+
+-- Check that source_schema exists
+  SELECT oid INTO src_oid
+    FROM pg_namespace
+   WHERE nspname = quote_ident(source_schema);
+  IF NOT FOUND
+    THEN
+    RAISE NOTICE 'source schema % does not exist!', source_schema;
+    RETURN;
+  END IF;
+
+  -- Check that dest_schema does not yet exist
+  PERFORM nspname
+    FROM pg_namespace
+   WHERE nspname = quote_ident(dest_schema);
+  IF FOUND
+    THEN
+    RAISE NOTICE 'dest schema % already exists!', dest_schema;
+    RETURN;
+  END IF;
+
+  EXECUTE 'CREATE SCHEMA ' || quote_ident(dest_schema);
+  EXECUTE 'SELECT schema_owner
+    FROM information_schema.schemata
+    WHERE schema_name = ''' || quote_ident(source_schema) || ''';'
+    INTO owner;
+  EXECUTE 'ALTER SCHEMA ' || quote_ident(dest_schema) || ' OWNER TO ' || quote_ident(owner);
+
+  -- Create sequences
+  -- TODO: Find a way to make this sequence's owner is the correct table.
+  FOR object IN
+    SELECT sequence_name::text
+    FROM information_schema.sequences
+    WHERE sequence_schema = quote_ident(source_schema)
+  LOOP
+    EXECUTE 'CREATE SEQUENCE ' || quote_ident(dest_schema) || '.' || quote_ident(object);
+    srctbl := quote_ident(source_schema) || '.' || quote_ident(object);
+
+    EXECUTE 'SELECT last_value, max_value, start_value, increment_by, min_value, cache_value, is_cycled, is_called
+        FROM ' || quote_ident(source_schema) || '.' || quote_ident(object) || ';'
+        INTO sq_last_value, sq_max_value, sq_start_value, sq_increment_by, sq_min_value, sq_cache_value, sq_is_cycled, sq_is_called;
+
+    IF sq_is_cycled
+    THEN
+      sq_cycled := 'CYCLE';
+    ELSE
+      sq_cycled := 'NO CYCLE';
+    END IF;
+
+    EXECUTE 'ALTER SEQUENCE ' || quote_ident(dest_schema) || '.' || quote_ident(object)
+        || ' INCREMENT BY ' || sq_increment_by
+        || ' MINVALUE ' || sq_min_value
+        || ' MAXVALUE ' || sq_max_value
+        || ' START WITH ' || sq_start_value
+        || ' RESTART ' || sq_min_value
+        || ' CACHE ' || sq_cache_value
+        || sq_cycled || ';';
+
+    buffer := quote_ident(dest_schema) || '.' || quote_ident(object);
+    IF include_recs
+    THEN
+      EXECUTE 'SELECT setval( ''' || buffer || ''', ' || sq_last_value || ', ' || sq_is_called || ');';
+    ELSE
+      EXECUTE 'SELECT setval( ''' || buffer || ''', ' || sq_start_value || ', ' || sq_is_called || ');';
+    END IF;
+  END LOOP;
+
+-- Create tables
+  FOR object IN
+    SELECT TABLE_NAME::text
+    FROM information_schema.tables
+    WHERE table_schema = quote_ident(source_schema)
+      AND table_type = 'BASE TABLE'
+  LOOP
+    buffer := dest_schema || '.' || quote_ident(object);
+    EXECUTE 'CREATE TABLE ' || buffer || ' (LIKE ' || quote_ident(source_schema) || '.' || quote_ident(object)
+        || ' INCLUDING ALL)';
+
+    EXECUTE 'SELECT tableowner
+      FROM pg_catalog.pg_tables
+      WHERE schemaname = ''' || quote_ident(source_schema) || ''' AND tablename = ''' || quote_ident(object) || ''';'
+      INTO owner;
+    EXECUTE 'ALTER TABLE ' || quote_ident(dest_schema) || '.' || quote_ident(object) || ' OWNER TO ' || quote_ident(owner);
+
+    FOR grantor, privilege_type IN
+      SELECT tp.grantor, tp.privilege_type
+      FROM information_schema.table_privileges AS tp
+      WHERE table_schema = quote_ident(source_schema) AND table_name = quote_ident(object)
+    LOOP
+      EXECUTE 'GRANT ' || privilege_type || ' ON TABLE '
+          || quote_ident(source_schema) || '.' || quote_ident(object)
+          || ' TO ' || quote_ident(grantor);
+    END LOOP;
+
+         IF include_recs
+      THEN
+      -- Insert records from source table
+      EXECUTE 'INSERT INTO ' || buffer || ' SELECT * FROM ' ||
+          quote_ident(source_schema) || '.' || quote_ident(object) || ';';
+    END IF;
+
+    FOR column_, default_ IN
+      SELECT column_name::text,
+        REPLACE(column_default::text, source_schema, dest_schema)
+        FROM information_schema.COLUMNS
+        WHERE table_schema = dest_schema
+          AND TABLE_NAME = object
+          AND column_default LIKE 'nextval(%' || quote_ident(source_schema) || '%::regclass)'
+    LOOP
+      EXECUTE 'ALTER TABLE ' || buffer || ' ALTER COLUMN ' || column_ || ' SET DEFAULT ' || default_;
+    END LOOP;
+  END LOOP;
+
+-- add FK constraint
+  FOR qry IN
+    SELECT 'ALTER TABLE ' || quote_ident(dest_schema) || '.' || quote_ident(rn.relname)
+        || ' ADD CONSTRAINT ' || quote_ident(ct.conname) || ' ' || pg_get_constraintdef(ct.oid) || ';'
+    FROM pg_constraint ct
+    JOIN pg_class rn ON rn.oid = ct.conrelid
+    WHERE connamespace = src_oid
+      AND rn.relkind = 'r'
+      AND ct.contype = 'f'
+    LOOP
+      EXECUTE qry;
+    END LOOP;
+
+-- Create views
+  FOR object IN
+    SELECT table_name::text,
+        view_definition
+    FROM information_schema.views
+    WHERE table_schema = quote_ident(source_schema)
+  LOOP
+    buffer := dest_schema || '.' || quote_ident(object);
+    SELECT view_definition INTO v_def
+    FROM information_schema.views
+    WHERE table_schema = quote_ident(source_schema)
+     AND table_name = quote_ident(object);
+
+    EXECUTE 'CREATE OR REPLACE VIEW ' || buffer || ' AS ' || v_def || ';';
+
+    EXECUTE 'SELECT viewowner
+      FROM pg_catalog.pg_views
+      WHERE schemaname = ''' || quote_ident(source_schema) || ''' AND viewname = ''' || quote_ident(object) || ''';'
+    INTO owner;
+    EXECUTE 'ALTER SCHEMA ' || quote_ident(dest_schema) || ' OWNER TO ' || quote_ident(owner);
+  END LOOP;
+
+-- Create functions
+  FOR func_oid IN
+    SELECT oid
+    FROM pg_proc
+    WHERE pronamespace = src_oid
+  LOOP
+    SELECT pg_get_functiondef(func_oid) INTO qry;
+    SELECT replace(qry, source_schema, dest_schema) INTO dest_qry;
+    EXECUTE dest_qry;
+  END LOOP;
+
+  RETURN;
+END;
+
+$BODY$
+  LANGUAGE plpgsql VOLATILE
+  COST 100;
+ALTER FUNCTION clone_schema(text, text, boolean)
+  OWNER TO postgres;