Skip to content

Commit 0c07143

Browse files
authored
[doc] Add catalog prefix to Flink procedure (#5166)
1 parent 6cea5f7 commit 0c07143

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

docs/content/flink/procedures.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -273,13 +273,13 @@ All available procedures are listed below.
273273
<td>merge_into</td>
274274
<td>
275275
-- for Flink 1.18<br/>
276-
CALL [catalog].sys.merge_into('identifier','targetAlias',<br/>
276+
CALL [catalog.]sys.merge_into('identifier','targetAlias',<br/>
277277
'sourceSqls','sourceTable','mergeCondition',<br/>
278278
'matchedUpsertCondition','matchedUpsertSetting',<br/>
279279
'notMatchedInsertCondition','notMatchedInsertValues',<br/>
280280
'matchedDeleteCondition')<br/><br/>
281281
-- for Flink 1.19 and later <br/>
282-
CALL [catalog].sys.merge_into(<br/>
282+
CALL [catalog.]sys.merge_into(<br/>
283283
target_table => 'identifier',<br/>
284284
target_alias => 'targetAlias',<br/>
285285
source_sqls => 'sourceSqls',<br/>
@@ -305,7 +305,7 @@ All available procedures are listed below.
305305
-- insert the order from<br/>
306306
-- the source table<br/>
307307
-- for Flink 1.18<br/>
308-
CALL [catalog].sys.merge_into('default.T','','','default.S','T.id=S.order_id','','price=T.price+20','','*','')<br/><br/>
308+
CALL sys.merge_into('default.T','','','default.S','T.id=S.order_id','','price=T.price+20','','*','')<br/><br/>
309309
-- for Flink 1.19 and later <br/>
310310
CALL sys.merge_into(<br/>
311311
target_table => 'default.T',<br/>
@@ -418,14 +418,14 @@ All available procedures are listed below.
418418
<td>
419419
-- for Flink 1.18<br/>
420420
-- rollback to a snapshot<br/>
421-
CALL sys.rollback_to('identifier', snapshotId)<br/><br/>
421+
CALL [catalog.]sys.rollback_to('identifier', snapshotId)<br/><br/>
422422
-- rollback to a tag<br/>
423-
CALL sys.rollback_to('identifier', 'tagName')<br/><br/>
423+
CALL [catalog.]sys.rollback_to('identifier', 'tagName')<br/><br/>
424424
-- for Flink 1.19 and later<br/>
425425
-- rollback to a snapshot<br/>
426-
CALL sys.rollback_to(`table` => 'identifier', snapshot_id => snapshotId)<br/><br/>
426+
CALL [catalog.]sys.rollback_to(`table` => 'identifier', snapshot_id => snapshotId)<br/><br/>
427427
-- rollback to a tag<br/>
428-
CALL sys.rollback_to(`table` => 'identifier', tag => 'tagName')
428+
CALL [catalog.]sys.rollback_to(`table` => 'identifier', tag => 'tagName')
429429
</td>
430430
<td>
431431
To rollback to a specific version of target table. Argument:
@@ -445,10 +445,10 @@ All available procedures are listed below.
445445
<td>
446446
-- for Flink 1.18<br/>
447447
-- rollback to the snapshot which earlier or equal than timestamp.<br/>
448-
CALL sys.rollback_to_timestamp('identifier', timestamp)<br/><br/>
448+
CALL [catalog.]sys.rollback_to_timestamp('identifier', timestamp)<br/><br/>
449449
-- for Flink 1.19 and later<br/>
450450
-- rollback to the snapshot which earlier or equal than timestamp.<br/>
451-
CALL sys.rollback_to_timestamp(`table` => 'default.T', `timestamp` => timestamp)<br/><br/>
451+
CALL [catalog.]sys.rollback_to_timestamp(`table` => 'default.T', `timestamp` => timestamp)<br/><br/>
452452
</td>
453453
<td>
454454
To rollback to the snapshot which earlier or equal than timestamp. Argument:
@@ -467,10 +467,10 @@ All available procedures are listed below.
467467
<td>
468468
-- for Flink 1.18<br/>
469469
-- rollback to the snapshot which earlier or equal than watermark.<br/>
470-
CALL sys.rollback_to_watermark('identifier', watermark)<br/><br/>
470+
CALL [catalog.]sys.rollback_to_watermark('identifier', watermark)<br/><br/>
471471
-- for Flink 1.19 and later<br/>
472472
-- rollback to the snapshot which earlier or equal than watermark.<br/>
473-
CALL sys.rollback_to_watermark(`table` => 'default.T', `watermark` => watermark)<br/><br/>
473+
CALL [catalog.]sys.rollback_to_watermark(`table` => 'default.T', `watermark` => watermark)<br/><br/>
474474
</td>
475475
<td>
476476
To rollback to the snapshot which earlier or equal than watermark. Argument:
@@ -489,10 +489,10 @@ All available procedures are listed below.
489489
<td>
490490
-- for Flink 1.18<br/>
491491
-- clear table with purge files directly.<br/>
492-
CALL sys.purge_files('identifier')<br/><br/>
492+
CALL [catalog.]sys.purge_files('identifier')<br/><br/>
493493
-- for Flink 1.19 and later<br/>
494494
-- clear table with purge files directly.<br/>
495-
CALL sys.purge_files(`table` => 'default.T')<br/><br/>
495+
CALL [catalog.]sys.purge_files(`table` => 'default.T')<br/><br/>
496496
</td>
497497
<td>
498498
To clear table with purge files directly. Argument:
@@ -510,10 +510,10 @@ All available procedures are listed below.
510510
<td>
511511
-- for Flink 1.18<br/>
512512
-- migrate all hive tables in database to paimon tables.<br/>
513-
CALL [catalog].sys.migrate_database('connector', 'dbIdentifier', 'options'[, &ltparallelism&gt])<br/><br/>
513+
CALL [catalog.]sys.migrate_database('connector', 'dbIdentifier', 'options'[, &ltparallelism&gt])<br/><br/>
514514
-- for Flink 1.19 and later<br/>
515515
-- migrate all hive tables in database to paimon tables.<br/>
516-
CALL [catalog].sys.migrate_database(connector => 'connector', source_database => 'dbIdentifier', options => 'options'[, &ltparallelism => parallelism&gt])<br/><br/>
516+
CALL [catalog.]sys.migrate_database(connector => 'connector', source_database => 'dbIdentifier', options => 'options'[, &ltparallelism => parallelism&gt])<br/><br/>
517517
</td>
518518
<td>
519519
To migrate all hive tables in database to paimon table. Argument:
@@ -534,10 +534,10 @@ All available procedures are listed below.
534534
<td>
535535
-- for Flink 1.18<br/>
536536
-- migrate hive table to a paimon table.<br/>
537-
CALL [catalog].sys.migrate_table('connector', 'tableIdentifier', 'options'[, &ltparallelism&gt])<br/><br/>
537+
CALL [catalog.]sys.migrate_table('connector', 'tableIdentifier', 'options'[, &ltparallelism&gt])<br/><br/>
538538
-- for Flink 1.19 and later<br/>
539539
-- migrate hive table to a paimon table.<br/>
540-
CALL [catalog].sys.migrate_table(connector => 'connector', source_table => 'tableIdentifier', options => 'options'[, &ltparallelism => parallelism&gt])<br/><br/>
540+
CALL [catalog.]sys.migrate_table(connector => 'connector', source_table => 'tableIdentifier', options => 'options'[, &ltparallelism => parallelism&gt])<br/><br/>
541541
</td>
542542
<td>
543543
To migrate hive table to a paimon table. Argument:
@@ -558,10 +558,10 @@ All available procedures are listed below.
558558
<td>
559559
-- for Flink 1.18<br/>
560560
-- migrate files from hive table to a paimon table.<br/>
561-
CALL [catalog].sys.migrate_file('connector', 'srcTableIdentifier', 'destTableIdentifier', [, &ltdelete_origin&gt, &ltparallelism&gt])<br/><br/>
561+
CALL [catalog.]sys.migrate_file('connector', 'srcTableIdentifier', 'destTableIdentifier', [, &ltdelete_origin&gt, &ltparallelism&gt])<br/><br/>
562562
-- for Flink 1.19 and later<br/>
563563
-- migrate hive table to a paimon table.<br/>
564-
CALL [catalog].sys.migrate_file(connector => 'connector', source_table => 'srcTableIdentifier', target_table => 'destTableIdentifier'[, &ltdelete_origin => bool&gt, &ltparallelism => parallelism&gt])<br/><br/>
564+
CALL [catalog.]sys.migrate_file(connector => 'connector', source_table => 'srcTableIdentifier', target_table => 'destTableIdentifier'[, &ltdelete_origin => bool&gt, &ltparallelism => parallelism&gt])<br/><br/>
565565
</td>
566566
<td>
567567
To migrate files from hive table to a paimon table. Argument:
@@ -590,9 +590,9 @@ All available procedures are listed below.
590590
max_deletes => 'max_deletes') <br/><br/>
591591
-- Use indexed argument<br/>
592592
-- for Flink 1.18<br/>
593-
CALL sys.expire_snapshots(table, retain_max)<br/><br/>
593+
CALL [catalog.]sys.expire_snapshots(table, retain_max)<br/><br/>
594594
-- for Flink 1.19 and later<br/>
595-
CALL sys.expire_snapshots(table, retain_max, retain_min, older_than, max_deletes)<br/><br/>
595+
CALL [catalog.]sys.expire_snapshots(table, retain_max, retain_min, older_than, max_deletes)<br/><br/>
596596
</td>
597597
<td>
598598
To expire snapshots. Argument:
@@ -615,7 +615,7 @@ All available procedures are listed below.
615615
<tr>
616616
<td>expire_partitions</td>
617617
<td>
618-
CALL sys.expire_partitions(table, expiration_time, timestamp_formatter, expire_strategy)<br/><br/>
618+
CALL [catalog.]sys.expire_partitions(table, expiration_time, timestamp_formatter, expire_strategy)<br/><br/>
619619
</td>
620620
<td>
621621
To expire partitions. Argument:
@@ -637,13 +637,13 @@ All available procedures are listed below.
637637
<td>repair</td>
638638
<td>
639639
-- repair all databases and tables in catalog<br/>
640-
CALL sys.repair()<br/><br/>
640+
CALL [catalog.]sys.repair()<br/><br/>
641641
-- repair all tables in a specific database<br/>
642-
CALL sys.repair('databaseName')<br/><br/>
642+
CALL [catalog.]sys.repair('databaseName')<br/><br/>
643643
-- repair a table<br/>
644-
CALL sys.repair('databaseName.tableName')<br/><br/>
644+
CALL [catalog.]sys.repair('databaseName.tableName')<br/><br/>
645645
-- repair database and table in a string if you specify multiple tags, delimiter is ','<br/>
646-
CALL sys.repair('databaseName01,database02.tableName01,database03')
646+
CALL [catalog.]sys.repair('databaseName01,database02.tableName01,database03')
647647
</td>
648648
<td>
649649
Synchronize information from the file system to Metastore. Argument:
@@ -657,9 +657,9 @@ All available procedures are listed below.
657657
<td>rewrite_file_index</td>
658658
<td>
659659
-- Use named argument<br/>
660-
CALL sys.rewrite_file_index(&lt`table` => identifier&gt [, &ltpartitions => partitions&gt])<br/><br/>
660+
CALL [catalog.]sys.rewrite_file_index(&lt`table` => identifier&gt [, &ltpartitions => partitions&gt])<br/><br/>
661661
-- Use indexed argument<br/>
662-
CALL sys.rewrite_file_index(&ltidentifier&gt [, &ltpartitions&gt])<br/><br/>
662+
CALL [catalog.]sys.rewrite_file_index(&ltidentifier&gt [, &ltpartitions&gt])<br/><br/>
663663
</td>
664664
<td>
665665
Rewrite the file index for the table. Argument:
@@ -731,7 +731,7 @@ All available procedures are listed below.
731731
<tr>
732732
<td>refresh_object_table</td>
733733
<td>
734-
CALL sys.refresh_object_table('identifier')
734+
CALL [catalog.]sys.refresh_object_table('identifier')
735735
</td>
736736
<td>
737737
To refresh_object_table a object table. Arguments:
@@ -744,7 +744,7 @@ All available procedures are listed below.
744744
<tr>
745745
<td>compact_manifest</td>
746746
<td>
747-
CALL sys.compact_manifest(`table` => 'identifier')
747+
CALL [catalog.]sys.compact_manifest(`table` => 'identifier')
748748
</td>
749749
<td>
750750
To compact_manifest the manifests. Arguments:
@@ -757,7 +757,7 @@ All available procedures are listed below.
757757
<tr>
758758
<td>rescale</td>
759759
<td>
760-
CALL sys.rescale(`table` => 'identifier', `bucket_num` => bucket_num, `partition` => 'partition')
760+
CALL [catalog.]sys.rescale(`table` => 'identifier', `bucket_num` => bucket_num, `partition` => 'partition')
761761
</td>
762762
<td>
763763
Rescale one partition of a table. Arguments:

0 commit comments

Comments
 (0)