Description
The installer is the pgxls.sql file that creates pgxls schema with the necessary procedures. Installation only requires the
create schema privilege (held by the DB owner);
the tool is written in the native PL/pgSQL language with zero external dependencies and is guaranteed to support PostgreSQL 12+.To install it, execute this file using the
psql command-line tool or any SQL manager, for example:psql -d mydb -f pgxls.sql
Also possible download zip archive with documentation, examples, extension, install and uninstall scripts.
To uninstall the tool, need to drop the pgxls schema, for example:
psql -d mydb -c "drop schema if exists pgxls cascade"
For batch use, installation is carried out in command line using psql, download and execute pgxls.sql file
curl https://pgxls.org/files/download/pgxls.sql | psql [database]
Installation example in test database
postgres@debian:~$ curl https://pgxls.org/files/download/pgxls.sql | psql mydb
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 70359 100 70359 0 0 661k 0 --:--:-- --:--:-- --:--:-- 667k
CREATE SCHEMA
CREATE FUNCTION
DO
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE PROCEDURE
CREATE FUNCTION
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
DO
CREATE PROCEDURE
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE FUNCTION
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE FUNCTION
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE FUNCTION
CREATE FUNCTION
CREATE PROCEDURE
CREATE FUNCTION
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE PROCEDURE
CREATE FUNCTION
CREATE PROCEDURE
CREATE PROCEDURE
GRANT
GRANT
GRANT
In addition to the recommended installation via simple schema creation, the tool can also be installed as a native extension. To do this, unpack the pgxls_extension.tar archive into the [sharedir]/extension directory of the postgresql installation and create extension, for example (run as root):
pg_config --sharedir
tar xf pgxls_extension.tar -C /usr/pgsql-14/share/extension
psql -U postgres -d mydb -c "create extension pgxls"
Installation example in mydb database
root@debian:~# curl https://pgxls.org/files/download/pgxls_extension.tar | tar x -C $(pg_config --sharedir)/extension
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 81920 100 81920 0 0 1096k 0 --:--:-- --:--:-- --:--:-- 1111k
root@debian:~# psql -U postgres -d mydb -c "create extension pgxls"
CREATE EXTENSION
By default, privileges to use pgxls schema and its procedures are granted to role public (all users).
If need to grant privileges only to developers, you can use an SQL script pgxls_dev_grants.sql with a roles variable, for example:
psql -d mydb -f pgxls_dev_grants.sql -v roles=developers
Example of grant privileges to the r_analysts role in the mydb database
postgres@debian:~$ curl https://pgxls.org/files/download/pgxls_dev_grants.sql | psql mydb -v roles=r_analysts
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 322 100 322 0 0 5030 0 --:--:-- --:--:-- --:--:-- 5111
REVOKE
REVOKE
REVOKE
GRANT
GRANT
GRANT
The source code is upload in GitHub repository
PGXLS is released under the MIT License (an open and free software license).
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.