szehon-ho commented on code in PR #12115:
URL: https://github.com/apache/iceberg/pull/12115#discussion_r1960797057
##########
docs/docs/spark-procedures.md:
##########
@@ -972,4 +972,94 @@ CALL catalog_name.system.compute_table_stats(table =>
'my_table', snapshot_id =>
Collect statistics of the snapshot with id `snap1` of table `my_table` for
columns `col1` and `col2`
```sql
CALL catalog_name.system.compute_table_stats(table => 'my_table', snapshot_id
=> 'snap1', columns => array('col1', 'col2'));
-```
\ No newline at end of file
+```
+
+## Table Replication
+
+The `rewrite_table_path` procedure prepares an Iceberg table for copying to
another location.
+
+### `rewrite_table_path`
+
+Stages a copy of the Iceberg table's metadata files where every absolute path
source prefix is replaced by the specified target prefix.
+This can be the starting point to fully or incrementally copy an Iceberg table
to a new location.
+
+!!! info
+ This procedure only stages rewritten metadata files and prepares a list of
files to copy. The actual file copy is not included in this procedure.
+
+
+| Argument Name | Required? | default
| Type | Description
|
+|--------------------|-----------|------------------------------------------------|--------|------------------------------------------------------------------------|
+| `table` | ✔️ |
| string | Name of the table
|
+| `source_prefix` | ✔️ |
| string | The existing prefix to be replaced
|
+| `target_prefix` | ✔️ |
| string | The replacement prefix for `source_prefix`
|
+| `start_version` | | first metadata.json in table's metadata log
| string | The name or path of the chronologically first metadata.json to
rewrite |
+| `end_version` | | latest metadata.json in table's metadata
log | string | The name or path of the chronologically last metadata.json to
rewrite |
+| `staging_location` | | new directory under table's metadata
directory | string | The output location for newly rewritten metadata files
|
+
+
+#### Modes of operation
+
+* Full Rewrite: A full rewrite will rewrite all reachable metadata files (this
includes metadata.json, manifest lists, manifests, and position delete files),
and will return all reachable files in the `file_list_location`. This is the
default mode of operation for this procedure.
+
+* Incremental Rewrite: An incremental rewrite will only rewrite metadata files
added between `start_version` and `end_version`, and will only return files
added in this range in the `file_list_location`. Optionally, `start_version`
and `end_version` can be provided to limit the scope of this procedure.
Review Comment:
Discuss offline, this makes it seem like there's an optional mode within
incremental rewrite. Suggest:
```
Incremental Rewrite: Optionally, `start_version` and `end_version` can be
provided to limit the scope to an incremental rewrite. An incremental rewrite
will only rewrite metadata files added between `start_version` and
`end_version`, and will only return files added in this range in the
`file_list_location`.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
