Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Add missing documentation for the 'migrate_iceberg_table' command #5072

Closed
wants to merge 1 commit into from
Closed

[doc] Add missing documentation for the 'migrate_iceberg_table' command #5072

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions docs/content/flink/procedures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,7 @@ All available procedures are listed below.
<tr>
<td>refresh_object_table</td>
<td>
CALL sys.refresh_object_table('identifier')
CALL [catalog.]sys.refresh_object_table('identifier')
</td>
<td>
To refresh_object_table a object table. Arguments:
Expand All @@ -671,7 +671,7 @@ All available procedures are listed below.
<tr>
<td>compact_manifest</td>
<td>
CALL sys.compact_manifest(`table` => 'identifier')
CALL [catalog.]sys.compact_manifest(`table` => 'identifier')
</td>
<td>
To compact_manifest the manifests. Arguments:
Expand All @@ -681,5 +681,34 @@ All available procedures are listed below.
CALL sys.compact_manifest(`table` => 'default.T')
</td>
</tr>
<tr>
<td>migrate_iceberg_table</td>
<td>
-- Use named argument<br/>
CALL [catalog.]sys.migrate_iceberg_table(<br/>
`source_table` => 'identifier',<br/>
`iceberg_options` => 'iceberg options',<br/>
`options` =>'table options',<br/>
`parallelism` => 'the parallelism of migrate process')<br/><br/>
-- Use indexed argument<br/>
CALL [catalog.]sys.migrate_iceberg_table('source_table') <br/><br/>
CALL [catalog.]sys.migrate_iceberg_table('source_table', 'iceberg_options') <br/><br/>
CALL [catalog.]sys.migrate_iceberg_table('source_table', 'iceberg_options', 'options') <br/><br/>
CALL [catalog.]sys.migrate_iceberg_table('source_table', 'iceberg_options', 'options', 'parallelism') <br/><br/>
</td>
<td>
To migrate_iceberg_table iceberg table to paimon table. Arguments:
<li>source_table(required): name of the origin table to migrate. Cannot be empty.</li>
<li>iceberg_options(optional): the table options of the iceberg table to migrate.</li>
<li>options(optional): the core options.See its <a href="https://paimon.apache.org/docs/master/maintenance/configurations/#coreoptions">document</a> for a complete list of configurations.</li>
<li>parallelism(optional): number of parallelisms to migrate iceberg tables.</li>
</td>
<td>
-- for hive-catalog<br/><br/>
CALL sys.migrate_iceberg_table(`source_table` => 'default.T', `iceberg_options` => 'metadata.iceberg.storage=hive-catalog,metadata.iceberg.uri=thrift://localhost:9083', `options` => 'file.format=parquet', `parallelism` => 5)<br/><br/>
-- for hadoop-catalog<br/><br/>
CALL sys.migrate_iceberg_table(`source_table` => 'default.T', `iceberg_options` => 'metadata.iceberg.storage=hadoop-catalog,iceberg_warehouse=hdfs:///path/to/iceberg/warehouse', `options` => 'file.format=parquet', `parallelism` => 5)<br/><br/>
</td>
</tr>
</tbody>
</table>