Skip to content

Commit 4b26f9a

Browse files
liyubin117liyubin117
authored
[doc] Fix line layout to enhance readability (#5330)
1 parent ef1715e commit 4b26f9a

File tree

2 files changed

+54
-56
lines changed

2 files changed

+54
-56
lines changed

‎docs/content/flink/procedures.md‎

Lines changed: 50 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,13 @@ All available procedures are listed below.
7070
partition_idle_time => 'partition_idle_time',
7171
compact_strategy => 'compact_strategy') <br/><br/>
7272
-- Use indexed argument<br/>
73-
CALL [catalog.]sys.compact('table') <br/><br/>
74-
CALL [catalog.]sys.compact('table', 'partitions') <br/><br/>
75-
CALL [catalog.]sys.compact('table', 'order_strategy', 'order_by') <br/><br/>
76-
CALL [catalog.]sys.compact('table', 'partitions', 'order_strategy', 'order_by') <br/><br/>
77-
CALL [catalog.]sys.compact('table', 'partitions', 'order_strategy', 'order_by', 'options') <br/><br/>
78-
CALL [catalog.]sys.compact('table', 'partitions', 'order_strategy', 'order_by', 'options', 'where') <br/><br/>
79-
CALL [catalog.]sys.compact('table', 'partitions', 'order_strategy', 'order_by', 'options', 'where', 'partition_idle_time') <br/><br/>
73+
CALL [catalog.]sys.compact('table') <br/>
74+
CALL [catalog.]sys.compact('table', 'partitions') <br/>
75+
CALL [catalog.]sys.compact('table', 'order_strategy', 'order_by') <br/>
76+
CALL [catalog.]sys.compact('table', 'partitions', 'order_strategy', 'order_by') <br/>
77+
CALL [catalog.]sys.compact('table', 'partitions', 'order_strategy', 'order_by', 'options') <br/>
78+
CALL [catalog.]sys.compact('table', 'partitions', 'order_strategy', 'order_by', 'options', 'where') <br/>
79+
CALL [catalog.]sys.compact('table', 'partitions', 'order_strategy', 'order_by', 'options', 'where', 'partition_idle_time') <br/>
8080
CALL [catalog.]sys.compact('table', 'partitions', 'order_strategy', 'order_by', 'options', 'where', 'partition_idle_time', 'compact_strategy') <br/><br/>
8181
</td>
8282
<td>
@@ -92,7 +92,7 @@ All available procedures are listed below.
9292
</td>
9393
<td>
9494
-- use partition filter <br/>
95-
CALL sys.compact(`table` => 'default.T', partitions => 'p=0', order_strategy => 'zorder', order_by => 'a,b', options => 'sink.parallelism=4') <br/>
95+
CALL sys.compact(`table` => 'default.T', partitions => 'p=0', order_strategy => 'zorder', order_by => 'a,b', options => 'sink.parallelism=4') <br/><br/>
9696
-- use partition predicate <br/>
9797
CALL sys.compact(`table` => 'default.T', `where` => 'dt>10 and h<20', order_strategy => 'zorder', order_by => 'a,b', options => 'sink.parallelism=4')
9898
</td>
@@ -110,14 +110,14 @@ All available procedures are listed below.
110110
partition_idle_time => 'partitionIdleTime',
111111
compact_strategy => 'compact_strategy') <br/><br/>
112112
-- Use indexed argument<br/>
113-
CALL [catalog.]sys.compact_database() <br/><br/>
114-
CALL [catalog.]sys.compact_database('includingDatabases') <br/><br/>
115-
CALL [catalog.]sys.compact_database('includingDatabases', 'mode') <br/><br/>
116-
CALL [catalog.]sys.compact_database('includingDatabases', 'mode', 'includingTables') <br/><br/>
117-
CALL [catalog.]sys.compact_database('includingDatabases', 'mode', 'includingTables', 'excludingTables') <br/><br/>
118-
CALL [catalog.]sys.compact_database('includingDatabases', 'mode', 'includingTables', 'excludingTables', 'tableOptions') <br/><br/>
119-
CALL [catalog.]sys.compact_database('includingDatabases', 'mode', 'includingTables', 'excludingTables', 'tableOptions', 'partitionIdleTime')<br/><br/>
120-
CALL [catalog.]sys.compact_database('includingDatabases', 'mode', 'includingTables', 'excludingTables', 'tableOptions', 'partitionIdleTime', 'compact_strategy')<br/><br/>
113+
CALL [catalog.]sys.compact_database() <br/>
114+
CALL [catalog.]sys.compact_database('includingDatabases') <br/>
115+
CALL [catalog.]sys.compact_database('includingDatabases', 'mode') <br/>
116+
CALL [catalog.]sys.compact_database('includingDatabases', 'mode', 'includingTables') <br/>
117+
CALL [catalog.]sys.compact_database('includingDatabases', 'mode', 'includingTables', 'excludingTables') <br/>
118+
CALL [catalog.]sys.compact_database('includingDatabases', 'mode', 'includingTables', 'excludingTables', 'tableOptions') <br/>
119+
CALL [catalog.]sys.compact_database('includingDatabases', 'mode', 'includingTables', 'excludingTables', 'tableOptions', 'partitionIdleTime')<br/>
120+
CALL [catalog.]sys.compact_database('includingDatabases', 'mode', 'includingTables', 'excludingTables', 'tableOptions', 'partitionIdleTime', 'compact_strategy')
121121
</td>
122122
<td>
123123
To compact databases. Arguments:
@@ -184,7 +184,7 @@ All available procedures are listed below.
184184
</td>
185185
<td>
186186
-- for Flink 1.18<br/>
187-
CALL sys.create_tag_from_timestamp('default.T', 'my_tag', 1724404318750, '1 d')
187+
CALL sys.create_tag_from_timestamp('default.T', 'my_tag', 1724404318750, '1 d')<br/><br/>
188188
-- for Flink 1.19 and later<br/>
189189
CALL sys.create_tag_from_timestamp(`table` => 'default.T', `tag` => 'my_tag', `timestamp` => 1724404318750, time_retained => '1 d')
190190
</td>
@@ -207,7 +207,7 @@ All available procedures are listed below.
207207
</td>
208208
<td>
209209
-- for Flink 1.18<br/>
210-
CALL sys.create_tag_from_watermark('default.T', 'my_tag', 1724404318750, '1 d')
210+
CALL sys.create_tag_from_watermark('default.T', 'my_tag', 1724404318750, '1 d')<br/><br/>
211211
-- for Flink 1.19 and later<br/>
212212
CALL sys.create_tag_from_watermark(`table` => 'default.T', `tag` => 'my_tag', `watermark` => 1724404318750, time_retained => '1 d')
213213
</td>
@@ -252,7 +252,7 @@ All available procedures are listed below.
252252
-- for Flink 1.18<br/>
253253
CALL sys.replace_tag('default.T', 'my_tag', 5, '1 d')<br/><br/>
254254
-- for Flink 1.19 and later<br/>
255-
CALL sys.replace_tag(`table` => 'default.T', tag => 'my_tag', snapshot_id => 5, time_retained => '1 d')<br/><br/>
255+
CALL sys.replace_tag(`table` => 'default.T', tag => 'my_tag', snapshot_id => 5, time_retained => '1 d')<br/>
256256
</td>
257257
</tr>
258258
<tr>
@@ -321,10 +321,10 @@ All available procedures are listed below.
321321
-- Use named argument<br/>
322322
CALL [catalog.]sys.remove_orphan_files(`table` => 'identifier', older_than => 'olderThan', dry_run => 'dryRun', mode => 'mode') <br/><br/>
323323
-- Use indexed argument<br/>
324-
CALL [catalog.]sys.remove_orphan_files('identifier')<br/><br/>
325-
CALL [catalog.]sys.remove_orphan_files('identifier', 'olderThan')<br/><br/>
326-
CALL [catalog.]sys.remove_orphan_files('identifier', 'olderThan', 'dryRun')<br/><br/>
327-
CALL [catalog.]sys.remove_orphan_files('identifier', 'olderThan', 'dryRun','parallelism')<br/><br/>
324+
CALL [catalog.]sys.remove_orphan_files('identifier')<br/>
325+
CALL [catalog.]sys.remove_orphan_files('identifier', 'olderThan')<br/>
326+
CALL [catalog.]sys.remove_orphan_files('identifier', 'olderThan', 'dryRun')<br/>
327+
CALL [catalog.]sys.remove_orphan_files('identifier', 'olderThan', 'dryRun','parallelism')<br/>
328328
CALL [catalog.]sys.remove_orphan_files('identifier', 'olderThan', 'dryRun','parallelism','mode')
329329
</td>
330330
<td>
@@ -350,7 +350,7 @@ All available procedures are listed below.
350350
-- Use named argument<br/>
351351
CALL [catalog.]sys.remove_unexisting_files(`table` => 'identifier', dry_run => 'dryRun', parallelism => 'parallelism') <br/><br/>
352352
-- Use indexed argument<br/>
353-
CALL [catalog.]sys.remove_unexisting_files('identifier')<br/><br/>
353+
CALL [catalog.]sys.remove_unexisting_files('identifier')<br/>
354354
CALL [catalog.]sys.remove_unexisting_files('identifier', 'dryRun', 'parallelism')
355355
</td>
356356
<td>
@@ -362,9 +362,8 @@ All available procedures are listed below.
362362
Note that user is on his own risk using this procedure, which may cause data loss when used outside from the use cases listed in Java docs.
363363
</td>
364364
<td>
365-
-- remove unexisting data files in the table `mydb.myt`
366-
CALL sys.remove_unexisting_files(`table` => 'mydb.myt')
367-
<br>
365+
-- remove unexisting data files in the table `mydb.myt`<br/>
366+
CALL sys.remove_unexisting_files(`table` => 'mydb.myt')<br/><br/>
368367
-- only check what files will be removed, but not really remove them (dry run)
369368
CALL sys.remove_unexisting_files(`table` => 'mydb.myt', `dry_run` = true)
370369
</td>
@@ -394,8 +393,8 @@ All available procedures are listed below.
394393
-- Use named argument<br/>
395394
CALL [catalog.]sys.clear_consumers(`table` => 'identifier', including_consumers => 'includingConsumers', excluding_consumers => 'excludingConsumers') <br/><br/>
396395
-- Use indexed argument<br/>
397-
-- clear all consumers in the table
398-
CALL [catalog.]sys.clear_consumers('identifier')
396+
-- clear all consumers in the table<br/>
397+
CALL [catalog.]sys.clear_consumers('identifier')<br/><br/>
399398
-- clear some consumers in the table (accept regular expression)<br/>
400399
CALL [catalog.]sys.clear_consumers('identifier', 'includingConsumers')<br/><br/>
401400
-- exclude some consumers (accept regular expression)<br/>
@@ -435,7 +434,7 @@ All available procedures are listed below.
435434
</td>
436435
<td>
437436
-- for Flink 1.18<br/>
438-
CALL sys.rollback_to('default.T', 10)
437+
CALL sys.rollback_to('default.T', 10)<br/><br/>
439438
-- for Flink 1.19 and later<br/>
440439
CALL sys.rollback_to(`table` => 'default.T', snapshot_id => 10)
441440
</td>
@@ -457,7 +456,7 @@ All available procedures are listed below.
457456
</td>
458457
<td>
459458
-- for Flink 1.18<br/>
460-
CALL sys.rollback_to_timestamp('default.T', 10)
459+
CALL sys.rollback_to_timestamp('default.T', 10)<br/><br/>
461460
-- for Flink 1.19 and later<br/>
462461
CALL sys.rollback_to_timestamp(`table` => 'default.T', timestamp => 1730292023000)
463462
</td>
@@ -479,7 +478,7 @@ All available procedures are listed below.
479478
</td>
480479
<td>
481480
-- for Flink 1.18<br/>
482-
CALL sys.rollback_to_watermark('default.T', 1730292023000)
481+
CALL sys.rollback_to_watermark('default.T', 1730292023000)<br/><br/>
483482
-- for Flink 1.19 and later<br/>
484483
CALL sys.rollback_to_watermark(`table` => 'default.T', watermark => 1730292023000)
485484
</td>
@@ -500,7 +499,7 @@ All available procedures are listed below.
500499
</td>
501500
<td>
502501
-- for Flink 1.18<br/>
503-
CALL sys.purge_files('default.T')
502+
CALL sys.purge_files('default.T')<br/><br/>
504503
-- for Flink 1.19 and later<br/>
505504
CALL sys.purge_files(`table` => 'default.T')
506505
</td>
@@ -524,7 +523,7 @@ All available procedures are listed below.
524523
</td>
525524
<td>
526525
-- for Flink 1.18<br/>
527-
CALL sys.migrate_database('hive', 'db01', 'file.format=parquet', 6)
526+
CALL sys.migrate_database('hive', 'db01', 'file.format=parquet', 6)<br/><br/>
528527
-- for Flink 1.19 and later<br/>
529528
CALL sys.migrate_database(connector => 'hive', source_database => 'db01', options => 'file.format=parquet', parallelism => 6)
530529
</td>
@@ -592,13 +591,13 @@ All available procedures are listed below.
592591
<li>max_deletes: the maximum number of snapshots that can be deleted at once.</li>
593592
</td>
594593
<td>
595-
-- for Flink 1.18<br/><br/>
594+
-- for Flink 1.18<br/>
596595
CALL sys.expire_snapshots('default.T', 2)<br/><br/>
597-
-- for Flink 1.19 and later<br/><br/>
598-
CALL sys.expire_snapshots(`table` => 'default.T', retain_max => 2)<br/><br/>
599-
CALL sys.expire_snapshots(`table` => 'default.T', older_than => '2024-01-01 12:00:00')<br/><br/>
600-
CALL sys.expire_snapshots(`table` => 'default.T', older_than => '2024-01-01 12:00:00', retain_min => 10)<br/><br/>
601-
CALL sys.expire_snapshots(`table` => 'default.T', older_than => '2024-01-01 12:00:00', max_deletes => 10)<br/><br/>
596+
-- for Flink 1.19 and later<br/>
597+
CALL sys.expire_snapshots(`table` => 'default.T', retain_max => 2)<br/>
598+
CALL sys.expire_snapshots(`table` => 'default.T', older_than => '2024-01-01 12:00:00')<br/>
599+
CALL sys.expire_snapshots(`table` => 'default.T', older_than => '2024-01-01 12:00:00', retain_min => 10)<br/>
600+
CALL sys.expire_snapshots(`table` => 'default.T', older_than => '2024-01-01 12:00:00', max_deletes => 10)<br/>
602601
</td>
603602
</tr>
604603
<tr>
@@ -614,7 +613,7 @@ All available procedures are listed below.
614613
delete_all => 'delete_all') <br/><br/>
615614
-- Use indexed argument<br/>
616615
-- for Flink 1.18<br/>
617-
CALL [catalog.]sys.expire_changelogs(table, retain_max, retain_min, older_than, max_deletes)<br/><br/>
616+
CALL [catalog.]sys.expire_changelogs(table, retain_max, retain_min, older_than, max_deletes)<br/>
618617
CALL [catalog.]sys.expire_changelogs(table, delete_all)<br/><br/>
619618
-- for Flink 1.19 and later<br/>
620619
CALL [catalog.]sys.expire_changelogs(table, retain_max, retain_min, older_than, max_deletes, delete_all)<br/><br/>
@@ -629,15 +628,15 @@ All available procedures are listed below.
629628
<li>delete_all: whether to delete all separated changelogs.</li>
630629
</td>
631630
<td>
632-
-- for Flink 1.18<br/><br/>
633-
CALL sys.expire_changelogs('default.T', 4, 2, '2024-01-01 12:00:00', 2)<br/><br/>
631+
-- for Flink 1.18<br/>
632+
CALL sys.expire_changelogs('default.T', 4, 2, '2024-01-01 12:00:00', 2)<br/>
634633
CALL sys.expire_changelogs('default.T', true)<br/><br/>
635-
-- for Flink 1.19 and later<br/><br/>
636-
CALL sys.expire_changelogs(`table` => 'default.T', retain_max => 2)<br/><br/>
637-
CALL sys.expire_changelogs(`table` => 'default.T', older_than => '2024-01-01 12:00:00')<br/><br/>
638-
CALL sys.expire_changelogs(`table` => 'default.T', older_than => '2024-01-01 12:00:00', retain_min => 10)<br/><br/>
639-
CALL sys.expire_changelogs(`table` => 'default.T', older_than => '2024-01-01 12:00:00', max_deletes => 10)<br/><br/>
640-
CALL sys.expire_changelogs(`table` => 'default.T', delete_all => true)<br/><br/>
634+
-- for Flink 1.19 and later<br/>
635+
CALL sys.expire_changelogs(`table` => 'default.T', retain_max => 2)<br/>
636+
CALL sys.expire_changelogs(`table` => 'default.T', older_than => '2024-01-01 12:00:00')<br/>
637+
CALL sys.expire_changelogs(`table` => 'default.T', older_than => '2024-01-01 12:00:00', retain_min => 10)<br/>
638+
CALL sys.expire_changelogs(`table` => 'default.T', older_than => '2024-01-01 12:00:00', max_deletes => 10)<br/>
639+
CALL sys.expire_changelogs(`table` => 'default.T', delete_all => true)<br/>
641640
</td>
642641
</tr>
643642
<tr>
@@ -655,9 +654,9 @@ All available procedures are listed below.
655654
<li>max_expires: The maximum of limited expired partitions, it is optional.</li>
656655
</td>
657656
<td>
658-
-- for Flink 1.18<br/><br/>
657+
-- for Flink 1.18<br/>
659658
CALL sys.expire_partitions('default.T', '1 d', 'yyyy-MM-dd', '$dt', 'values-time')<br/><br/>
660-
-- for Flink 1.19 and later<br/><br/>
659+
-- for Flink 1.19 and later<br/>
661660
CALL sys.expire_partitions(`table` => 'default.T', expiration_time => '1 d', timestamp_formatter => 'yyyy-MM-dd', expire_strategy => 'values-time')<br/>
662661
CALL sys.expire_partitions(`table` => 'default.T', expiration_time => '1 d', timestamp_formatter => 'yyyy-MM-dd HH:mm', timestamp_pattern => '$dt $hm', expire_strategy => 'values-time')<br/><br/>
663662
</td>

