Skip to content

Commit 5a16d23

Browse files
funbringerfunbringer
committed
Merge branch 'merge_concurrent' of github.com:postgrespro/pg_pathman into merge_concurrent
2 parents fd4405d + 9ed7d5d commit 5a16d23

File tree

2 files changed

+75
-37
lines changed

2 files changed

+75
-37
lines changed

‎README.md

Lines changed: 74 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -62,77 +62,94 @@ Done! Now it's time to setup your partitioning schemes.
6262

6363
### Partition creation
6464
```plpgsql
65-
create_hash_partitions(relation TEXT,
65+
create_hash_partitions(relation REGCLASS,
6666
attribute TEXT,
67-
partitions_count INTEGER)
67+
partitions_count INTEGER,
68+
partition_name TEXT DEFAULT NULL)
6869
```
69-
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.
70+
Performs HASH partitioning for `relation` by integer key `attribute`. The `partitions_count` parameter specifies the number of partitions to create; it cannot be changed afterwards. If `partition_data` is `true` then all the data will be automatically copied from the parent table to partitions. Note that data migration may took a while to finish and the table will be locked until transaction commits. See `partition_data_concurrent()` for a lock-free way to migrate data.
7071

7172
```plpgsql
72-
create_range_partitions(relation TEXT,
73-
attribute TEXT,
74-
start_value ANYELEMENT,
75-
interval ANYELEMENT,
76-
premake INTEGER DEFAULT NULL)
73+
create_range_partitions(relation REGCLASS,
74+
attribute TEXT,
75+
start_value ANYELEMENT,
76+
interval ANYELEMENT,
77+
count INTEGER DEFAULT NULL
78+
partition_data BOOLEAN DEFAULT true)
79+
80+
create_range_partitions(relation TEXT,
81+
attribute TEXT,
82+
start_value ANYELEMENT,
83+
interval INTERVAL,
84+
count INTEGER DEFAULT NULL,
85+
partition_data BOOLEAN DEFAULT true)
86+
```
87+
Performs RANGE partitioning for `relation` by partitioning key `attribute`. `start_value` argument specifies initial value, `interval` sets the range of values in a single partition, `count` is the number of premade partitions (if not set then pathman tries to determine it based on attribute values).
7788

78-
create_range_partitions(relation TEXT,
79-
attribute TEXT,
80-
start_value ANYELEMENT,
81-
interval INTERVAL,
82-
premake INTEGER DEFAULT NULL)
89+
```plpgsql
90+
create_partitions_from_range(relation REGCLASS,
91+
attribute TEXT,
92+
start_value ANYELEMENT,
93+
end_value ANYELEMENT,
94+
interval ANYELEMENT,
95+
partition_data BOOLEAN DEFAULT true)
96+
97+
create_partitions_from_range(relation REGCLASS,
98+
attribute TEXT,
99+
start_value ANYELEMENT,
100+
end_value ANYELEMENT,
101+
interval INTERVAL,
102+
partition_data BOOLEAN DEFAULT true)
83103
```
84-
Performs RANGE partitioning for `relation` by partitioning key `attribute`. `start_value` argument specifies initial value, `interval` sets the range of values in a single partition, `premake` is the number of premade partitions (if not set then pathman tries to determine it based on attribute values). All the data will be automatically copied from the parent to partitions.
104+
Performs RANGE-partitioning from specified range for `relation` by partitioning key `attribute`.
85105

