{"id":19176378,"url":"https://github.com/pawurb/pg-extras-rs","last_synced_at":"2025-04-05T15:03:03.242Z","repository":{"id":214628836,"uuid":"736001998","full_name":"pawurb/pg-extras-rs","owner":"pawurb","description":" Rust PostgreSQL database performance insights. Locks, index usage, buffer cache hit ratios, vacuum stats and more. ","archived":false,"fork":false,"pushed_at":"2024-12-05T10:10:58.000Z","size":1167,"stargazers_count":62,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-13T00:02:20.796Z","etag":null,"topics":["database","performance","postgresql","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pawurb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-26T17:42:21.000Z","updated_at":"2025-02-01T19:01:03.000Z","dependencies_parsed_at":"2025-03-22T13:03:19.179Z","dependency_job_id":"13763818-f829-4f1b-8965-2f85c6c96681","html_url":"https://github.com/pawurb/pg-extras-rs","commit_stats":null,"previous_names":["pawurb/rust-pg-extras","pawurb/pg-extras-rs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawurb%2Fpg-extras-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawurb%2Fpg-extras-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawurb%2Fpg-extras-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawurb%2Fpg-extras-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pawurb","download_url":"https://codeload.github.com/pawurb/pg-extras-rs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247353729,"owners_count":20925329,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","performance","postgresql","rust"],"created_at":"2024-11-09T10:28:15.806Z","updated_at":"2025-04-05T15:03:03.222Z","avatar_url":"https://github.com/pawurb.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pg-extras-rs [![Latest Version](https://img.shields.io/crates/v/pg-extras.svg)](https://crates.io/crates/pg-extras) [![GH Actions](https://github.com/pawurb/pg-extras-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/pawurb/pg-extras-rs/actions)\n\nRust port of [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras) with several additions and improvements. The goal of this project is to provide powerful insights into the PostgreSQL database for Rust apps that are not using the Heroku PostgreSQL plugin.\n\nQueries can be used to obtain information about a Postgres instance, that may be useful when analyzing performance issues. This includes information about locks, index usage, buffer cache hit ratios and vacuum statistics. Rust API enables developers to easily integrate the tool into e.g. automatic monitoring tasks.\n\nYou can check out this blog post for detailed step by step tutorial on how to [optimize PostgreSQL using PG Extras library](https://pawelurbanek.com/postgresql-fix-performance).\n\nAlternative versions:\n\n- [Ruby on Rails](https://github.com/pawurb/rails-pg-extras)\n\n- [NodeJS](https://github.com/pawurb/node-postgres-extras)\n\n- [Elixir](https://github.com/pawurb/ecto_psql_extras)\n\n- [Python](https://github.com/pawurb/python-pg-extras)\n\n- [Haskell](https://github.com/pawurb/haskell-pg-extras)\n\n## Installation\n\n```bash\ncargo install pg-extras\n```\n\n## Usage\n\nPackage expects the `$PG_EXTRAS_DATABASE_URL` or `$DATABASE_URL` env in the following format:\n\n```rust\nexport DATABASE_URL=\"postgresql://postgres:secret@localhost:5432/database_name\"\n```\n\nYou can use `pgextras` shell command:\n\n```bash\n$ pgextras cache_hit\n+----------------+------------------------+\n| /* Index and table hit rate */          |\n+================+========================+\n| name           | ratio                  |\n+----------------+------------------------+\n| index hit rate | 0.99138647287107053837 |\n+----------------+------------------------+\n| table hit rate | 0.99984856854492081787 |\n+----------------+------------------------+\n```\n\n## Diagnose Report\n\nThe simplest way to start using pg-extras is to execute a `diagnose` method. It runs a set of checks and prints out a report highlighting areas that may require additional investigation:\n\n```bash\npgextras diagnose\n```\n\n![Diagnose report](pg-extras-diagnose-report.png)\n\n## Web UI\n\nAlternatively, you can use the application via the web UI. You have to enable the `web` feature flag:\n\n```bash\ncargo install pg-extras --features=\"web\"\n```\n\nNow you can run:\n\n```\npgextras web\n```\n\nTo launch the dashboard on `http://localhost:3000` (you can customize the port by setting the `PORT` ENV).\n\n![Web UI](pg-extras-web-ui.png)\n\nKeep reading to learn about methods that `diagnose` uses under the hood.\n\n## Rust API\n\nYou can also run queries using a Rust API to display an ASCCI table with results:\n\n```rust\nuse pg_extras::{cache_hit, pg_pool, render_table}\n\nlet pool = pg_pool().await?;\nrender_table(cache_hit(None, \u0026pool).await?);\n\n```\n```bash\n+----------------+------------------------+\n|        Index and table hit rate         |\n+----------------+------------------------+\n| name           | ratio                  |\n+----------------+------------------------+\n| index hit rate | 0.97796610169491525424 |\n| table hit rate | 0.96724294813466787989 |\n+----------------+------------------------+\n```\n\nAlternatively you can work directly with returned structs:\n\n```rust\nuse pg_extras::{cache_hit, pg_pool, render_table}\n\nlet pool = pg_pool().await?;\nlet cache_hit_res = cache_hit(None, \u0026pool).await?;\nprintln!(\"{:?}\", cache_hit_res);\n\n// [CacheHit { name: \"index hit rate\", ratio:  0.9779... }, CacheHit { name: \"table hit rate\", ratio: 0.9672... }]\n\n```\n\nSome methods accept params allowing you to customize queries:\n\n```rust\ncache_hit(Some(\"other_schema\".to_string), \u0026pool).await?;\n```\n\nYou can also customize the default `public` schema by setting `ENV['PG_EXTRAS_SCHEMA']` value.\n\n## Dependencies\n\n`calls` and `outliers` queries require [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) extension.\n\nYou can check if it is enabled in your database by running:\n\n```bash\npgextras extensions\n```\n\nYou should see the similar line in the output:\n\n```bash\n| pg_stat_statements  | 1.7  | 1.7 | track execution statistics of all SQL statements executed |\n```\n\n`ssl_used` requires `sslinfo` extension, and `buffercache_usage`/`buffercache_usage` queries need `pg_buffercache`. You can enable them all by running this SQL:\n\n```sql\nCREATE EXTENSION IF NOT EXISTS sslinfo;\nCREATE EXTENSION IF NOT EXISTS pg_buffercache;\nCREATE EXTENSION IF NOT EXISTS pg_stat_statements;\n```\n\n\n## Available methods\n\n### `cache_hit`\n\n```rust\nstruct CacheHit {\n    name: String,\n    ratio: Decimal,\n}\n\ncache_hit(schema: Option\u003cString\u003e, pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cCacheHit\u003e, PgExtrasError\u003e\n\n      name      |         ratio\n----------------+------------------------\n index hit rate | 0.99957765013541945832\n table hit rate |                   1.00\n(2 rows)\n```\n\nThis command provides information on the efficiency of the buffer cache, for both index reads (`index hit rate`) as well as table reads (`table hit rate`). A low buffer cache hit ratio can be a sign that the Postgres instance is too small for the workload.\n\n[More info](https://pawelurbanek.com/postgresql-fix-performance#cache-hit)\n\n### `index_cache_hit`\n\n```rust\nstruct IndexCacheHit {\n    name: String,\n    buffer_hits: i64,\n    block_reads: i64,\n    total_read: i64,\n    ratio: String,\n}\n\nindex_cache_hit(schema: Option\u003cString\u003e, pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cIndexCacheHit\u003e, PgExtrasError\u003e\n\n| name                  | buffer_hits | block_reads | total_read | ratio             |\n+-----------------------+-------------+-------------+------------+-------------------+\n| teams                 | 187665      | 109         | 187774     | 0.999419514948821 |\n| subscriptions         | 5160        | 6           | 5166       | 0.99883855981417  |\n| plans                 | 5718        | 9           | 5727       | 0.998428496595076 |\n(truncated results for brevity)\n```\n\nThe same as `cache_hit` with each table's indexes cache hit info displayed separately.\n\n[More info](https://pawelurbanek.com/postgresql-fix-performance#cache-hit)\n\n### `table_cache_hit`\n\n```rust\nstruct TableCacheHit {\n    name: String,\n    buffer_hits: i64,\n    block_reads: i64,\n    total_read: i64,\n    ratio: String,\n}\n\ntable_cache_hit(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cTableCacheHit\u003e, PgExtrasError\u003e\n\n| name                  | buffer_hits | block_reads | total_read | ratio             |\n+-----------------------+-------------+-------------+------------+-------------------+\n| plans                 | 32123       | 2           | 32125      | 0.999937743190662 |\n| subscriptions         | 95021       | 8           | 95029      | 0.999915815172211 |\n| teams                 | 171637      | 200         | 171837     | 0.99883610631005  |\n(truncated results for brevity)\n```\n\nThe same as `cache_hit` with each table's cache hit info displayed seperately.\n\n[More info](https://pawelurbanek.com/postgresql-fix-performance#cache-hit)\n\n### `db_settings`\n\n```rust\nstruct DbSettings {\n    name: String,\n    setting: String,\n    unit: String,\n    short_desc: String,\n}\n\ndb_settings(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cDbSettings\u003e, PgExtrasError\u003e\n\n             name             | setting | unit |\n------------------------------+---------+------+\n checkpoint_completion_target | 0.7     |      |\n default_statistics_target    | 100     |      |\n effective_cache_size         | 1350000 | 8kB  |\n effective_io_concurrency     | 1       |      |\n(truncated results for brevity)\n\n```\n\nThis method displays values for selected PostgreSQL settings. You can compare them with settings recommended by [PGTune](https://pgtune.leopard.in.ua/#/) and tweak values to improve performance.\n\n[More info](https://pawelurbanek.com/postgresql-fix-performance#cache-hit)\n\n### `ssl_used`\n\n```rust\nstruct SslUsed {\n    ssl_used: bool,\n}\n\nssl_used(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cSslUsed\u003e, PgExtrasError\u003e\n\n| ssl_is_used                     |\n+---------------------------------+\n| t                               |\n\n```\n\nReturns boolean indicating if an encrypted SSL is currently used. Connecting to the database via an unencrypted connection is a critical security risk.\n\n### `index_usage`\n\n```rust\nstruct IndexUsage {\n    relname: String,\n    percent_of_times_index_used: String,\n    rows_in_table: i64,\n}\n\nindex_usage(schema: Option\u003cString\u003e, pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cIndexUsage\u003e, PgExtrasError\u003e\n\n       relname       | percent_of_times_index_used | rows_in_table\n---------------------+-----------------------------+---------------\n events              |                          65 |       1217347\n app_infos           |                          74 |        314057\n app_infos_user_info |                           0 |        198848\n user_info           |                           5 |         94545\n delayed_jobs        |                          27 |             0\n(5 rows)\n```\n\nThis command provides information on the efficiency of indexes, represented as what percentage of total scans were index scans. A low percentage can indicate under indexing, or wrong data being indexed.\n\n### `locks`\n\n```rust\nstruct Locks {\n    pid: i32,\n    relname: String,\n    transactionid: String,\n    granted: bool,\n    mode: String,\n    query_snippet: String,\n    age: String,\n    application: String,\n}\n\nlocks(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cLocks\u003e, PgExtrasError\u003e\n\n procpid | relname | transactionid | granted |     query_snippet     | mode             |       age        |   application |\n---------+---------+---------------+---------+-----------------------+------------------------------------------------------\n   31776 |         |               | t       | \u003cIDLE\u003e in transaction | ExclusiveLock    |  00:19:29.837898 |  bin/rails\n   31776 |         |          1294 | t       | \u003cIDLE\u003e in transaction | RowExclusiveLock |  00:19:29.837898 |  bin/rails\n   31912 |         |               | t       | select * from hello;  | ExclusiveLock    |  00:19:17.94259  |  bin/rails\n    3443 |         |               | t       |                      +| ExclusiveLock    |  00:00:00        |  bin/sidekiq\n         |         |               |         |    select            +|                  |                  |\n         |         |               |         |      pg_stat_activi   |                  |                  |\n(4 rows)\n```\n\nThis command displays queries that have taken out an exclusive lock on a relation. Exclusive locks typically prevent other operations on that relation from taking place, and can be a cause of \"hung\" queries that are waiting for a lock to be granted.\n\n[More info](https://pawelurbanek.com/postgresql-fix-performance#deadlocks)\n\n### `all_locks`\n\n```rust\nstruct AllLocks {\n    pid: String,\n    relname: String,\n    transactionid: String,\n    granted: String,\n    mode: String,\n    query_snippet: String,\n    age: String,\n    application: String,\n}\n\nall_locks(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cAllLocks\u003e, PgExtrasError\u003e \n\n```\n\nThis command displays all the current locks, regardless of their type.\n\n### `outliers`\n\n```rust\nstruct Outliers {\n    total_exec_time: PgInterval,\n    prop_exec_time: String,\n    ncalls: String,\n    sync_io_time: PgInterval,\n    query: String,\n}\n\noutliers(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cOutliers\u003e, PgExtrasError\u003e\n\n                   query                 |    exec_time     | prop_exec_time |   ncalls    | sync_io_time\n-----------------------------------------+------------------+----------------+-------------+--------------\n SELECT * FROM archivable_usage_events.. | 154:39:26.431466 | 72.2%          | 34,211,877  | 00:00:00\n COPY public.archivable_usage_events (.. | 50:38:33.198418  | 23.6%          | 13          | 13:34:21.00108\n COPY public.usage_events (id, reporte.. | 02:32:16.335233  | 1.2%           | 13          | 00:34:19.784318\n INSERT INTO usage_events (id, retaine.. | 01:42:59.436532  | 0.8%           | 12,328,187  | 00:00:00\n SELECT * FROM usage_events WHERE (alp.. | 01:18:10.754354  | 0.6%           | 102,114,301 | 00:00:00\n UPDATE usage_events SET reporter_id =.. | 00:52:35.683254  | 0.4%           | 23,786,348  | 00:00:00\n INSERT INTO usage_events (id, retaine.. | 00:49:24.952561  | 0.4%           | 21,988,201  | 00:00:00\n(truncated results for brevity)\n```\n\nThis command displays statements, obtained from `pg_stat_statements`, ordered by the amount of time to execute in aggregate. This includes the statement itself, the total execution time for that statement, the proportion of total execution time for all statements that statement has taken up, the number of times that statement has been called, and the amount of time that statement spent on synchronous I/O (reading/writing from the file system).\n\nTypically, an efficient query will have an appropriate ratio of calls to total execution time, with as little time spent on I/O as possible. Queries that have a high total execution time but low call count should be investigated to improve their performance. Queries that have a high proportion of execution time being spent on synchronous I/O should also be investigated.\n\n[More info](https://pawelurbanek.com/postgresql-fix-performance#missing-indexes)\n\n### `calls`\n\n```rust\nstruct Calls {\n    qry: String,\n    exec_time: PgInterval,\n    prop_exec_time: String,\n    ncalls: String,\n    sync_io_time: PgInterval,\n}\n\ncalls(limit: Option\u003cString\u003e, pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cCalls\u003e, PgExtrasError\u003e\n\n                   qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time\n-----------------------------------------+------------------+----------------+-------------+--------------\n SELECT * FROM usage_events WHERE (alp.. | 01:18:11.073333  | 0.6%           | 102,120,780 | 00:00:00\n BEGIN                                   | 00:00:51.285988  | 0.0%           | 47,288,662  | 00:00:00\n COMMIT                                  | 00:00:52.31724   | 0.0%           | 47,288,615  | 00:00:00\n SELECT * FROM  archivable_usage_event.. | 154:39:26.431466 | 72.2%          | 34,211,877  | 00:00:00\n UPDATE usage_events SET reporter_id =.. | 00:52:35.986167  | 0.4%           | 23,788,388  | 00:00:00\n INSERT INTO usage_events (id, retaine.. | 00:49:25.260245  | 0.4%           | 21,990,326  | 00:00:00\n INSERT INTO usage_events (id, retaine.. | 01:42:59.436532  | 0.8%           | 12,328,187  | 00:00:00\n(truncated results for brevity)\n```\n\nThis command is much like `pg:outliers`, but ordered by the number of times a statement has been called.\n\n[More info](https://pawelurbanek.com/postgresql-fix-performance#missing-indexes)\n\n### `blocking`\n\n```rust\nstruct Blocking {\n    blocked_pid: i32,\n    blocking_statement: String,\n    blocking_duration: PgInterval,\n    blocking_pid: i32,\n    blocked_statement: String,\n    blocked_duration: PgInterval,\n    blocked_sql_app: String,\n    blocking_sql_app: String,\n}\n\nblocking(limit: Option\u003cString\u003e, pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cBlocking\u003e, PgExtrasError\u003e\n\n blocked_pid |    blocking_statement    | blocking_duration | blocking_pid |                                        blocked_statement                           | blocked_duration\n-------------+--------------------------+-------------------+--------------+------------------------------------------------------------------------------------+------------------\n         461 | select count(*) from app | 00:00:03.838314   |        15682 | UPDATE \"app\" SET \"updated_at\" = '2013-03-04 15:07:04.746688' WHERE \"id\" = 12823149 | 00:00:03.821826\n(1 row)\n```\n\nThis command displays statements that are currently holding locks that other statements are waiting to be released. This can be used in conjunction with `pg:locks` to determine which statements need to be terminated in order to resolve lock contention.\n\n[More info](https://pawelurbanek.com/postgresql-fix-performance#deadlocks)\n\n### `total_index_size`\n\n```rust\nstruct TotalIndexSize {\n    size: String,\n}\n\ntotal_index_size(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cTotalIndexSize\u003e, PgExtrasError\u003e\n\n  size\n-------\n 28194 MB\n(1 row)\n```\n\nThis command displays the total size of all indexes on the database, in MB. It is calculated by taking the number of pages (reported in `relpages`) and multiplying it by the page size (8192 bytes).\n\n### `index_size`\n\n```rust\n struct IndexSize {\n    name: String,\n    size: String,\n    schema: String,\n}\n\nindex_size(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cIndexSize\u003e, PgExtrasError\u003e \n\n                             name                              |  size   | schema |\n---------------------------------------------------------------+-------------------\n idx_activity_attemptable_and_type_lesson_enrollment           | 5196 MB | public |\n index_enrollment_attemptables_by_attempt_and_last_in_group    | 4045 MB | public |\n index_attempts_on_student_id                                  | 2611 MB | custom |\n enrollment_activity_attemptables_pkey                         | 2513 MB | custom |\n index_attempts_on_student_id_final_attemptable_type           | 2466 MB | custom |\n attempts_pkey                                                 | 2466 MB | custom |\n index_attempts_on_response_id                                 | 2404 MB | public |\n index_attempts_on_enrollment_id                               | 1957 MB | public |\n index_enrollment_attemptables_by_enrollment_activity_id       | 1789 MB | public |\n enrollment_activities_pkey                                    |  458 MB | public |\n(truncated results for brevity)\n```\n\nThis command displays the size of each each index in the database, in MB. It is calculated by taking the number of pages (reported in `relpages`) and multiplying it by the page size (8192 bytes).\n\n### `table_size`\n\n```rust\nstruct TableSize {\n    name: String,\n    size: String,\n    schema: String,\n}\n\ntable_size(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cTableSize\u003e, PgExtrasError\u003e \n\n                             name                              |  size   | schema |\n---------------------------------------------------------------+-------------------\n learning_coaches                                              |  196 MB | public |\n states                                                        |  145 MB | public |\n grade_levels                                                  |  111 MB | custom |\n charities_customers                                           |   73 MB | public |\n charities                                                     |   66 MB | public |\n(truncated results for brevity)\n```\n\nThis command displays the size of each table and materialized view in the database, in MB. It is calculated by using the system administration function `pg_table_size()`, which includes the size of the main data fork, free space map, visibility map and TOAST data.\n\n### `table_indexes_size`\n\n```rust\nTableIndexesSize {\n    table: String,\n    index_size: String,\n}\n\ntable_indexes_size(schema: Option\u003cString\u003e, pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cTableIndexesSize\u003e, PgExtrasError\u003e \n\n                             table                             | indexes_size\n---------------------------------------------------------------+--------------\n learning_coaches                                              |    153 MB\n states                                                        |    125 MB\n charities_customers                                           |     93 MB\n charities                                                     |     16 MB\n grade_levels                                                  |     11 MB\n(truncated results for brevity)\n```\n\nThis command displays the total size of indexes for each table and materialized view, in MB. It is calculated by using the system administration function `pg_indexes_size()`.\n\n### `total_table_size`\n\n```rust\nstruct TotalTableSize {\n    name: String,\n    size: String,\n}\n\ntotal_table_size(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cTotalTableSize\u003e, PgExtrasError\u003e\n\n                             name                              |  size\n---------------------------------------------------------------+---------\n learning_coaches                                              |  349 MB\n states                                                        |  270 MB\n charities_customers                                           |  166 MB\n grade_levels                                                  |  122 MB\n charities                                                     |   82 MB\n(truncated results for brevity)\n```\n\nThis command displays the total size of each table and materialized view in the database, in MB. It is calculated by using the system administration function `pg_total_relation_size()`, which includes table size, total index size and TOAST data.\n\n### `unused_indexes`\n\n```rust\nstruct UnusedIndexes {\n    table: String,\n    index: String,\n    index_size: String,\n    index_scans: i64,\n}\n\nunused_indexes(schema: Option\u003cString\u003e, pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cUnusedIndexes\u003e, PgExtrasError\u003e \n\n          table      |                       index                | index_size | index_scans\n---------------------+--------------------------------------------+------------+-------------\n public.grade_levels | index_placement_attempts_on_grade_level_id | 97 MB      |           0\n public.observations | observations_attrs_grade_resources         | 33 MB      |           0\n public.messages     | user_resource_id_idx                       | 12 MB      |           0\n(3 rows)\n```\n\nThis command displays indexes that have \u003c 50 scans recorded against them, and are greater than 5 pages in size, ordered by size relative to the number of index scans. This command is generally useful for eliminating indexes that are unused, which can impact write performance, as well as read performance should they occupy space in memory.\n\n[More info](https://pawelurbanek.com/postgresql-fix-performance#unused-indexes)\n\n### `duplicate_indexes`\n\n```rust\nstruct DuplicateIndexes {\n    size: String,\n    idx1: String,\n    idx2: String,\n    idx3: String,\n    idx4: String,\n}\n\nduplicate_indexes(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cDuplicateIndexes\u003e, PgExtrasError\u003e \n\n| size       |  idx1        |  idx2          |  idx3    |  idx4     |\n+------------+--------------+----------------+----------+-----------+\n| 128 k      | users_pkey   | index_users_id |          |           |\n```\n\nThis command displays multiple indexes that have the same set of columns, same opclass, expression and predicate - which make them equivalent. Usually it's safe to drop one of them.\n\n### `null_indexes`\n\n```rust\nstruct NullIndexes {\n    oid: String,\n    index: String,\n    index_size: String,\n    unique: bool,\n    indexed_column: String,\n    table: String,\n    null_frac: String,\n    expected_saving: String,\n    schema: String,\n}\n\nnull_indexes(min_relation_size_mb: Option\u003cString\u003e, pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cNullIndexes\u003e, PgExtrasError\u003e \n\n   oid   |         index      | index_size | unique | indexed_column | null_frac | expected_saving\n---------+--------------------+------------+--------+----------------+-----------+-----------------\n  183764 | users_reset_token  | 1445 MB    | t      | reset_token    |   97.00%  | 1401 MB\n   88732 | plan_cancelled_at  | 539 MB     | f      | cancelled_at   |    8.30%  | 44 MB\n 9827345 | users_email        | 18 MB      | t      | email          |   28.67%  | 5160 kB\n\n```\n\nThis command displays indexes that contain `NULL` values. A high ratio of `NULL` values means that using a partial index excluding them will be beneficial in case they are not used for searching.\n\n[More info](https://pawelurbanek.com/postgresql-fix-performance#null-indexes)\n\n### `seq_scans`\n\n```rust\nstruct SeqScans {\n    name: String,\n    count: i64,\n}\n\nseq_scans(schema: Option\u003cString\u003e, pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cSeqScans\u003e, PgExtrasError\u003e\n\n               name                |  count\n-----------------------------------+----------\n learning_coaches                  | 44820063\n states                            | 36794975\n grade_levels                      | 13972293\n charities_customers               |  8615277\n charities                         |  4316276\n messages                          |  3922247\n contests_customers                |  2915972\n classroom_goals                   |  2142014\n(truncated results for brevity)\n```\n\nThis command displays the number of sequential scans recorded against all tables, descending by count of sequential scans. Tables that have very high numbers of sequential scans may be under-indexed, and it may be worth investigating queries that read from these tables.\n\n[More info](https://pawelurbanek.com/postgresql-fix-performance#missing-indexes)\n\n### `long_running_queries`\n\n```rust\nstruct LongRunningQueries {\n    pid: String,\n    duration: String,\n    query: String,\n}\n\nlong_running_queries(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cLongRunningQueries\u003e, PgExtrasError\u003e \n\n  pid  |    duration     |                                      query\n-------+-----------------+---------------------------------------------------------------------------------------\n 19578 | 02:29:11.200129 | EXPLAIN SELECT  \"students\".* FROM \"students\"  WHERE \"students\".\"id\" = 1450645 LIMIT 1\n 19465 | 02:26:05.542653 | EXPLAIN SELECT  \"students\".* FROM \"students\"  WHERE \"students\".\"id\" = 1889881 LIMIT 1\n 19632 | 02:24:46.962818 | EXPLAIN SELECT  \"students\".* FROM \"students\"  WHERE \"students\".\"id\" = 1581884 LIMIT 1\n(truncated results for brevity)\n```\n\nThis command displays currently running queries, that have been running for longer than 5 minutes, descending by duration. Very long running queries can be a source of multiple issues, such as preventing DDL statements completing or vacuum being unable to update `relfrozenxid`.\n\n### `records_rank`\n\n```rust\nstruct RecordsRank {\n    name: String,\n    esiimated_count: i64,\n}\n\nrecords_rank(schema: Option\u003cString\u003e, pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cRecordsRank\u003e, PgExtrasError\u003e \n\n               name                | estimated_count\n-----------------------------------+-----------------\n tastypie_apiaccess                |          568891\n notifications_event               |          381227\n core_todo                         |          178614\n core_comment                      |          123969\n notifications_notification        |          102101\n django_session                    |           68078\n (truncated results for brevity)\n```\n\nThis command displays an estimated count of rows per table, descending by estimated count. The estimated count is derived from `n_live_tup`, which is updated by vacuum operations. Due to the way `n_live_tup` is populated, sparse vs. dense pages can result in estimations that are significantly out from the real count of rows.\n\n### `bloat`\n\n```rust\nstruct Bloat {\n    typefield: String,\n    schemaname: String,\n    object_name: String,\n    bloat: Decimal,\n    waste: String,\n}\n\nbloat(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cBloat\u003e, PgExtrasError\u003e \n\n type  | schemaname |           object_name         | bloat |   waste\n-------+------------+-------------------------------+-------+----------\n table | public     | bloated_table                 |   1.1 | 98 MB\n table | public     | other_bloated_table           |   1.1 | 58 MB\n index | public     | bloated_table::bloated_index  |   3.7 | 34 MB\n table | public     | clean_table                   |   0.2 | 3808 kB\n table | public     | other_clean_table             |   0.3 | 1576 kB\n (truncated results for brevity)\n```\n\nThis command displays an estimation of table \"bloat\" – space allocated to a relation that is full of dead tuples, that has yet to be reclaimed. Tables that have a high bloat ratio, typically 10 or greater, should be investigated to see if vacuuming is aggressive enough, and can be a sign of high table churn.\n\n[More info](https://pawelurbanek.com/postgresql-fix-performance#bloat)\n\n### `vacuum_stats`\n\n```rust\nstruct VacuumStats {\n    schema: String,\n    table: String,\n    last_vacuum: String,\n    last_autovacuum: String,\n    rowcount: String,\n    dead_rowcount: String,\n    autovacuum_threshold: String,\n    expect_autovacuum: String,\n}\n\nvacuum_stats(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cVacuumStats\u003e, PgExtrasError\u003e \n\n schema |         table         | last_vacuum | last_autovacuum  |    rowcount    | dead_rowcount  | autovacuum_threshold | expect_autovacuum\n--------+-----------------------+-------------+------------------+----------------+----------------+----------------------+-------------------\n public | log_table             |             | 2013-04-26 17:37 |         18,030 |              0 |          3,656       |\n public | data_table            |             | 2013-04-26 13:09 |             79 |             28 |             66       |\n public | other_table           |             | 2013-04-26 11:41 |             41 |             47 |             58       |\n public | queue_table           |             | 2013-04-26 17:39 |             12 |          8,228 |             52       | yes\n public | picnic_table          |             |                  |             13 |              0 |             53       |\n (truncated results for brevity)\n```\n\nThis command displays statistics related to vacuum operations for each table, including an estimation of dead rows, last autovacuum and the current autovacuum threshold. This command can be useful when determining if current vacuum thresholds require adjustments, and to determine when the table was last vacuumed.\n\n### `buffercache_stats`\n\n```rust\nstruct BuffercacheStats {\n    relname: String,\n    buffered: String,\n    buffer_percent: Decimal,\n    percent_of_relation: Decimal,\n}\n\nbuffercache_stats(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cBuffercacheStats\u003e, PgExtrasError\u003e \n```\n\nThis command shows the relations buffered in database share buffer, ordered by percentage taken. It also shows that how much of the whole relation is buffered.\n\n### `buffercache_usage`\n\n```rust\nstruct BuffercacheUsage {\n    relname: String,\n    buffers: i64,\n}\n\nbuffercache_usage(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cBuffercacheUsage\u003e, PgExtrasError\u003e \n```\n\nThis command calculates how many blocks from which table are currently cached.\n\n### `extensions`\n\n```rust\nstruct Extensions {\n    name: String,\n    default_version: String,\n    installed_version: String,\n    comment: String,\n}\n\nextensions(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cExtensions\u003e, PgExtrasError\u003e \n\n```\n\nThis command lists all the currently installed and available PostgreSQL extensions.\n\n### `connections`\n\n```rust\nstruct Connections {\n    username: String,\n    pid: i32,\n    client_addr: String,\n}\n\nconnections(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cConnections\u003e, PgExtrasError\u003e \n\n+----------------------------------------------------------------+\n|      Returns the list of all active database connections       |\n+------------------+--------------------------+------------------+\n| username | pid   | client_address           | application_name |\n+------------------+--------------------------+------------------+\n| postgres | 15962 | 172.31.69.166/32         | sidekiq          |\n| postgres | 16810 | 172.31.69.166/32         | bin/rails        |\n+------------------+--------------------------+------------------+\n\n```\n\nThis command returns the list of all active database connections.\n\n### `mandelbrot`\n\n```rust\nstruct Mandelbrot {\n    array_to_string: String,\n}\n\nmandelbrot(pool: \u0026Pool\u003cPostgres\u003e) -\u003e Result\u003cVec\u003cMandelbrot\u003e, PgExtrasError\u003e\n\n```\n\nThis command outputs the Mandelbrot set, calculated through SQL.\n\n## Testing\n\n```bash\ncp docker-compose.yml.sample docker-compose.yml\ndocker compose up -d\ncargo test -- --nocapture\n```\n\n## Query sources\n\n- [https://github.com/heroku/heroku-pg-extras](https://github.com/heroku/heroku-pg-extras)\n- [https://hakibenita.com/postgresql-unused-index-size](https://hakibenita.com/postgresql-unused-index-size)\n- [https://sites.google.com/site/itmyshare/database-tips-and-examples/postgres/useful-sqls-to-check-contents-of-postgresql-shared_buffer](https://sites.google.com/site/itmyshare/database-tips-and-examples/postgres/useful-sqls-to-check-contents-of-postgresql-shared_buffer)\n- [https://wiki.postgresql.org/wiki/Index_Maintenance](https://wiki.postgresql.org/wiki/Index_Maintenance)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpawurb%2Fpg-extras-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpawurb%2Fpg-extras-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpawurb%2Fpg-extras-rs/lists"}