pg_query_rewrite
is a PostgreSQL extension which allows to translate a given source SQL statement into another pre-defined SQL statement.
This module can be built using the standard PGXS infrastructure. For this to work, the pg_config program must be available in your $PATH:
git clone https://github.com/pierreforstmann/pg_query_rewrite.git
cd pg_query_rewrite
make
make install
Extension must be loaded at server level with shared_preload_libraries
parameter:
shared_preload_libraries = 'pg_query_rewrite'
Following SQL statement must be run in each database:
create extension pg_query_rewrite;
pg_query_rewrite
has been successfully tested with PostgreSQL 9.5, 9.6, 10, 11, 12, 13, 14, 15, 16 and 17.
pg_query_rewrite
has a single GUC : pg_query_rewrite.max_rules
which is the maximum number of SQL statements that can be translated.
This extension is enabled if the related library is loaded. If pg_query_rewrite.max_rules
parameter is not set, it set to 10 by default.
To create a new rule to translate SQL statement <source>
into SQL statement <target>
run:
select pgqr_add_rule(<source>, <target>);
To remove a translation rule for SQL statement <source>
, run:
select pgqr_remove_rule(<source>);
To remove all existing translation rules, run:
select pgqr_truncate();
To display current translation rules, run:
select pgqr_rules();
In postgresql.conf:
shared_preload_libraries = 'pg_query_rewrite'
pg_query_rewrite.max_rules=10
Run with psql:
# create extension pg_query_rewrite;
CREATE EXTENSION
# select pgqr_add_rule('select 10;','select 11;');
pgqr_add_rule
---------------
t
(1 row)
# select 10;
?column?
----------
11
(1 row)
# select pgqr_rules();
pgqr_rules
--------------------------------------------------------------------------
(datname=pierre,"source=select 10;","target=select 11;",rewrite_count=1)
(datname=NULL,source=NULL,target=NULL,rewrite_count=0)
(datname=NULL,source=NULL,target=NULL,rewrite_count=0)
(datname=NULL,source=NULL,target=NULL,rewrite_count=0)
(datname=NULL,source=NULL,target=NULL,rewrite_count=0)
(datname=NULL,source=NULL,target=NULL,rewrite_count=0)
(datname=NULL,source=NULL,target=NULL,rewrite_count=0)
(datname=NULL,source=NULL,target=NULL,rewrite_count=0)
(datname=NULL,source=NULL,target=NULL,rewrite_count=0)
(datname=NULL,source=NULL,target=NULL,rewrite_count=0)
(10 rows)
- SQL statements using parameters are not supported.
- Maximum SQL statement length is hard-coded: currently the maximum statement length is 32K.
- SQL translation occurs only if the SQL statement matches exactly the source statement rule for each character (it is case sensitive, space sensitive, semicolon sensitive, etc.)
- SQL translation rules are only stored in shared memory. The extension does not provide any feature to have persistent settings. However
pg_start_sql
can be used to store some SQL statements that are run at each PostgreSQL instance start.