Skip to content

Commit

Permalink
[Uniform] update documentation to explicitly enable column mapping be…
Browse files Browse the repository at this point in the history
…fore REORG

update Uniform documentation for explicitly enable column mapping during REORG
  • Loading branch information
lzlfred authored Jan 31, 2024
1 parent 50121df commit 4308771
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/delta-uniform.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,12 @@ CREATE TABLE T(c1 INT) USING DELTA TBLPROPERTIES(

You can enable UniForm on an existing table using the following syntax:

.. note:: This syntax also works to upgrade from the IcbergCompatV1. It may rewrite existing files to make those Iceberg compatible, and it automatically disables and purges Deletion Vectors from the table

```sql
REORG TABLE table_name APPLY (UPGRADE UNIFORM(ICEBERG_COMPAT_VERSION=2));
```
.. note:: This syntax requires [_](delta-column-mapping.md) to be enabled on the table prior to running. This syntax also works to upgrade from the IcbergCompatV1. It may rewrite existing files to make those Iceberg compatible, and it automatically disables and purges Deletion Vectors from the table.

.. important:: When you first enable UniForm, asynchronous metadata generation begins. This task must complete before external clients can query the table using Iceberg. See [_](#status).

.. warning:: You can turn off UniForm by unsetting the `delta.universalFormat.enabledFormats` table property. You cannot turn off column mapping once enabled, and upgrades to <Delta> reader and writer protocol versions cannot be undone.
Expand Down

0 comments on commit 4308771

Please sign in to comment.