diff options
Diffstat (limited to 'src/exchangedb/0002-reserves.sql')
-rw-r--r-- | src/exchangedb/0002-reserves.sql | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/src/exchangedb/0002-reserves.sql b/src/exchangedb/0002-reserves.sql new file mode 100644 index 000000000..d710dd01b --- /dev/null +++ b/src/exchangedb/0002-reserves.sql @@ -0,0 +1,152 @@ +-- +-- 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 FUNCTION create_table_reserves( + IN partition_suffix TEXT DEFAULT NULL +) +RETURNS VOID +LANGUAGE plpgsql +AS $$ +DECLARE + table_name TEXT DEFAULT 'reserves'; +BEGIN + PERFORM create_partitioned_table( + 'CREATE TABLE %I' + '(reserve_uuid BIGINT GENERATED BY DEFAULT AS IDENTITY' + ',reserve_pub BYTEA PRIMARY KEY CHECK(LENGTH(reserve_pub)=32)' + ',current_balance taler_amount NOT NULL DEFAULT (0, 0)' + ',purses_active INT8 NOT NULL DEFAULT(0)' + ',purses_allowed INT8 NOT NULL DEFAULT(0)' + ',birthday INT4 NOT NULL DEFAULT(0)' + ',expiration_date INT8 NOT NULL' + ',gc_date INT8 NOT NULL' + ') %s ;' + ,table_name + ,'PARTITION BY HASH (reserve_pub)' + ,partition_suffix + ); + PERFORM comment_partitioned_table( + 'Summarizes the balance of a reserve. Updated when new funds are added or withdrawn.' + ,table_name + ,partition_suffix + ); + PERFORM comment_partitioned_column( + 'EdDSA public key of the reserve. Knowledge of the private key implies ownership over the balance.' + ,'reserve_pub' + ,table_name + ,partition_suffix + ); + PERFORM comment_partitioned_column( + 'Current balance remaining with the reserve.' + ,'current_balance' + ,table_name + ,partition_suffix + ); + PERFORM comment_partitioned_column( + 'Number of purses that were created by this reserve that are not expired and not fully paid.' + ,'purses_active' + ,table_name + ,partition_suffix + ); + PERFORM comment_partitioned_column( + 'Number of purses that this reserve is allowed to have active at most.' + ,'purses_allowed' + ,table_name + ,partition_suffix + ); + PERFORM comment_partitioned_column( + 'Used to trigger closing of reserves that have not been drained after some time' + ,'expiration_date' + ,table_name + ,partition_suffix + ); + PERFORM comment_partitioned_column( + 'Used to forget all information about a reserve during garbage collection' + ,'gc_date' + ,table_name + ,partition_suffix + ); + PERFORM comment_partitioned_column( + 'Birthday of the user in days after 1970, or 0 if user is an adult and is not subject to age restrictions' + ,'birthday' + ,table_name + ,partition_suffix + ); +END +$$; + + +CREATE FUNCTION constrain_table_reserves( + IN partition_suffix TEXT +) +RETURNS void +LANGUAGE plpgsql +AS $$ +DECLARE + table_name TEXT DEFAULT 'reserves'; +BEGIN + table_name = concat_ws('_', table_name, partition_suffix); + EXECUTE FORMAT ( + 'ALTER TABLE ' || table_name || + ' ADD CONSTRAINT ' || table_name || '_unique_uuid' + ' UNIQUE (reserve_uuid)' + ); + EXECUTE FORMAT ( + 'CREATE INDEX ' || table_name || '_by_expiration_index ' + 'ON ' || table_name || ' ' + '(expiration_date' + ',current_balance' + ');' + ); + EXECUTE FORMAT ( + 'COMMENT ON INDEX ' || table_name || '_by_expiration_index ' + 'IS ' || quote_literal('used in get_expired_reserves') || ';' + ); + EXECUTE FORMAT ( + 'CREATE INDEX ' || table_name || '_by_reserve_uuid_index ' + 'ON ' || table_name || ' ' + '(reserve_uuid);' + ); + EXECUTE FORMAT ( + 'CREATE INDEX ' || table_name || '_by_gc_date_index ' + 'ON ' || table_name || ' ' + '(gc_date);' + ); + EXECUTE FORMAT ( + 'COMMENT ON INDEX ' || table_name || '_by_gc_date_index ' + 'IS ' || quote_literal('for reserve garbage collection') || ';' + ); +END +$$; + + +INSERT INTO exchange_tables + (name + ,version + ,action + ,partitioned + ,by_range) + VALUES + ('reserves' + ,'exchange-0002' + ,'create' + ,TRUE + ,FALSE), + ('reserves' + ,'exchange-0002' + ,'constrain' + ,TRUE + ,FALSE); |