Skip to content

Commit 546c20e

Browse files
oliricecharislam
andauthored
Update the index_advisor extension guide (supabase#22750)
* update the index_advisor extension guide * Update apps/docs/content/guides/database/extensions/index_advisor.mdx Co-authored-by: Charis <[email protected]> * prettier fixes --------- Co-authored-by: Charis <[email protected]>
1 parent 451c5c8 commit 546c20e

File tree

2 files changed

+17
-18
lines changed

2 files changed

+17
-18
lines changed

apps/docs/content/guides/database/extensions/index_advisor.mdx

+17-18
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,20 @@ title: 'index_advisor: query optimization'
44
description: 'Automatically optimize SQL queries'
55
---
66

7-
[Index advisor](https://database.dev/olirice/index_advisor) is a Postgres extension for recommending indexes to improve query performance.
7+
[Index advisor](https://github.com/supabase/index_advisor) is a Postgres extension for recommending indexes to improve query performance.
8+
9+
Features:
10+
11+
- Supports generic parameters e.g. `$1`, `$2`
12+
- Supports materialized views
13+
- Identifies tables/columns obfuscated by views
14+
- Skips duplicate indexes
15+
16+
index_advisor is accessible directly through Supabase Studio by navigating to the [Query Performance Report](/dashboard/project/*/database/query-performance) and selecting a query and then the "indexes" tab.
17+
18+
![Supabase Studio index_advisor integration.](/docs/img/index_advisor_studio.png)
19+
20+
Alternatively, you can use index_advisor directly via SQL.
821

922
For example:
1023

@@ -20,25 +33,12 @@ from
2033
(1 row)
2134
```
2235

23-
Features:
24-
25-
- Supports generic parameters e.g. `$1`, `$2`
26-
- Supports materialized views
27-
- Identifies tables/columns obfuscated by views
28-
- Skips duplicate indexes
29-
3036
## Installation
3137

32-
index_advisor is a trusted language extension, which means it is directly installable by users from the [database.dev](https://database.dev/) SQL package repository.
33-
34-
To get started, enable the dbdev client by executing the [setup SQL script](https://database.dev/installer).
35-
36-
Then, install index_advisor by running
38+
To get started, enable index_advisor by running
3739

3840
```sql
39-
select dbdev.install('olirice-index_advisor');
40-
create extension if not exists hypopg;
41-
create extension "olirice-index_advisor";
41+
create extension index_advisor;
4242
```
4343

4444
## API
@@ -152,5 +152,4 @@ from
152152

153153
## Resources
154154

155-
- dbdev [`index_advisor`](https://database.dev/olirice/index_advisor) docs
156-
- dbdev [Github Repository](https://github.com/supabase/dbdev)
155+
- [`index_advisor`](https://github.com/supabase/index_advisor) repo
1.14 MB
Loading

0 commit comments

Comments
 (0)