PostgreSQL チートシート: 開発者のクイックリファレンス

PostgreSQLのクイックリファレンス

目次

日常的な作業のためのクイックリファレンス
PostgreSQL
接続、SQL構文、psqlメタコマンド、パフォーマンス、JSON、ウィンドウ関数など。

最も重要なコマンドと操作をカバーしたコンパクトな SQL チェックシート も利用可能です。

postgresql ロゴ

接続と基本

# 接続
psql -h HOST -p 5432 -U USER -d DB
psql $DATABASE_URL

# psql 内部
\conninfo             -- 接続情報を表示
\l[+]                 -- データベース一覧
\c DB                 -- DBに接続
\dt[+] [schema.]pat   -- テーブル一覧
\dv[+]                -- ビュー一覧
\ds[+]                -- シーケンス一覧
\df[+] [pat]          -- 関数一覧
\d[S+] name           -- テーブル/ビュー/シーケンスの説明
\dn[+]                -- スキーマ一覧
\du[+]                -- ロール一覧
\timing               -- クエリ実行時間を表示する設定切り替え
\x                    -- 拡張表示
\e                    -- $EDITORでバッファを編集
\i file.sql           -- ファイルを実行
\copy ...             -- クライアント側COPY
\! shell_cmd          -- シェルコマンドを実行

データ型(一般的な)

  • 数値型: smallint, integer, bigint, decimal(p,s), numeric, real, double precision, serial, bigserial
  • 文字列型: text, varchar(n), char(n)
  • ブール型: boolean
  • 時間型: timestamp [with/without time zone], date, time, interval
  • UUID: uuid
  • JSON: json, jsonb(推奨)
  • 配列: type[] 例: text[]
  • ネットワーク: inet, cidr, macaddr
  • 幾何学: point, line, polygon など

PostgreSQLバージョンの確認

SELECT version();

PostgreSQLサーバーのバージョン:

pg_config --version

PostgreSQLクライアントのバージョン:

psql --version

DDL(作成 / 変更)

-- スキーマとテーブルの作成
CREATE SCHEMA IF NOT EXISTS app;
CREATE TABLE app.users (
  id           bigserial PRIMARY KEY,
  email        text NOT NULL UNIQUE,
  name         text,
  active       boolean NOT NULL DEFAULT true,
  created_at   timestamptz NOT NULL DEFAULT now(),
  profile      jsonb,
  tags         text[]
);

-- 変更
ALTER TABLE app.users ADD COLUMN last_login timestamptz;
ALTER TABLE app.users ALTER COLUMN name SET NOT NULL;
ALTER TABLE app.users DROP COLUMN tags;

-- 制約
ALTER TABLE app.users ADD CONSTRAINT email_lower_uk UNIQUE (lower(email));

-- インデックス
CREATE INDEX ON app.users (email);
CREATE UNIQUE INDEX CONCURRENTLY users_email_uidx ON app.users (lower(email));
CREATE INDEX users_profile_gin ON app.users USING gin (profile);
CREATE INDEX users_created_at_idx ON app.users (created_at DESC);

DML(挿入 / 更新 / マージ / 削除)

INSERT INTO app.users (email, name) VALUES
  ('a@x.com','A'), ('b@x.com','B')
RETURNING id;

-- マージ(ON CONFLICT)
INSERT INTO app.users (email, name)
VALUES ('a@x.com','Alice')
ON CONFLICT (email)
DO UPDATE SET name = EXCLUDED.name, updated_at = now();

UPDATE app.users SET active = false WHERE last_login < now() - interval '1 year';
DELETE FROM app.users WHERE active = false AND last_login IS NULL;

クエリの基本

SELECT * FROM app.users ORDER BY created_at DESC LIMIT 20 OFFSET 40; -- ページネーション

-- フィルタリング
SELECT * FROM app.users WHERE email ILIKE '%@example.%' AND active;

-- 集計 & GROUP BY
SELECT active, count(*) AS n
FROM app.users
GROUP BY active
HAVING count(*) > 10;

-- JOIN
SELECT o.id, u.email, o.total
FROM app.orders o
JOIN app.users u ON u.id = o.user_id
LEFT JOIN app.discounts d ON d.id = o.discount_id;

-- DISTINCT ON(PostgreSQL特有)
SELECT DISTINCT ON (user_id) user_id, status, created_at
FROM app.events
ORDER BY user_id, created_at DESC;

-- CTE
WITH recent AS (
  SELECT * FROM app.orders WHERE created_at > now() - interval '30 days'
)
SELECT count(*) FROM recent;

-- 再帰的CTE
WITH RECURSIVE t(n) AS (
  SELECT 1
  UNION ALL
  SELECT n+1 FROM t WHERE n < 10
)
SELECT sum(n) FROM t;

ウィンドウ関数

SELECT
  user_id,
  created_at,
  sum(total)      OVER (PARTITION BY user_id ORDER BY created_at) AS running_total,
  row_number()    OVER (PARTITION BY user_id ORDER BY created_at) AS rn,
  lag(total, 1)   OVER (PARTITION BY user_id ORDER BY created_at) AS prev_total
FROM app.orders;

JSON / JSONB

-- 抽出
SELECT profile->>'company' AS company FROM app.users;
SELECT profile->'address'->>'city' FROM app.users;

