Skip to content

Commit 6217db5

Browse files
committed
Adjust README.md
1 parent 578995a commit 6217db5

File tree

1 file changed

+7
-25
lines changed

1 file changed

+7
-25
lines changed

README.md

Lines changed: 7 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
PostgreSQL extension that shows query plans of all the currently running SQL
44
statements.
55

6-
Plan output format can either be plain TEXT (default), or JSON.
6+
Plan output format can be plain TEXT (default), JSON, YAML, or XML.
77

88
### NOTE
99

@@ -19,15 +19,15 @@ There are several ways of doing it...
1919
```
2020
git clone https://github.com/cybertec-postgresql/pg_show_plans.git
2121
cd pg_show_plans
22-
USE_PGXS=true # `pg_config` binary must be in your $PATH (install Postgres).
22+
USE_PGXS=1 # `pg_config` binary must be in your $PATH (install Postgres).
2323
make
2424
sudo make install
2525
```
2626

2727
## Within PostgreSQL source tree:
2828

2929
```
30-
PG_VER='15.1' # Export the required PostgreSQL version.
30+
PG_VER='15.1' # Set the required PostgreSQL version.
3131
curl -O "https://download.postgresql.org/pub/source/v${PG_VER}/postgresql-${PG_VER}.tar.bz2"
3232
tar xvfj "postgresql-${PG_VER}.tar.bz2"
3333
cd postgresql-${PG_VER}
@@ -119,16 +119,16 @@ query |
119119
- *pg_show_plans_disable()* disables the feature. Only superuser can execute
120120
it.
121121
- *pg_show_plans_enable()* enables the feature. Only superuser can execute it.
122-
- *pgsp_format_json()* changes the output format to `json`. Note that the
123-
format of the plans that are stored in the memory before executing this
124-
function cannot be changed.
125122
- *pgsp_format_text()* changes the output format to `text`. Note that the
126123
format of the plans that are stored in the memory before executing this
127124
function cannot be changed.
125+
- *pgsp_format_json()* changes the output format to `json`.
126+
- *pgsp_format_yaml()* changes the output format to `yaml`.
127+
- *pgsp_format_xml()* changes the output format to `xml`.
128128

129129
# CONFIGURATION
130130
- *pg_show_plans.plan_format* : It controls the output format of query plans.
131-
It can be selected either `text` or `json`. Default is `text`.
131+
It can be selected `text`, `json`, `yaml`, `xml`. Default is `text`.
132132
- *pg_show_plans.max_plan_length* : It sets the maximum length of query plans.
133133
Default is `16384` [byte]. Note that this parameter must be set to an
134134
integer. Note that pg_show plans allocates approximately (max_plan_length *
@@ -137,21 +137,3 @@ query |
137137
out of memory error.
138138
- *pg_show_plans.enable* : It controls whether this feature is enabled or not
139139
in each user. Default is 'true'.
140-
141-
# CHANGELOG
142-
143-
- 22 Mar, 2022: Version 1.0 Released.
144-
- 22 Mar, 2022: Improved memory utilization efficiency and obsoleted a
145-
parameter:pg_show_plans.enable_txid.
146-
- 30 Aug, 2021: Added a parameter:pg_show_plans.enable_txid.
147-
- 4 Feb, 2021: Added a parameter:pg_show_plans.enable.
148-
- 19 Oct, 2020: Confirmed this can be run on PostgreSQL 13.0.
149-
- 10 Apr, 2020: Version 1.0 RC3 Released. Supported Streaming Replication.
150-
This extension can be run on the standby server since this version.
151-
- 26 Mar, 2020: Version 1.0 RC2 Released. Added pgsp_format_json() and
152-
pgsp_format_text(); deleted the parameter `show_level`.
153-
- 21 Dec, 2019: Version 1.0 RC Released. Supported versions from 9.1 to 9.4.
154-
- 16 Aug, 2019: Version 0.8 Released. Supported the parameter:max_plan_length.
155-
- 12 Aug, 2019: Version 0.3 Released. Supported garbage collection.
156-
- 9 Aug, 2019: Version 0.2 Released. Supported nested queries.
157-
- 8 Aug, 2019: Version 0.1 Released.

0 commit comments

Comments
 (0)