diff --git a/source/_posts/postgres.md b/source/_posts/postgres.md index a2ed36f..0ebffca 100644 --- a/source/_posts/postgres.md +++ b/source/_posts/postgres.md @@ -2,48 +2,50 @@ title: PostgreSQL background: bg-[#3d6488] tags: - - DB - - RDBMS + - DB + - RDBMS categories: - Database date: 2021-01-11 14:19:24 intro: | - The [PostgreSQL](https://www.postgresql.org/docs/current/) cheat sheet provides you with the common PostgreSQL commands and statements. + The [PostgreSQL](https://www.postgresql.org/docs/current/) cheat sheet provides you with the common PostgreSQL commands and statements. plugins: - - copyCode + - copyCode --- - - -Getting Started ---------------- +## Getting Started ### Getting started + Switch and connect + ```shell script $ sudo -u postgres psql ``` List all databases + ```shell script postgres=# \l ``` Connect to the database named postgres + ```shell script postgres=# \c postgres ``` Disconnect + ```shell script postgres=# \q postgres=# \! ``` - ### psql commands {.col-span-2} + | Option | Example | Description | -|---------------------|----------------------------------------------|--------------------------------| +| ------------------- | -------------------------------------------- | :----------------------------- | | `[-d] ` | psql -d mydb | Connecting to database | | `-U` | psql -U john mydb | Connecting as a specific user | | `-h` `-p` | psql -h localhost -p 5432 mydb | Connecting to a host/port | @@ -54,109 +56,136 @@ postgres=# \! | `-l` | psql -l | List all databases | | `-f` | psql mydb -f file.sql | Execute commands from a file | | `-V` | psql -V | Print the psql version | -{.show-header} +{.show-header} ### Getting help | - | - | -|-------------|--------------------------------| +| ----------- | :----------------------------- | | `\h` | Help on syntax of SQL commands | | `\h` DELETE | DELETE SQL statement syntax | | `\?` | List of PostgreSQL command | Run in PostgreSQL console - - -PostgreSQL Working -------- +## PostgreSQL Working ### Recon + Show version + ``` SHOW SERVER_VERSION; ``` + Show system status -```sql {.wrap} + +```sql {.wrap} \conninfo ``` + Show environmental variables -```sql {.wrap} + +```sql {.wrap} SHOW ALL; ``` + List users -```sql {.wrap} + +```sql {.wrap} SELECT rolname FROM pg_roles; ``` + Show current user -```sql {.wrap} + +```sql {.wrap} SELECT current_user; ``` + Show current user's permissions + ``` \du ``` + Show current database -```sql {.wrap} + +```sql {.wrap} SELECT current_database(); ``` + Show all tables in database -```sql {.wrap} + +```sql {.wrap} \dt ``` + List functions -```sql {.wrap} + +```sql {.wrap} \df ``` - - ### Databases List databases -```sql {.wrap} + +```sql {.wrap} \l ``` + Connect to database -```sql {.wrap} + +```sql {.wrap} \c ``` + Show current database -```sql {.wrap} + +```sql {.wrap} SELECT current_database(); ``` + [Create database](http://www.postgresql.org/docs/current/static/sql-createdatabase.html) + ```sql {.wrap} CREATE DATABASE WITH OWNER ; ``` + [Drop database](http://www.postgresql.org/docs/current/static/sql-dropdatabase.html) + ```sql {.wrap} DROP DATABASE IF EXISTS ; ``` + [Rename database](http://www.postgresql.org/docs/current/static/sql-alterdatabase.html) + ```sql {.wrap} ALTER DATABASE RENAME TO ; ``` - - ### Tables List tables, in current db -```sql {.wrap} + +```sql {.wrap} \dt SELECT table_schema,table_name FROM information_schema.tables ORDER BY table_schema,table_name; ``` + List tables, globally -```sql {.wrap} + +```sql {.wrap} \dt *.*. SELECT * FROM pg_catalog.pg_tables ``` + List table schema -```sql {.wrap} + +```sql {.wrap} \d \d+ @@ -164,90 +193,114 @@ SELECT column_name, data_type, character_maximum_length FROM INFORMATION_SCHEMA.COLUMNS WHERE table_name = ''; ``` + [Create table](http://www.postgresql.org/docs/current/static/sql-createtable.html) -```sql {.wrap} + +```sql {.wrap} CREATE TABLE ( , ); ``` + Create table, with an auto-incrementing primary key -```sql {.wrap} + +```sql {.wrap} CREATE TABLE ( SERIAL PRIMARY KEY ); ``` + [Delete table](http://www.postgresql.org/docs/current/static/sql-droptable.html) -```sql {.wrap} + +```sql {.wrap} DROP TABLE IF EXISTS CASCADE; ``` - - ### Permissions + Become the postgres user, if you have permission errors + ```shell sudo su - postgres psql ``` + [Grant](http://www.postgresql.org/docs/current/static/sql-grant.html) all permissions on database -```sql {.wrap} + +```sql {.wrap} GRANT ALL PRIVILEGES ON DATABASE TO ; ``` + Grant connection permissions on database -```sql {.wrap} + +```sql {.wrap} GRANT CONNECT ON DATABASE TO ; ``` + Grant permissions on schema -```sql {.wrap} + +```sql {.wrap} GRANT USAGE ON SCHEMA public TO ; ``` + Grant permissions to functions -```sql {.wrap} + +```sql {.wrap} GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA public TO ; ``` + Grant permissions to select, update, insert, delete, on a all tables -```sql {.wrap} + +```sql {.wrap} GRANT SELECT, UPDATE, INSERT ON ALL TABLES IN SCHEMA public TO ; ``` + Grant permissions, on a table -```sql {.wrap} + +```sql {.wrap} GRANT SELECT, UPDATE, INSERT ON TO ; ``` + Grant permissions, to select, on a table -```sql {.wrap} + +```sql {.wrap} GRANT SELECT ON ALL TABLES IN SCHEMA public TO ; ``` - - - - - ### Columns [Add column](http://www.postgresql.org/docs/current/static/sql-altertable.html) -```sql {.wrap} + +```sql {.wrap} ALTER TABLE IF EXISTS ADD []; ``` + Update column -```sql {.wrap} + +```sql {.wrap} ALTER TABLE IF EXISTS ALTER TYPE []; ``` + Delete column -```sql {.wrap} + +```sql {.wrap} ALTER TABLE IF EXISTS DROP ; ``` + Update column to be an auto-incrementing primary key -```sql {.wrap} + +```sql {.wrap} ALTER TABLE ADD COLUMN SERIAL PRIMARY KEY; ``` + Insert into a table, with an auto-incrementing primary key -```sql {.wrap} + +```sql {.wrap} INSERT INTO VALUES (DEFAULT, ); @@ -256,111 +309,139 @@ INSERT INTO (,) VALUES ( , ); ``` - - ### Data + [Select](http://www.postgresql.org/docs/current/static/sql-select.html) all data -```sql {.wrap} + +```sql {.wrap} SELECT * FROM ; ``` + Read one row of data -```sql {.wrap} + +```sql {.wrap} SELECT * FROM LIMIT 1; ``` + Search for data -```sql {.wrap} + +```sql {.wrap} SELECT * FROM WHERE = ; ``` + [Insert](http://www.postgresql.org/docs/current/static/sql-insert.html) data -```sql {.wrap} + +```sql {.wrap} INSERT INTO VALUES( , ); ``` + [Update](http://www.postgresql.org/docs/current/static/sql-update.html) data -```sql {.wrap} + +```sql {.wrap} UPDATE SET = , = WHERE = ; ``` + [Delete](http://www.postgresql.org/docs/current/static/sql-delete.html) all data -```sql {.wrap} + +```sql {.wrap} DELETE FROM ; ``` + Delete specific data -```sql {.wrap} + +```sql {.wrap} DELETE FROM WHERE = ; ``` - - - - ### Users List roles -```sql {.wrap} + +```sql {.wrap} SELECT rolname FROM pg_roles; ``` + [Create user](http://www.postgresql.org/docs/current/static/sql-createuser.html) + ```sql {.wrap} CREATE USER WITH PASSWORD ''; ``` + [Drop user](http://www.postgresql.org/docs/current/static/sql-dropuser.html) -```sql {.wrap} + +```sql {.wrap} DROP USER IF EXISTS ; ``` + [Alter](http://www.postgresql.org/docs/current/static/sql-alterrole.html) user password + ```sql {.wrap} ALTER ROLE WITH PASSWORD ''; ``` - ### Schema + List schemas -```sql {.wrap} + +```sql {.wrap} \dn SELECT schema_name FROM information_schema.schemata; SELECT nspname FROM pg_catalog.pg_namespace; ``` + [Create schema](http://www.postgresql.org/docs/current/static/sql-createschema.html) -```sql {.wrap} + +```sql {.wrap} CREATE SCHEMA IF NOT EXISTS ; ``` + [Drop schema](http://www.postgresql.org/docs/current/static/sql-dropschema.html) -```sql {.wrap} + +```sql {.wrap} DROP SCHEMA IF EXISTS CASCADE; ``` - ### Dates Show [current date](https://www.postgresql.org/docs/15/functions-datetime.html#FUNCTIONS-DATETIME-CURRENT) YYYY-MM-DD -```sql {.wrap} + +```sql {.wrap} SELECT current_date; ``` -Calculate [age](https://www.postgresql.org/docs/15/functions-datetime.html#:~:text=age%20(%20timestamp%2C%20timestamp%20)%20%E2%86%92%20interval) between two dates + +Calculate +[age]() +between two dates + ```sql {.wrap} SELECT age(timestamp, timestamp); ``` -Show [current time](https://www.postgresql.org/docs/15/functions-datetime.html#FUNCTIONS-DATETIME-CURRENT) with time zone -```sql {.wrap} + +Show [current time](https://www.postgresql.org/docs/15/functions-datetime.html#FUNCTIONS-DATETIME-CURRENT) with time +zone + +```sql {.wrap} SELECT current_time; ``` -[Make](https://www.postgresql.org/docs/15/functions-datetime.html#:~:text=make_date%20(%20year%20int%2C%20month%20int%2C%20day%20int%20)%20%E2%86%92%20date) dates using integers + +[Make]() +dates using integers + ```sql {.wrap} SELECT make_date(2021,03,25); ``` - - -PostgreSQL Commands ------------ +## PostgreSQL Commands ### Tables + | - | - | -|------------------|---------------------------------| +| ---------------- | :------------------------------ | | `\d ` | Describe table | | `\d+
` | Describe table with details | | `\dt` | List tables from current schema | @@ -369,11 +450,10 @@ PostgreSQL Commands | `\dp` | List table access privileges | | `\det[+]` | List foreign tables | - - ### Query buffer + | - | - | -|--------------|------------------------------------| +| ------------ | :--------------------------------- | | `\e [FILE]` | Edit the query buffer (or file) | | `\ef [FUNC]` | Edit function definition | | `\p` | Show the contents | @@ -381,11 +461,10 @@ PostgreSQL Commands | `\s [FILE]` | Display history or save it to file | | `\w FILE` | Write query buffer to file | - - ### Informational {.row-span-4} + | - | - | -|-----------------|---------------------------------| +| --------------- | :------------------------------ | | `\l[+]` | List all databases | | `\dn[S+]` | List schemas | | `\di[S+]` | List indexes | @@ -417,147 +496,162 @@ PostgreSQL Commands `S`: show system objects, `+`: additional detail - ### Connection + | - | - | -|------------------------|-----------------------------| +| ---------------------- | :-------------------------- | | `\c [DBNAME]` | Connect to new database | | `\encoding [ENCODING]` | Show or set client encoding | | `\password [USER]` | Change the password | | `\conninfo` | Display information | - ### Formatting -| - | - | -|---------------|--------------------------------------------| -| `\a` | Toggle between unaligned and aligned | -| `\C [STRING]` | Set table title, or unset if none | -| `\f [STRING]` | Show or set field separator for unaligned | -| `\H` | Toggle HTML output mode | -| `\t [on|off]` | Show only rows | -| `\T [STRING]` | Set or unset HTML \ tag attributes | -| `\x [on|off]` | Toggle expanded output | - +| - | - | +| ------------------------- | :----------------------------------------- | +| `\a` | Toggle between unaligned and aligned | +| `\C [STRING]` | Set table title, or unset if none | +| `\f [STRING]` | Show or set field separator for unaligned | +| `\H` | Toggle HTML output mode | +| \t [on\|off] | Show only rows | +| `\T [STRING]` | Set or unset HTML \ tag attributes | +| \x [on\|off] | Toggle expanded output | ### Input/Output + | - | - | -|-------------------|----------------------------------------------------------------| +| ----------------- | :------------------------------------------------------------- | | `\copy ...` | Import/export table
_See also:_ [copy](#import-export-csv) | | `\echo [STRING]` | Print string | | `\i FILE` | Execute file | | `\o [FILE]` | Export all results to file | | `\qecho [STRING]` | String to output stream | - ### Variables + | - | - | -|-----------------------|-----------------------------------------------| +| --------------------- | :-------------------------------------------- | | `\prompt [TEXT] NAME` | Set variable | | `\set [NAME [VALUE]]` | Set variable _(or list all if no parameters)_ | | `\unset NAME` | Delete variable | - ### Misc -| - | - | -|--------------------|----------------------| -| `\cd [DIR]` | Change the directory | -| `\timing [on|off]` | Toggle timing | -| `\! [COMMAND]` | Execute in shell | -| `\! ls -l` | List all in shell | +| - | - | +| ------------------------------ | :------------------- | +| `\cd [DIR]` | Change the directory | +| \timing [on\|off] | Toggle timing | +| `\! [COMMAND]` | Execute in shell | +| `\! ls -l` | List all in shell | ### Large Objects + - `\lo_export LOBOID FILE` - `\lo_import FILE [COMMENT]` - `\lo_list` - `\lo_unlink LOBOID` +{.marker-none} - - - -Miscellaneous -------------- - +## Miscellaneous ### Backup + Use pg_dumpall to backup all databases + ```shell script $ pg_dumpall -U postgres > all.sql ``` + Use pg_dump to backup a database + ```shell script $ pg_dump -d mydb -f mydb_backup.sql ``` --   `-a`   Dump only the data, not the schema --   `-s`   Dump only the schema, no data --   `-c`   Drop database before recreating --   `-C`   Create database before restoring --   `-t`   Dump the named table(s) only --   `-F`   Format (`c`: custom, `d`: directory, `t`: tar) -{.marker-none} +| - | - | +| ---- | :--------------------------------------------- | +| `-a` | Dump only the data, not the schema | +| `-s` | Dump only the schema, no data | +| `-c` | Drop database before recreating | +| `-C` | Create database before restoring | +| `-t` | Dump the named table(s) only | +| `-F` | Format (`c`: custom, `d`: directory, `t`: tar) | Use `pg_dump -?` to get the full list of options - - ### Restore + Restore a database with psql + ```shell script $ psql -U user mydb < mydb_backup.sql ``` + Restore a database with pg_restore + ```shell script $ pg_restore -d mydb mydb_backup.sql -c ``` --   `-U`   Specify a database user --   `-c`   Drop database before recreating --   `-C`   Create database before restoring --   `-e`   Exit if an error has encountered --   `-F`   Format (`c`: custom, `d`: directory, `t`: tar, `p`: plain text sql(default)) +| - | - | +| ---- | :--------------------------------------------------------------------------- | +| `-U` | Specify a database user | +| `-c` | Drop database before recreating | +| `-C` | Create database before restoring | +| `-e` | Exit if an error has encountered | +| `-F` | Format (`c`: custom, `d`: directory, `t`: tar, `p`: plain text sql(default)) | + {.marker-none} Use `pg_restore -?` to get the full list of options - - ### Remote access + Get location of postgresql.conf + ```shell script $ psql -U postgres -c 'SHOW config_file' ``` + Append to postgresql.conf + ```shell script listen_addresses = '*' ``` + Append to pg_hba.conf (Same location as postgresql.conf) + ```shell script host all all 0.0.0.0/0 md5 host all all ::/0 md5 ``` + Restart PostgreSQL server + ```shell script $ sudo systemctl restart postgresql ``` - ### Import/Export CSV + Export table into CSV file + ```shell script \copy table TO '' CSV \copy table(col1,col1) TO '' CSV \copy (SELECT...) TO '' CSV ``` + Import CSV file into table + ```shell script \copy table FROM '' CSV \copy table(col1,col1) FROM '' CSV ``` + See also: [Copy](https://www.postgresql.org/docs/current/sql-copy.html) -Also see --------- +## Also see + - [Posgres-cheatsheet](https://gist.github.com/apolloclark/ea5466d5929e63043dcf#posgres-cheatsheet) _(gist.github.com)_