Skip to content

Commit 8650373

Browse files
committed
Update README.md
2 parents 0d04c45 + 754e320 commit 8650373

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,18 @@ Based on the partitioning type and condition's operator, `pg_pathman` searches f
3232
More interesting features are yet to come. Stay tuned!
3333

3434
## Roadmap
35-
* Implement concurrent partitioning (much more responsive)
36-
* Implement HASH-patitioning for non-integer attributes
35+
* Replace INSERT triggers with a custom node (aka **PartitionFilter**)
36+
* Implement [concurrent partitioning](https://github.com/postgrespro/pg_pathman/tree/concurrent_part) (much more responsive)
37+
* Implement HASH partitioning for non-integer attributes
3738
* Optimize hash join (both tables are partitioned by join key)
38-
* Implement LIST patitioning scheme
39+
* Implement LIST partitioning scheme
3940

4041
## Installation guide
4142
To install `pg_pathman`, execute this in the module's directory:
4243
```
4344
make install USE_PGXS=1
4445
```
45-
Modify the **`shared_preload_libraries`** parameter in `postgres.conf` as following:
46+
Modify the **`shared_preload_libraries`** parameter in `postgresql.conf` as following:
4647
```
4748
shared_preload_libraries = 'pg_pathman'
4849
```
@@ -65,7 +66,7 @@ create_hash_partitions(relation TEXT,
6566
```
6667
Performs HASH partitioning for `relation` by integer key `attribute`. Creates `partitions_count` partitions and trigger on INSERT. All the data will be automatically copied from the parent to partitions.
6768

68-
```
69+
```plpgsql
6970
create_range_partitions(relation TEXT,
7071
attribute TEXT,
7172
start_value ANYELEMENT,
@@ -106,52 +107,52 @@ create_range_update_trigger(parent TEXT)
106107
Same as above, but for a RANGE-partitioned table.
107108

108109
### Post-creation partition management
109-
```
110+
```plpgsql
110111
split_range_partition(partition TEXT, value ANYELEMENT)
111112
```
112113
Split RANGE `partition` in two by `value`.
113114

114-
```
115+
```plpgsql
115116
merge_range_partitions(partition1 TEXT, partition2 TEXT)
116117
```
117118
Merge two adjacent RANGE partitions. First, data from `partition2` is copied to `partition1`, then `partition2` is removed.
118119

119-
```
120+
```plpgsql
120121
append_range_partition(p_relation TEXT)
121122
```
122123
Append new RANGE partition.
123124

124-
```
125+
```plpgsql
125126
prepend_range_partition(p_relation TEXT)
126127
```
127128
Prepend new RANGE partition.
128129

129-
```
130+
```plpgsql
130131
add_range_partition(relation TEXT,
131132
start_value ANYELEMENT,
132133
end_value ANYELEMENT)
133134
```
134135
Create new RANGE partition for `relation` with specified range bounds.
135136

136-
```
137+
```plpgsql
137138
drop_range_partition(partition TEXT)
138139
```
139140
Drop RANGE partition and all its data.
140141

141-
```
142+
```plpgsql
142143
attach_range_partition(relation TEXT,
143144
partition TEXT,
144145
start_value ANYELEMENT,
145146
end_value ANYELEMENT)
146147
```
147148
Attach partition to the existing RANGE-partitioned relation. The attached table must have exactly the same structure as the parent table, including the dropped columns.
148149

149-
```
150+
```plpgsql
150151
detach_range_partition(partition TEXT)
151152
```
152153
Detach partition from the existing RANGE-partitioned relation.
153154

154-
```
155+
```plpgsql
155156
disable_partitioning(relation TEXT)
156157
```
157158
Permanently disable `pg_pathman` partitioning mechanism for the specified parent table and remove the insert trigger if it exists. All partitions and data remain unchanged.

0 commit comments

Comments
 (0)