86-
```plpgsql
87-
create_partitions_from_range(relation TEXT,
88-
attribute TEXT,
89-
start_value ANYELEMENT,
90-
end_value ANYELEMENT,
91-
interval ANYELEMENT)
106+
### Data migration
92107

93-
create_partitions_from_range(relation TEXT,
94-
attribute TEXT,
95-
start_value ANYELEMENT,
96-
end_value ANYELEMENT,
97-
interval INTERVAL)
108+
```plpgsql
109+
partition_data_concurrent(relation REGCLASS)
98110
```
99-
Performs RANGE-partitioning from specified range for `relation` by partitioning key `attribute`. Data will be copied to partitions as well.
111+
Starts a background worker to copy data from parent table to partitions. The worker utilize short transactions to copy small bunches of data (up to 10K rows per transaction) and thus doesn't significantly interfere with users activity.
100112

101113
### Triggers
102114
```plpgsql
103-
create_hash_update_trigger(parent TEXT)
115+
create_hash_update_trigger(parent REGCLASS)
104116
```
105117
Creates the trigger on UPDATE for HASH partitions. The UPDATE trigger isn't created by default because of the overhead. It's useful in cases when the key attribute might change.
106118
```plpgsql
107-
create_range_update_trigger(parent TEXT)
119+
create_range_update_trigger(parent REGCLASS)
108120
```
109121
Same as above, but for a RANGE-partitioned table.
110122

111123
### Post-creation partition management
112124
```plpgsql
113-
split_range_partition(partition TEXT, value ANYELEMENT)
125+
split_range_partition(partition REGCLASS,
126+
value ANYELEMENT,
127+
partition_name TEXT DEFAULT NULL,)
114128
```
115129
Split RANGE `partition` in two by `value`.
116130

117131
```plpgsql
118-
merge_range_partitions(partition1 TEXT, partition2 TEXT)
132+
merge_range_partitions(partition1 REGCLASS, partition2 REGCLASS)
119133
```
120134
Merge two adjacent RANGE partitions. First, data from `partition2` is copied to `partition1`, then `partition2` is removed.
121135

122136
```plpgsql
123-
append_range_partition(p_relation TEXT)
137+
append_range_partition(p_relation REGCLASS,
138+
partition_name TEXT DEFAULT NULL)
124139
```
125140
Append new RANGE partition.
126141

127142
```plpgsql
128-
prepend_range_partition(p_relation TEXT)
143+
prepend_range_partition(p_relation REGCLASS,
144+
partition_name TEXT DEFAULT NULL)
129145
```
130146
Prepend new RANGE partition.
131147

132148
```plpgsql
133-
add_range_partition(relation TEXT,
134-
start_value ANYELEMENT,
135-
end_value ANYELEMENT)
149+
add_range_partition(relation REGCLASS,
150+
start_value ANYELEMENT,
151+
end_value ANYELEMENT,
152+
partition_name TEXT DEFAULT NULL)
136153
```
137154
Create new RANGE partition for `relation` with specified range bounds.
138155

@@ -155,10 +172,31 @@ detach_range_partition(partition TEXT)
155172
Detach partition from the existing RANGE-partitioned relation.
156173

157174
```plpgsql
158-
disable_partitioning(relation TEXT)
175+
disable_pathman_for(relation TEXT)
159176
```
160177
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.
161178

179+
```plpgsql
180+
drop_partitions(parent REGCLASS,
181+
delete_data BOOLEAN DEFAULT FALSE)
182+
```
183+
Drop partitions of the `parent` table. If `delete_data` is `false` then the data is copied to the parent table first. Default is `false`.
184+
185+
186+
### Additional parameters
187+
188+
```plpgsql
189+
enable_parent(relation REGCLASS)
190+
disable_parent(relation REGCLASS)
191+
```
192+
Include/exclude parent table into/from query plan. In original PostgreSQL planner parent table is always included into query plan even if it's empty which can lead to additional overhead. You can use `disable_parent()` if you are never going to use parent table as a storage. Default value depends on the `partition_data` parameter that was specified during initial partitioning in `create_range_partitions()` or `create_partitions_from_range()` functions. If the `partition_data` parameter was `true` then all data have already been migrated to partitions and parent table disabled. Otherwise it is enabled.
193+
194+
```plpgsql
195+
enable_auto(relation REGCLASS)
196+
disable_auto(relation REGCLASS)
197+
```
198+
Enable/disable auto partition propagation (only for RANGE partitioning). It is enabled by default.
199+
162200
## Custom plan nodes
163201
`pg_pathman` provides a couple of [custom plan nodes](https://wiki.postgresql.org/wiki/CustomScanAPI) which aim to reduce execution time, namely:
164202

‎init.sql

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ SET pg_pathman.enable_partitionfilter = on; /* ensures that PartitionFilter is O
282282
/*
283283
* Disable pathman partitioning for specified relation.
284284
*/
285-
CREATE OR REPLACE FUNCTION @extschema@.disable_partitioning(
285+
CREATE OR REPLACE FUNCTION @extschema@.disable_pathman_for(
286286
parent_relid REGCLASS)
287287
RETURNS VOID AS
288288
$$

0 commit comments

Comments
 (0)