Skip to content

Commit dbb2d87

Browse files
committed
Update user manual
Signed-off-by: Chen Dai <daichen@amazon.com>
1 parent 989af8e commit dbb2d87

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/index.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,9 +328,11 @@ VACUUM MATERIALIZED VIEW alb_logs_metrics
328328
- index_name: user defined name for covering index and materialized view
329329
- auto_refresh: auto refresh option of the index (true / false)
330330
- status: status of the index
331+
- **Extended Usage**: Display additional information, including the following output columns:
332+
- error: error message if the index is in failed status
331333

332334
```sql
333-
SHOW FLINT [INDEX|INDEXES] IN catalog[.database]
335+
SHOW FLINT [INDEX|INDEXES] [EXTENDED] IN catalog[.database]
334336
```
335337

336338
Example:
@@ -344,6 +346,15 @@ fetched rows / total rows = 3/3
344346
| flint_spark_catalog_default_http_logs_skipping_index | skipping | default | http_logs | NULL | true | refreshing |
345347
| flint_spark_catalog_default_http_logs_status_clientip_index | covering | default | http_logs | status_clientip | false | active |
346348
+-------------------------------------------------------------+----------+----------+-----------+-----------------+--------------+------------+
349+
350+
sql> SHOW FLINT INDEXES EXTENDED IN spark_catalog.default;
351+
fetched rows / total rows = 2/2
352+
+-------------------------------------------------------------+----------+----------+-----------+-----------------+--------------+------------+-------------------------------+
353+
| flint_index_name | kind | database | table | index_name | auto_refresh | status | error |
354+
|-------------------------------------------------------------+----------+----------+-----------+-----------------+--------------+------------+-------------------------------|
355+
| flint_spark_catalog_default_http_count_view | mv | default | NULL | http_count_view | false | active | NULL |
356+
| flint_spark_catalog_default_http_logs_skipping_index | skipping | default | http_logs | NULL | true | failed | failure in bulk execution:... |
357+
+-------------------------------------------------------------+----------+----------+-----------+-----------------+--------------+------------+-------------------------------+
347358
```
348359

349360
- **Analyze Skipping Index**: Provides recommendation for creating skipping index. It outputs the following columns:

0 commit comments

Comments
 (0)