PostgreSQL DDL Operations

Internal

• PostgreSQL Operations
• PostgreSQL DML Operations

psql Command Line

Specify the Database to Interact with

psql -d|--dbname= <database-name> ...

Providing a Password to psql in Command Line

If a database is protected by a password, psql will challenge for password interactively. That can be avoided in scripts as follows:

export PGPASSWORD=password; psql -l -h some.host -U some-user ...

In-Line SQL Commands

psql ... -c "''sql-command''"

Example:

psql -h something.ak29cdi3ewgm.ca-central-1.rds.amazonaws.com -U infinity -d test_10 -c "GRANT ALL PRIVILEGES ON DATABASE test_10 TO infinity;"

File-Stored SQL Commands

psql -f|--file= <file-name> ...

Version

Server version:

pg_config --version

Client version:

psql --version

Also, execute:

SELECT version():

Cluster

initdb

https://www.postgresql.org/docs/14/app-initdb.html

initdb will create a new database cluster.

initdb --locale=C -E UTF-8 /opt/brew/var/postgresql@14

Database

See

PostgreSQL Database

List Databases

psql -l [-h ... -U ... -d ...]

or

> \l

or

SELECT datname FROM pg_database;

Create a Database

Via a command:

createdb <dbname>

createdb playground

Via SQL over an established psql session:

CREATE DATABASE <dbname>;

Also see:

Database Name Case Sensitivity

Connect to a Database

Connecting to a Database

Drop a Database

Via a command:

dropdb <dbname>

Via SQL over an established psql session:

DROP DATABASE <dbname>;

This command will not work if there are users connected to the database:

ERROR:  database "..." is being accessed by other users
DETAIL:  There are 10 other sessions using the database.

The database can though be forcefully dropped as follows (enclose the database name in single quotes):

SELECT pg_terminate_backend(pid) FROM pg_stat_activity WHERE datname = '<db-name>';

This will report a number of backends and it will take a while until all will be terminated. You may need to run it several times to insure that all backends are gone.

If there is a lot of activity on the database, you may optionally disallow new connections:

UPDATE pg_database SET datallowconn = 'false' WHERE datname = '<db-name>'; 
ALTER DATABASE <db-name> CONNECTION LIMIT 1;

When all backends are gone, the database can be dropped.

Users

The following user operations are supported.

List Users

psql
\du

or

SELECT usename FROM pg_user;

It is usename, not username.

Create User

Command line:

createuser <user_name>

or SQL client:

CREATE USER <user_name>;

Change Password

In psql, for the current user:

\password <user_name>

or

ALTER USER user_name WITH PASSWORD 'new_password';

Granting Privileges on a Database

GRANT ALL PRIVILEGES ON DATABASE <dbname> TO  <user>;

Alternative from command line:

psql -h something.ak29cdi3ewgm.ca-central-1.rds.amazonaws.com -U infinity -d test_10 -c "GRANT ALL PRIVILEGES ON DATABASE test_10 TO infinity;"

Delete a User

DROP USER <username>

Tablespace

List Tablespaces

\db

Schema

Schema

List Schemas

\dn

Show Current Schema

SHOW SEARCH_PATH;

Set Default Schema

The default schema, which obviates the need to specify <schema-name>.<table-name> can be set for the current session only, or permanently.

To set the default schema for current session:

SET search_path = schema_name;

To set the default schema permanently, on a per-database or per user-basis:

TO TEST:

ALTER DATABASE db_name SET search_path TO schema_name;
ALTER ROLE role_name SET search_path TO schema_name;

Create a Schema

CREATE SCHEMA someschema;

The schema name capitalization does not matter. When queried, the schema names will be returned in low caps.

Drop a Schema

DROP SCHEMA someschema [CASCADE];

If CASCADE, all included objects will be also dropped.

Tables

List Tables

psql
\dt
\dt someschema.*

SELECT * FROM pg_catalog.pg_tables;

Describe Table Structure

\d [schema-name.]<table_name>

Create a Table

Standard SQL Syntax

CREATE TABLE [someschema.]poc_library_component
(
  "id" int NOT NULL,
  "name" text,
  "desc" text,
  "color" varchar(10),
   CONSTRAINT poc_library_component_pk PRIMARY KEY (id)
)
WITH (
  OIDS=FALSE
);
ALTER TABLE poc_library_component OWNER TO is3_as;

The schema name is case insensitive.

The table name is case insensitive, it can be specified using upper case or lower case, it will be reported in lowercase.

The type names are case insensitive.

The column names are case sensitive.

For documentation on types, see:

PostgreSQL Data Types

Create a Table Only If Does Not Exist

CREATE TABLE IF NOT EXISTS <table_name> ...

Update a Table

https://www.postgresql.org/docs/current/ddl-alter.html

Add/Remove a Column

Standard SQL Syntax

ALTER TABLE person ADD COLUMN birthday DATE;

ALTER TABLE person DROP COLUMN birthday;

Add/Remove a Constraint

NOT NULL

Standard SQL Syntax

not null is handled differently, it cannot written as a table constraint, so to add it:

ALTER TABLE sometable ALTER COLUMN somecolumn SET NOT NULL;

If the table already contains entries with null values for the column, simply setting it to null will not work:

...
ALTER COLUMN somecolumn SET NOT NULL;
 (details: ERROR: column "somecolumn" contains null values (SQLSTATE 23502))

Adding the NOT NULL can still be done, by dropping the column and providing a default value:

ALTER TABLE sometable DROP COLUMN somecolumn;
ALTER TABLE sometable ADD somecolumn text[] DEFAULT '{}'::text[] NOT NULL;

To remove the NOT NULL constraint:

ALTER TABLE sometable ALTER COLUMN somecolumn DROP NOT NULL;

Primary Key

Standard SQL Syntax

Foreign Key

Standard SQL Syntax

Views

Create a View

Standard SQL Syntax