-- JSONBクエリ用インデックス
CREATE INDEX users_profile_company_gin ON app.users USING gin ((profile->>'company'));

-- 存在 / 含まれる
SELECT * FROM app.users WHERE profile ? 'company';              -- キーが存在
SELECT * FROM app.users WHERE profile @> '{"role":"admin"}'; -- 含まれる

-- JSONBの更新
UPDATE app.users
SET profile = jsonb_set(COALESCE(profile,'{}'::jsonb), '{prefs,theme}', '"dark"', true);

配列

-- 要素の存在と包含
SELECT * FROM app.users WHERE 'vip' = ANY(tags);
SELECT * FROM app.users WHERE tags @> ARRAY['beta'];

-- 追加
UPDATE app.users SET tags = array_distinct(tags || ARRAY['vip']);

時間と日付

SELECT now() AT TIME ZONE 'Australia/Melbourne';
SELECT date_trunc('day', created_at) AS d, count(*)
FROM app.users GROUP BY d ORDER BY d;

-- インターバル
SELECT now() - interval '7 days';

トランザクションとロック

BEGIN;
UPDATE app.accounts SET balance = balance - 100 WHERE id = 1;
UPDATE app.accounts SET balance = balance + 100 WHERE id = 2;
COMMIT; -- または ROLLBACK

-- トランザクションレベル
SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;

-- ロックの確認
SELECT * FROM pg_locks l JOIN pg_stat_activity a USING (pid);

ロールと権限

-- ロール/ユーザーの作成
CREATE ROLE app_user LOGIN PASSWORD 'secret';
GRANT USAGE ON SCHEMA app TO app_user;
GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA app TO app_user;
ALTER DEFAULT PRIVILEGES IN SCHEMA app GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO app_user;

インポート / エクスポート

-- サーバーサイド(スーパーユーザーまたは適切な権限が必要)
COPY app.users TO '/tmp/users.csv' CSV HEADER;
COPY app.users(email,name) FROM '/tmp/users.csv' CSV HEADER;

-- クライアントサイド(psql)
\copy app.users TO 'users.csv' CSV HEADER
\copy app.users(email,name) FROM 'users.csv' CSV HEADER

パフォーマンスと観測

EXPLAIN (ANALYZE, BUFFERS, VERBOSE) SELECT ...;  -- 実際の実行時間

-- ステータスビュー
SELECT * FROM pg_stat_user_tables;
SELECT * FROM pg_stat_statements ORDER BY total_time DESC LIMIT 20; -- 拡張機能が必要

-- メンテナンス
VACUUM [FULL] [VERBOSE] table_name;
ANALYZE table_name;
REINDEX TABLE table_name;

必要な拡張機能を有効にします:

CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
CREATE EXTENSION IF NOT EXISTS btree_gin;
CREATE EXTENSION IF NOT EXISTS pg_trgm; -- トライグラム検索

フルテキスト検索(簡易)

ALTER TABLE app.docs ADD COLUMN tsv tsvector;
UPDATE app.docs SET tsv = to_tsvector('english', coalesce(title,'') || ' ' || coalesce(body,''));
CREATE INDEX docs_tsv_idx ON app.docs USING gin(tsv);
SELECT id FROM app.docs WHERE tsv @@ plainto_tsquery('english', 'quick brown fox');

有用な psql 設定

\pset pager off       -- ページャーを無効
\pset null '∅'
\pset format aligned  -- 他の形式: unaligned, csv
\set ON_ERROR_STOP on
\timing on

便利なカタログクエリ

-- テーブルサイズ
SELECT relname, pg_size_pretty(pg_total_relation_size(relid)) AS size
FROM pg_catalog.pg_statio_user_tables ORDER BY pg_total_relation_size(relid) DESC;

-- インデックスの膨張(概算)
SELECT schemaname, relname, indexrelname, idx_scan
FROM pg_stat_user_indexes ORDER BY idx_scan ASC NULLS FIRST LIMIT 20;

バックアップ / リストア

# ロジカルダンプ
pg_dump -h HOST -U USER -d DB -F c -f db.dump        # カスタム形式
pg_restore -h HOST -U USER -d NEW_DB -j 4 db.dump

# 通常のSQL
pg_dump -h HOST -U USER -d DB > dump.sql
psql -h HOST -U USER -d DB -f dump.sql

レプリケーション(概要)

  • WALファイルは プライマリスタンバイ にストリーム
  • 主要な設定: wal_level, max_wal_senders, hot_standby, primary_conninfo
  • ツール: pg_basebackup, standby.signal (PG ≥12)

注意点とヒント

  • インデックスと演算子で jsonb を常に使用してください。json は使用しないでください。
  • timestamptz(タイムゾーン対応)を優先してください。
  • DISTINCT ON は “グループごとの上位N件” に最適なPostgreSQLの機能です。
  • GENERATED ALWAYS AS IDENTITYserial の代わりに使用してください。
  • 本番環境では SELECT * を避けてください。
  • 選択的なフィルターやJOINキーにインデックスを作成してください。
  • 最適化を行う前に EXPLAIN (ANALYZE) で測定してください。

バージョン固有の機能(v12以上)

-- 生成されたID
CREATE TABLE t (id bigINT GENERATED ALWAYS AS IDENTITY, ...);

-- 部分インデックスでのUPSERT
CREATE UNIQUE INDEX ON t (key) WHERE is_active;

有用なリンク