diff --git a/README.md b/README.md index 43d0d4d..55b4a9b 100644 --- a/README.md +++ b/README.md @@ -21,17 +21,40 @@ Alternative versions: ## Installation ```bash -cargo add pg-extras +cargo install pg-extras ``` -`calls` and `outliers` queries require [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) extension. +## Usage -You can check if it is enabled in your database by running: +Package expects the `$PG_EXTRAS_DATABASE_URL` or `$DATABASE_URL` env in the following format: ```rust -use pg_extras::{render_table, extensions} +export DATABASE_URL="postgresql://postgres:secret@localhost:5432/database_name" +``` + +You can use `pg_extras` shell command: + +```bash +$ pg_extras cache_hit ++----------------+------------------------+ +| /* Index and table hit rate */ | ++================+========================+ +| name | ratio | ++----------------+------------------------+ +| index hit rate | 0.99138647287107053837 | ++----------------+------------------------+ +| table hit rate | 0.99984856854492081787 | ++----------------+------------------------+ +``` + +## Dependencies + +`calls` and `outliers` queries require [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) extension. -render_table(extensions()?); +You can check if it is enabled in your database by running: + +```bash +pg_extras extensions ``` You should see the similar line in the output: @@ -48,15 +71,9 @@ CREATE EXTENSION IF NOT EXISTS pg_buffercache; CREATE EXTENSION IF NOT EXISTS pg_stat_statements; ``` -## Usage +## Rust API -Package expects the `ENV['PG_EXTRAS_DATABASE_URL']` or `ENV['DATABASE_URL']` value in the following format: - -```rust -ENV["DATABASE_URL"] = "postgresql://postgres:secret@localhost:5432/database_name" -``` - -You can run queries using a Rust API to display an ASCCI table with results: +You can also run queries using a Rust API to display an ASCCI table with results: ```rust use pg_extras::{render_table, cache_hit} @@ -95,22 +112,6 @@ cache_hit(Some("other_schema".to_string)).await?; You can customize the default `public` schema by setting `ENV['PG_EXTRAS_SCHEMA']` value. -## Command line - -After running `cargo install pg-extras` you can use `pg_extras` shell command: - -```bash -$ pg_extras cache_hit -+----------------+------------------------+ -| /* Index and table hit rate */ | -+================+========================+ -| name | ratio | -+----------------+------------------------+ -| index hit rate | 0.99138647287107053837 | -+----------------+------------------------+ -| table hit rate | 0.99984856854492081787 | -+----------------+------------------------+ -`````` ## Available methods