@@ -20405,7 +20405,6 @@ SELECT (pg_stat_file('filename')).modification;
20405
20405
</para>
20406
20406
20407
20407
</sect2>
20408
-
20409
20408
<sect2 id="functions-compression-control">
20410
20409
<title>Compression Control Functions</title>
20411
20410
@@ -20462,87 +20461,89 @@ SELECT (pg_stat_file('filename')).modification;
20462
20461
<literal><function>cfs_start_gc(n_workers integer)</function></literal>
20463
20462
</entry>
20464
20463
<entry><type>integer</type></entry>
20465
- <entry>Manually initiate GC using specified number of workers (only if background GC is disabled).
20464
+ <entry>Starts garbage collection using the specified number of workers.
20465
+ You can only run this function to start the garbage collection manually
20466
+ if background garbage collection is disabled.
20466
20467
</entry>
20467
20468
</row>
20468
20469
<row>
20469
20470
<entry>
20470
20471
<literal><function>cfs_enable_gc(enabled boolean)</function></literal>
20471
20472
</entry>
20472
20473
<entry><type>boolean</type></entry>
20473
- <entry>Enable or disable background GC (also can be done using <xref linkend="guc-cfs-gc"> configuation variable) .
20474
+ <entry>Enables/disables background garbage collection. Alternatively, you can use the <xref linkend="guc-cfs-gc"> configuration variable.
20474
20475
</entry>
20475
20476
</row>
20476
20477
<row>
20477
20478
<entry>
20478
20479
<literal><function>cfs_gc_relation(rel regclass)</function></literal>
20479
20480
</entry>
20480
20481
<entry><type>integer</type></entry>
20481
- <entry>Perform garbage collection of particular table. Returns number of processed segments.
20482
+ <entry>Performs garbage collection for a particular table. This function returns the number of processed segments.
20482
20483
</entry>
20483
20484
</row>
20484
20485
<row>
20485
20486
<entry>
20486
20487
<literal><function>cfs_version()</function></literal>
20487
20488
</entry>
20488
20489
<entry><type>text</type></entry>
20489
- <entry>CFS version and used compression algorithm.
20490
+ <entry>Displays the CFS version and the specific compression algorithm used .
20490
20491
</entry>
20491
20492
</row>
20492
20493
<row>
20493
20494
<entry>
20494
20495
<literal><function>cfs_estimate(rel regclass)</function></literal>
20495
20496
</entry>
20496
20497
<entry><type>float8</type></entry>
20497
- <entry>Estimate effect of table compression. Returns average compress ratio for first ten blocks of the relation.
20498
+ <entry>Estimates the effect of table compression. Returns the average compression ratio for the first ten blocks of the relation.
20498
20499
</entry>
20499
20500
</row>
20500
20501
<row>
20501
20502
<entry>
20502
20503
<literal><function>cfs_compression_ratio(rel regclass)</function></literal>
20503
20504
</entry>
20504
20505
<entry><type>float8</type></entry>
20505
- <entry>Returns real compression ration for all segments of the compressed relation.
20506
+ <entry>Returns the actual compression ratio for all segments of the compressed relation.
20506
20507
</entry>
20507
20508
</row>
20508
20509
<row>
20509
20510
<entry>
20510
20511
<literal><function>cfs_fragmentation(rel regclass)</function></literal>
20511
20512
</entry>
20512
20513
<entry><type>float8</type></entry>
20513
- <entry>Returns average fragmentation of the relation files.
20514
+ <entry>Returns the average fragmentation ratio of the relation files.
20514
20515
</entry>
20515
20516
</row>
20516
20517
<row>
20517
20518
<entry>
20518
20519
<literal><function>cfs_gc_activity_processed_bytes()</function></literal>
20519
20520
</entry>
20520
20521
<entry><type>int64</type></entry>
20521
- <entry>Returns total size of pages transferred by CFS during garbage collection.
20522
+ <entry>Returns the total size of pages processed by CFS during garbage collection.
20522
20523
</entry>
20523
20524
</row>
20524
20525
<row>
20525
20526
<entry>
20526
20527
<literal><function>cfs_gc_activity_processed_pages()</function></literal>
20527
20528
</entry>
20528
20529
<entry><type>int64</type></entry>
20529
- <entry>Returns number of pages transferred by CFS during garbage collection.
20530
+ <entry>Returns the number of pages processed by CFS during garbage collection.
20530
20531
</entry>
20531
20532
</row>
20532
20533
<row>
20533
20534
<entry>
20534
20535
<literal><function>cfs_gc_activity_processed_files()</function></literal>
20535
20536
</entry>
20536
20537
<entry><type>int64</type></entry>
20537
- <entry>Returns number of files compacted by CFS during garbage collection.
20538
+ <entry>Returns the number of files compacted by CFS during garbage collection.
20538
20539
</entry>
20539
20540
</row>
20540
20541
<row>
20541
20542
<entry>
20542
20543
<literal><function>cfs_gc_activity_scanned_files()</function></literal>
20543
20544
</entry>
20544
20545
<entry><type>int64</type></entry>
20545
- <entry>Returns number of files scanned by CFS during garbage collection.
20546
+ <entry>Returns the number of files scanned by CFS during garbage collection.
20546
20547
</entry>
20547
20548
</row>
20548
20549
</tbody>
0 commit comments