Update API docs for get_rebalace_progress (#1011)

Citus 10.1 added 2 new columns to the output of get_rebalance_progress.
citusdata · Sep 15, 2021 · 68ea337 · 68ea337
1 parent ac134f7
commit 68ea337
Showing 1 changed file with 11 additions and 9 deletions.
diff --git a/develop/api_udf.rst b/develop/api_udf.rst
@@ -1410,12 +1410,14 @@ Tuples containing these columns:
 * **sessionid**: Postgres PID of the rebalance monitor
 * **table_name**: The table whose shards are moving
 * **shardid**: The shard in question
-* **shard_size**: Size in bytes
+* **shard_size**: Size of the shard in bytes
 * **sourcename**: Hostname of the source node
 * **sourceport**: Port of the source node
 * **targetname**: Hostname of the destination node
 * **targetport**: Port of the destination node
 * **progress**: 0 = waiting to be moved; 1 = moving; 2 = complete
+* **source_shard_size**: Size of the shard on the source node in bytes
+* **target_shard_size**: Size of the shard on the target node in bytes
 
 Example
 **************************
@@ -1426,14 +1428,14 @@ Example
 
 ::
 
-  ┌───────────┬────────────┬─────────┬────────────┬───────────────┬────────────┬───────────────┬────────────┬──────────┐
-  │ sessionid │ table_name │ shardid │ shard_size │  sourcename   │ sourceport │  targetname   │ targetport │ progress │
-  ├───────────┼────────────┼─────────┼────────────┼───────────────┼────────────┼───────────────┼────────────┼──────────┤
-  │      7083 │ foo        │  102008 │    1204224 │ n1.foobar.com │       5432 │ n4.foobar.com │       5432 │        0 │
-  │      7083 │ foo        │  102009 │    1802240 │ n1.foobar.com │       5432 │ n4.foobar.com │       5432 │        0 │
-  │      7083 │ foo        │  102018 │     614400 │ n2.foobar.com │       5432 │ n4.foobar.com │       5432 │        1 │
-  │      7083 │ foo        │  102019 │       8192 │ n3.foobar.com │       5432 │ n4.foobar.com │       5432 │        2 │
-  └───────────┴────────────┴─────────┴────────────┴───────────────┴────────────┴───────────────┴────────────┴──────────┘
+  ┌───────────┬────────────┬─────────┬────────────┬───────────────┬────────────┬───────────────┬────────────┬──────────┬───────────────────┬───────────────────┐
+  │ sessionid │ table_name │ shardid │ shard_size │  sourcename   │ sourceport │  targetname   │ targetport │ progress │ source_shard_size │ target_shard_size │
+  ├───────────┼────────────┼─────────┼────────────┼───────────────┼────────────┼───────────────┼────────────┼──────────┼───────────────────┼───────────────────┤
+  │      7083 │ foo        │  102008 │    1204224 │ n1.foobar.com │       5432 │ n4.foobar.com │       5432 │        0 │           1204224 │                 0 │
+  │      7083 │ foo        │  102009 │    1802240 │ n1.foobar.com │       5432 │ n4.foobar.com │       5432 │        0 │           1802240 │                 0 │
+  │      7083 │ foo        │  102018 │     614400 │ n2.foobar.com │       5432 │ n4.foobar.com │       5432 │        1 │            614400 │            354400 │
+  │      7083 │ foo        │  102019 │       8192 │ n3.foobar.com │       5432 │ n4.foobar.com │       5432 │        2 │                 0 │              8192 │
+  └───────────┴────────────┴─────────┴────────────┴───────────────┴────────────┴───────────────┴────────────┴──────────┴───────────────────┴───────────────────┘
 
 .. _citus_add_rebalance_strategy: