cp sql/ from GNU Taler exchange

include/sql/0002-kyc_attributes.sql

@@ -0,0 +1,161 @@
+--
+-- This file is part of TALER
+-- Copyright (C) 2014--2022 Taler Systems SA
+--
+-- TALER is free software; you can redistribute it and/or modify it under the
+-- terms of the GNU General Public License as published by the Free Software
+-- Foundation; either version 3, or (at your option) any later version.
+--
+-- TALER is distributed in the hope that it will be useful, but WITHOUT ANY
+-- WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+-- A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+--
+-- You should have received a copy of the GNU General Public License along with
+-- TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
+--
+
+CREATE OR REPLACE FUNCTION create_table_kyc_attributes(
+  IN partition_suffix TEXT DEFAULT NULL
+)
+RETURNS VOID
+LANGUAGE plpgsql
+AS $$
+DECLARE
+  table_name TEXT DEFAULT 'kyc_attributes';
+BEGIN
+  PERFORM create_partitioned_table(
+    'CREATE TABLE IF NOT EXISTS %I'
+      '(kyc_attributes_serial_id BIGINT GENERATED BY DEFAULT AS IDENTITY'
+      ',h_payto BYTEA CHECK (LENGTH(h_payto)=32)'
+      ',collection_time INT8 NOT NULL'
+      ',expiration_time INT8 NOT NULL'
+      ',encrypted_attributes BYTEA NOT NULL'
+      ',legitimization_serial INT8 NOT NULL'
+      ',form_name TEXT DEFAULT(NULL)'
+      ',by_aml_officer BOOL NOT NULL DEFAULT(FALSE)'
+    ') %s ;'
+    ,table_name
+    ,'PARTITION BY HASH (h_payto)'
+    ,partition_suffix
+  );
+  PERFORM comment_partitioned_table(
+     'KYC data about particular payment addresses'
+    ,table_name
+    ,partition_suffix
+  );
+  PERFORM comment_partitioned_column(
+     'hash of payto://-URI the attributes are about'
+    ,'h_payto'
+    ,table_name
+    ,partition_suffix
+  );
+  PERFORM comment_partitioned_column(
+     'time when the attributes were collected by the provider'
+    ,'collection_time'
+    ,table_name
+    ,partition_suffix
+  );
+  PERFORM comment_partitioned_column(
+     'time when the attributes should no longer be considered validated'
+    ,'expiration_time'
+    ,table_name
+    ,partition_suffix
+  );
+  PERFORM comment_partitioned_column(
+     '(encrypted) JSON object (as string) with the attributes'
+    ,'encrypted_attributes'
+    ,table_name
+    ,partition_suffix
+  );
+  PERFORM comment_partitioned_column(
+     'Reference the legitimization process for which these attributes are gathered for.'
+    ,'legitimization_serial'
+    ,table_name
+    ,partition_suffix
+  );
+  PERFORM comment_partitioned_column(
+     'Name of the form (FORM_ID) that is captured in the attributes.'
+    ,'form_name'
+    ,table_name
+    ,partition_suffix
+  );
+  PERFORM comment_partitioned_column(
+     'TRUE if the attributes were submitted by an AML officer.'
+    ,'by_aml_officer'
+    ,table_name
+    ,partition_suffix
+  );
+END $$;
+
+COMMENT ON FUNCTION create_table_kyc_attributes
+  IS 'Creates the kyc_attributes table';
+
+
+CREATE OR REPLACE FUNCTION constrain_table_kyc_attributes(
+  IN partition_suffix TEXT
+)
+RETURNS void
+LANGUAGE plpgsql
+AS $$
+DECLARE
+  table_name TEXT DEFAULT 'kyc_attributes';
+BEGIN
+  table_name = concat_ws('_', table_name, partition_suffix);
+  EXECUTE FORMAT (
+    'ALTER TABLE ' || table_name ||
+      ' ADD CONSTRAINT ' || table_name || '_serial_key '
+        'UNIQUE (kyc_attributes_serial_id)'
+  );
+  -- To search accounts
+  EXECUTE FORMAT (
+    'CREATE INDEX ' || table_name || '_h_payto_index '
+    'ON ' || table_name || ' '
+    '(h_payto);'
+  );
+  -- For garbage collection
+  EXECUTE FORMAT (
+    'CREATE INDEX ' || table_name || '_expiration_time '
+    'ON ' || table_name || ' '
+    '(expiration_time ASC);'
+  );
+END $$;
+
+
+CREATE OR REPLACE FUNCTION foreign_table_kyc_attributes()
+RETURNS void
+LANGUAGE plpgsql
+AS $$
+DECLARE
+  table_name TEXT DEFAULT 'kyc_attributes';
+BEGIN
+  EXECUTE FORMAT (
+    'ALTER TABLE ' || table_name ||
+    ' ADD CONSTRAINT ' || table_name || '_foreign_legitimization_processes'
+    ' FOREIGN KEY (legitimization_serial) '
+    ' REFERENCES legitimization_processes (legitimization_process_serial_id)' -- ON DELETE SET NULL?
+  );
+END $$;
+
+
+INSERT INTO exchange_tables
+    (name
+    ,version
+    ,action
+    ,partitioned
+    ,by_range)
+  VALUES
+    ('kyc_attributes'
+    ,'exchange-0002'
+    ,'create'
+    ,TRUE
+    ,FALSE),
+    ('kyc_attributes'
+    ,'exchange-0002'
+    ,'constrain'
+    ,TRUE
+    ,FALSE),
+    ('kyc_attributes'
+    ,'exchange-0002'
+    ,'foreign'
+    ,TRUE
+    ,FALSE);