Skip to content

Commit

Permalink
Merge pull request #7 from supabase/docs/readme
Browse files Browse the repository at this point in the history
suggestions for readme
  • Loading branch information
olirice committed Apr 12, 2024
2 parents d377235 + bcb497e commit 054a615
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Expand Up @@ -2,16 +2,17 @@

<p>
<a href=""><img src="https://img.shields.io/badge/postgresql-13+-blue.svg" alt="PostgreSQL version" height="18"></a>
<a href="https://github.com/supabase/index_advisor/blob/master/LICENSE"><img src="https://img.shields.io/pypi/l/markdown-subtemplate.svg" alt="License" height="18"></a>
<a href="https://github.com/supabase/index_advisor/blob/master/LICENSE"><img src="https://img.shields.io/github/license/supabase/index_advisor" alt="License" height="18"></a>
<a href="https://github.com/supabase/index_advisor/actions"><img src="https://github.com/supabase/index_advisor/actions/workflows/test.yml/badge.svg" alt="tests" height="18"></a>

</p>

---

A PostgreSQL extension for recommending indexes to improve query performance.

Features:
![Dashboard](./docs/img/dashboard.png)

## Features

- Supports generic parameters e.g. `$1`, `$2`
- Supports materialized views
- Identifies tables/columns obfuscaed by views
Expand Down Expand Up @@ -53,9 +54,13 @@ select
from
index_advisor('select book.id from book where title = $1');

```

```markdown
startup_cost_before | startup_cost_after | total_cost_before | total_cost_after | index_statements | errors
---------------------+--------------------+-------------------+------------------+-----------------------------------------------------+--------
0.00 | 1.17 | 25.88 | 6.40 | {"CREATE INDEX ON public.book USING btree (title)"},| {}

(1 row)
```

Expand Down Expand Up @@ -111,6 +116,9 @@ from
and publisher.id = $2
');

```

```markdown
startup_cost_before | startup_cost_after | total_cost_before | total_cost_after | index_statements | errors
---------------------+--------------------+-------------------+------------------+-----------------------------------------------------------+--------
27.26 | 12.77 | 68.48 | 42.37 | {"CREATE INDEX ON public.book USING btree (author_id)", | {}
Expand Down
Binary file added docs/img/dashboard.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 054a615

Please sign in to comment.