Skip to content

Commit 054a615

Browse files
authored
Merge pull request #7 from supabase/docs/readme
suggestions for readme
2 parents d377235 + bcb497e commit 054a615

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,17 @@
22

33
<p>
44
<a href=""><img src="https://img.shields.io/badge/postgresql-13+-blue.svg" alt="PostgreSQL version" height="18"></a>
5-
<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>
5+
<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>
66
<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>
77

88
</p>
99

10-
---
11-
1210
A PostgreSQL extension for recommending indexes to improve query performance.
1311

14-
Features:
12+
![Dashboard](./docs/img/dashboard.png)
13+
14+
## Features
15+
1516
- Supports generic parameters e.g. `$1`, `$2`
1617
- Supports materialized views
1718
- Identifies tables/columns obfuscaed by views
@@ -53,9 +54,13 @@ select
5354
from
5455
index_advisor('select book.id from book where title = $1');
5556

57+
```
58+
59+
```markdown
5660
startup_cost_before | startup_cost_after | total_cost_before | total_cost_after | index_statements | errors
5761
---------------------+--------------------+-------------------+------------------+-----------------------------------------------------+--------
5862
0.00 | 1.17 | 25.88 | 6.40 | {"CREATE INDEX ON public.book USING btree (title)"},| {}
63+
5964
(1 row)
6065
```
6166

@@ -111,6 +116,9 @@ from
111116
and publisher.id = $2
112117
');
113118

119+
```
120+
121+
```markdown
114122
startup_cost_before | startup_cost_after | total_cost_before | total_cost_after | index_statements | errors
115123
---------------------+--------------------+-------------------+------------------+-----------------------------------------------------------+--------
116124
27.26 | 12.77 | 68.48 | 42.37 | {"CREATE INDEX ON public.book USING btree (author_id)", | {}

docs/img/dashboard.png

1.14 MB
Loading

0 commit comments

Comments
 (0)