Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 8298880

Browse files
author
Liudmila Mantrova
committed
DOC: sync CFS function descriptions with PGPROEE9_6 state
1 parent ace8eb1 commit 8298880

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

doc/src/sgml/func.sgml

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20405,7 +20405,6 @@ SELECT (pg_stat_file('filename')).modification;
2040520405
</para>
2040620406

2040720407
</sect2>
20408-
2040920408
<sect2 id="functions-compression-control">
2041020409
<title>Compression Control Functions</title>
2041120410

@@ -20462,87 +20461,89 @@ SELECT (pg_stat_file('filename')).modification;
2046220461
<literal><function>cfs_start_gc(n_workers integer)</function></literal>
2046320462
</entry>
2046420463
<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.
2046620467
</entry>
2046720468
</row>
2046820469
<row>
2046920470
<entry>
2047020471
<literal><function>cfs_enable_gc(enabled boolean)</function></literal>
2047120472
</entry>
2047220473
<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.
2047420475
</entry>
2047520476
</row>
2047620477
<row>
2047720478
<entry>
2047820479
<literal><function>cfs_gc_relation(rel regclass)</function></literal>
2047920480
</entry>
2048020481
<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.
2048220483
</entry>
2048320484
</row>
2048420485
<row>
2048520486
<entry>
2048620487
<literal><function>cfs_version()</function></literal>
2048720488
</entry>
2048820489
<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.
2049020491
</entry>
2049120492
</row>
2049220493
<row>
2049320494
<entry>
2049420495
<literal><function>cfs_estimate(rel regclass)</function></literal>
2049520496
</entry>
2049620497
<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.
2049820499
</entry>
2049920500
</row>
2050020501
<row>
2050120502
<entry>
2050220503
<literal><function>cfs_compression_ratio(rel regclass)</function></literal>
2050320504
</entry>
2050420505
<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.
2050620507
</entry>
2050720508
</row>
2050820509
<row>
2050920510
<entry>
2051020511
<literal><function>cfs_fragmentation(rel regclass)</function></literal>
2051120512
</entry>
2051220513
<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.
2051420515
</entry>
2051520516
</row>
2051620517
<row>
2051720518
<entry>
2051820519
<literal><function>cfs_gc_activity_processed_bytes()</function></literal>
2051920520
</entry>
2052020521
<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.
2052220523
</entry>
2052320524
</row>
2052420525
<row>
2052520526
<entry>
2052620527
<literal><function>cfs_gc_activity_processed_pages()</function></literal>
2052720528
</entry>
2052820529
<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.
2053020531
</entry>
2053120532
</row>
2053220533
<row>
2053320534
<entry>
2053420535
<literal><function>cfs_gc_activity_processed_files()</function></literal>
2053520536
</entry>
2053620537
<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.
2053820539
</entry>
2053920540
</row>
2054020541
<row>
2054120542
<entry>
2054220543
<literal><function>cfs_gc_activity_scanned_files()</function></literal>
2054320544
</entry>
2054420545
<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.
2054620547
</entry>
2054720548
</row>
2054820549
</tbody>

0 commit comments

Comments
 (0)