├── examples
    └── accent.png
├── README.md
├── LICENSE
├── pg_dup_idx
├── pg_missing_idx
├── pg_unused_idx
└── pg_graph


/examples/accent.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hauleth/pg-utils/HEAD/examples/accent.png


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Collection of PostgreSQL utilities
 2 | 
 3 | Some scripts that I have written during my work with PostgreSQL.
 4 | 
 5 | ## `pg_graph`
 6 | 
 7 | Create [Graphviz's][gv] DOT file describing whole database.  Can be seen as poor
 8 | man's ERD generator for existing DBs.
 9 | 
10 | ### Usage
11 | 
12 | ```
13 | $ pg_graph <db_name> | dot -Tsvg > out.svg
14 | ```
15 | 
16 | Example output (generated for [Accent][accent] translation tool):
17 | 
18 | ![Output of pg\_graph command generated as image via dot command](examples/accent.png)
19 | 
20 | ## License
21 | 
22 | See [`LICENSE`](LICENSE) file.
23 | 
24 | [gv]: https://www.graphviz.org
25 | [accent]: https://github.com/mirego/accent
26 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright 2018 Łukasz Niemier
 2 | 
 3 | Permission to use, copy, modify, and/or distribute this software for any purpose
 4 | with or without fee is hereby granted, provided that the above copyright notice
 5 | and this permission notice appear in all copies.
 6 | 
 7 | THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 8 | REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
 9 | FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
10 | INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
11 | OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
12 | TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
13 | THIS SOFTWARE.
14 | 


--------------------------------------------------------------------------------
/pg_dup_idx:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # Copyright 2018 Łukasz Niemier
 3 | 
 4 | # Permission to use, copy, modify, and/or distribute this software for any purpose
 5 | # with or without fee is hereby granted, provided that the above copyright notice
 6 | # and this permission notice appear in all copies.
 7 | 
 8 | # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 9 | # REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
10 | # FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
11 | # INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
12 | # OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
13 | # TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
14 | # THIS SOFTWARE.
15 | 
16 | exec psql -1qX "$@" <<EOF
17 | \timing off
18 | 
19 | SELECT relname, idx, column_name
20 | FROM (
21 |     SELECT indrelid, idx, keys
22 |     FROM (
23 |         SELECT x.*, keys, ROW_NUMBER() OVER (PARTITION BY indexrelid) AS idx
24 |         FROM pg_index x
25 |         JOIN UNNEST(x.indkey) keys ON TRUE
26 |     ) q
27 |     GROUP BY indrelid, indclass, keys, idx
28 |     HAVING COUNT(*) > 1
29 | ) q
30 | INNER JOIN pg_class c
31 |     ON c.oid = indrelid
32 | INNER JOIN information_schema.columns co
33 |     ON co.table_name = relname AND co.ordinal_position = keys;
34 | EOF
35 | 


--------------------------------------------------------------------------------
/pg_missing_idx:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # Copyright 2018 Łukasz Niemier
 3 | 
 4 | # Permission to use, copy, modify, and/or distribute this software for any purpose
 5 | # with or without fee is hereby granted, provided that the above copyright notice
 6 | # and this permission notice appear in all copies.
 7 | 
 8 | # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 9 | # REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
10 | # FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
11 | # INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
12 | # OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
13 | # TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
14 | # THIS SOFTWARE.
15 | 
16 | exec psql -1qX "$@" <<EOF
17 | \timing off
18 | 
19 | \echo '=========================== MISSING INDICES ===========================\n'
20 | SELECT
21 |     relname AS "Table name",
22 |     usage_percentage "Indices usage overall scans"
23 | FROM (
24 |     SELECT
25 |     relname,
26 |     round(idx_scan * 100.0 / NULLIF(idx_scan + seq_scan, 0), 2) AS usage_percentage,
27 |     (seq_scan + idx_scan) / avg(seq_scan + idx_scan) OVER () AS overall_percentage
28 |     FROM pg_stat_user_tables tbl
29 | ) tbl
30 | WHERE usage_percentage < 90
31 |     AND overall_percentage > 0.01
32 | ORDER BY usage_percentage DESC;
33 | EOF
34 | 


--------------------------------------------------------------------------------
/pg_unused_idx:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # Copyright 2018 Łukasz Niemier
 3 | 
 4 | # Permission to use, copy, modify, and/or distribute this software for any purpose
 5 | # with or without fee is hereby granted, provided that the above copyright notice
 6 | # and this permission notice appear in all copies.
 7 | 
 8 | # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 9 | # REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
10 | # FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
11 | # INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
12 | # OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
13 | # TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
14 | # THIS SOFTWARE.
15 | 
16 | exec psql -1qX "$@" <<EOF
17 | \timing off
18 | 
19 | \echo '=========================== UNUSED INDICES ===========================\n'
20 | SELECT
21 |     name,
22 |     usage_over_idx_scan,
23 |     usage_relative_to_seq_scans,
24 |     usage_over_all_scans,
25 |     pg_size_pretty(size)
26 | FROM (
27 |     SELECT
28 |         idx.indexrelname AS name,
29 |         round(idx.idx_scan * 100.0 / NULLIF(tbl.idx_scan, 0), 2) AS usage_over_idx_scan,
30 |         round(idx.idx_scan * 100.0 / NULLIF(tbl.seq_scan, 0), 2) AS usage_relative_to_seq_scans,
31 |         round(idx.idx_scan * 100.0 / NULLIF(tbl.seq_scan + tbl.idx_scan, 0), 2) AS usage_over_all_scans,
32 |         pg_relation_size(quote_ident(idx.indexrelname)) AS size
33 |     FROM pg_stat_user_indexes idx
34 |     INNER JOIN pg_stat_user_tables tbl USING (relid)
35 |     INNER JOIN pg_index pgidx USING (indexrelid)
36 |     WHERE pgidx.indisunique
37 | ) stats
38 | WHERE usage_over_idx_scan < 50
39 |     AND usage_relative_to_seq_scans < 100
40 | ORDER BY
41 |     size DESC,
42 |     usage_over_idx_scan DESC,
43 |     usage_relative_to_seq_scans DESC,
44 |     usage_over_all_scans DESC;
45 | EOF
46 | 


--------------------------------------------------------------------------------
/pg_graph:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # Copyright 2018 Łukasz Niemier
 3 | 
 4 | # Permission to use, copy, modify, and/or distribute this software for any purpose
 5 | # with or without fee is hereby granted, provided that the above copyright notice
 6 | # and this permission notice appear in all copies.
 7 | 
 8 | # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 9 | # REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
10 | # FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
11 | # INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
12 | # OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
13 | # TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
14 | # THIS SOFTWARE.
15 | 
16 | exec psql -1qXt "$@" <<EOF
17 | \timing off
18 | 
19 | \echo 'Digraph F{'
20 | \echo 'ranksep=1.0; rankdir=LR;'
21 | \echo 'node [shape = none];'
22 | 
23 | WITH
24 |     relations AS (
25 |         SELECT
26 |             tc.constraint_name AS constraint_name,
27 |             tc.table_name,
28 |             kcu.column_name,
29 |             ccu.table_name AS foreign_table_name,
30 |             ccu.column_name AS foreign_column_name,
31 |             ccu.table_name || '_' || ccu.column_name AS key
32 |         FROM
33 |             information_schema.table_constraints AS tc
34 |         JOIN information_schema.key_column_usage AS kcu
35 |             ON tc.constraint_name = kcu.constraint_name
36 |             AND tc.table_schema = kcu.table_schema
37 |         JOIN information_schema.constraint_column_usage AS ccu
38 |             ON ccu.constraint_name = tc.constraint_name
39 |             AND ccu.table_schema = tc.table_schema
40 |         WHERE constraint_type = 'FOREIGN KEY'
41 |     ),
42 |     columns AS (
43 |         SELECT
44 |             '"' || c.table_name || '" [label = <<table align="left" cellborder="0"><tr><td bgcolor="gray"><B>'
45 |                 || c.table_name || '</B></td></tr>'
46 |                 || string_agg('<tr><td align="left" port="' || COALESCE("into".key, out.key, '') || '">'
47 |                         || c.column_name || ': <I>' || data_type || '</I></td></tr>',
48 |                     '')
49 |                 || '</table>>]'
50 |         FROM
51 |             (SELECT * FROM information_schema.columns ORDER BY table_name, ordinal_position) c
52 |         LEFT OUTER JOIN LATERAL (
53 |             SELECT key || '_out' AS key
54 |             FROM relations r
55 |             WHERE (r.table_name = c.table_name AND r.column_name = c.column_name)
56 |             LIMIT 1
57 |         ) out ON TRUE
58 |         LEFT OUTER JOIN LATERAL (
59 |             SELECT key || '_in' AS key
60 |             FROM relations r
61 |             WHERE (r.foreign_table_name = c.table_name AND r.foreign_column_name = c.column_name)
62 |             LIMIT 1
63 |         ) "into" ON TRUE
64 |         WHERE c.table_schema = 'public'
65 |         GROUP BY c.table_name
66 |     ),
67 |     links AS (
68 |         SELECT
69 |             table_name || ':' || key || '_out -> ' || foreign_table_name || ':' || key || '_in [label="' || constraint_name || '"];'
70 |         FROM relations
71 |     )
72 | SELECT * FROM columns UNION ALL SELECT * FROM links;
73 | 
74 | \echo '}'
75 | EOF
76 | 


--------------------------------------------------------------------------------