Skip to content

Commit cda15f8

Browse files
committed
docs: update index docs page on site
1 parent fe6836c commit cda15f8

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

docs/index.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,50 @@
11
# PostgreSQL Hacker Helper
22

3+
![Logo](./img/logo.png)
4+
35
This is a VS Code extension to assist PostgreSQL Hackers - source code developers.
46

7+
## Features
8+
9+
Extension integrates with VS Code and provides several different functionalities.
10+
11+
### PostgreSQL Variables exploring
12+
13+
During debug session separate view `PG Variables` shows contents of variables with special handling of PostgreSQL related variables:
14+
15+
- View `Node *` variables with real type according to `NodeTag`
16+
- Get the contents of container types: `List *`, `HTAB *`, `Bitmapset *`
17+
- Known array variables are rendered as normal arrays
18+
- Render `Expr` nodes by the original expression
19+
- Show integer enums as enum values, not integers
20+
- Render some scalar types according to their semantics:
21+
- `bitmapword`
22+
- `XLogRecPtr`
23+
- `RelFileLocator`
24+
25+
![Variables view](./img/overview.gif)
26+
27+
You can define your own custom types, i.e. your own array variable using [configuration file](./configuration.md).
28+
29+
### Formatting
30+
31+
For C files you can use custom formatter which uses `pgindent` for formatting.
32+
33+
The extension will download and built any required files if needed - you do not have to do anything.
34+
35+
![Example formatting](./img/formatter-work.gif)
36+
37+
### `postgresql.conf` syntax support
38+
39+
PostgreSQL configuration file custom syntax is supported.
40+
This is an add-on to the standard configuration file syntax with support for units (i.e. `kB` or `s`) and highlighting of quoted values.
41+
42+
![Syntax example](./img/pgconf_syntax.png)
43+
44+
### Extension bootstrapping
45+
46+
For fast extension creation you can use command `Bootstrap extension` that will create all templated files, so you do not have to create ones.
47+
548
## Table of contents
649

750
- [Configuration](./configuration.md)

0 commit comments

Comments
 (0)