‎docs/content/spark/procedures.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This section introduce all available spark procedures about paimon.
4242
<td>
4343
To compact files. Argument:
4444
<li>table: the target table identifier. Cannot be empty.</li>
45-
<li>partitions: partition filter. "," means "AND"<br>";" means "OR".If you want to compact one partition with date=01 and day=01, you need to write 'date=01,day=01'. Left empty for all partitions. (Can't be used together with "where")</li>
45+
<li>partitions: partition filter. the comma (",") represents "AND", the semicolon (";") represents "OR". If you want to compact one partition with date=01 and day=01, you need to write 'date=01,day=01'. Left empty for all partitions. (Can't be used together with "where")</li>
4646
<li>where: partition predicate. Left empty for all partitions. (Can't be used together with "partitions")</li>
4747
<li>order_strategy: 'order' or 'zorder' or 'hilbert' or 'none'. Left empty for 'none'.</li>
4848
<li>order_columns: the columns need to be sort. Left empty if 'order_strategy' is 'none'.</li>
@@ -260,10 +260,9 @@ This section introduce all available spark procedures about paimon.
260260
Note that user is on his own risk using this procedure, which may cause data loss when used outside from the use cases listed in Java docs.
261261
</td>
262262
<td>
263-
-- remove unexisting data files in the table `mydb.myt`
264-
CALL sys.remove_unexisting_files(table => 'mydb.myt')
265-
<br>
266-
-- only check what files will be removed, but not really remove them (dry run)
263+
-- remove unexisting data files in the table `mydb.myt`<br/>
264+
CALL sys.remove_unexisting_files(table => 'mydb.myt')<br/><br/>
265+
-- only check what files will be removed, but not really remove them (dry run)<br/>
267266
CALL sys.remove_unexisting_files(table => 'mydb.myt', dry_run = true)
268267
</td>
269268
</tr>

0 commit comments

Comments
 (0)