Add policies for metadata compaction, orphan file removal and snapshot retention #969
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| { | ||
| "license": "Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)", | ||
| "$id": "https://polaris.apache.org/schemas/policies/system/metadata-compaction/2025-02-03.json", | ||
| "title": "Metadata Compaction Policy", | ||
| "description": "Inheritable Polaris policy schema for Iceberg table metadata compaction", | ||
| "type": "object", | ||
| "properties": { | ||
| "version": { | ||
| "type": "string", | ||
| "const": "2025-02-03", | ||
| "description": "Schema version" | ||
| }, | ||
| "enable": { | ||
| "type": "boolean", | ||
| "description": "Enable or disable metadata compaction." | ||
| }, | ||
| "config": { | ||
| "type": "object", | ||
| "description": "A map containing custom configuration properties. Please note that interoperability is not guaranteed.", | ||
| "additionalProperties": { | ||
| "type": ["string", "number", "boolean"] | ||
| } | ||
| } | ||
| }, | ||
| "required": ["enable"], | ||
| "additionalProperties": false, | ||
| "examples": [ | ||
| { | ||
| "version": "2025-02-03", | ||
| "enable": true, | ||
| "config": { | ||
| "spec_id": 1, | ||
| "key1": "value1" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| { | ||
| "license": "Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)", | ||
| "$id": "https://polaris.apache.org/schemas/policies/system/orphan-file-removal/2025-02-03.json", | ||
| "title": "Orphan File Removal Policy", | ||
| "description": "Inheritable Polaris policy schema for Iceberg table orphan file removal", | ||
| "type": "object", | ||
| "properties": { | ||
| "version": { | ||
| "type": "string", | ||
| "const": "2025-02-03", | ||
| "description": "Schema version" | ||
| }, | ||
| "enable": { | ||
| "type": "boolean", | ||
| "description": "Enable or disable orphan file removal." | ||
| }, | ||
| "max_orphan_file_age_in_days": { | ||
|
Member
There was a problem hiding this comment. @flyrain this also struggles me a bit, remove orphan policy can be even expressed in more than in just file age. We don't we opt for the
Contributor
Author
There was a problem hiding this comment.
Can you name them? We can put them into schema if they are commonly used, otherwise, the config map would be the best place to be.
Contributor
Author
There was a problem hiding this comment. If no extra field is suggested, we could keep it as is. |
||
| "type": "number", | ||
| "description": "Specifies the maximum age (in days) for orphaned files before they are eligible for removal." | ||
| }, | ||
| "locations": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "description": "Specifies a list of custom directories to search for files instead of the default table location. Use with caution—if set to a broad location (e.g., s3://my-bucket instead of s3://my-bucket/my-table-location), all unreferenced files in that path may be permanently deleted, including files from other tables. Following best practices, tables should be stored in separate locations to avoid accidental data loss." | ||
| }, | ||
| "config": { | ||
| "type": "object", | ||
| "description": "A map containing custom configuration properties. Note that interoperability is not guaranteed.", | ||
| "additionalProperties": { | ||
| "type": ["string", "number", "boolean"] | ||
| } | ||
| } | ||
| }, | ||
| "required": ["enable"], | ||
| "additionalProperties": false, | ||
| "examples": [ | ||
| { | ||
| "version": "2025-02-03", | ||
| "enable": true, | ||
| "max_orphan_file_age_in_days": 30, | ||
| "location": "s3://my-bucket/my-table-location", | ||
| "config": { | ||
| "prefix_mismatch_mode": "ignore", | ||
| "key1": "value1" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| { | ||
| "license": "Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)", | ||
| "$id": "https://polaris.apache.org/schemas/policies/system/snapshot-retention/2025-02-03.json", | ||
| "title": "Snapshot Retention Policy", | ||
| "description": "Inheritable Polaris policy schema for Iceberg table snapshot retention", | ||
| "type": "object", | ||
| "properties": { | ||
| "version": { | ||
| "type": "string", | ||
| "const": "2025-02-03", | ||
| "description": "Schema version" | ||
| }, | ||
| "enable": { | ||
| "type": "boolean", | ||
| "description": "Enable or disable snapshot retention." | ||
| }, | ||
| "config": { | ||
| "type": "object", | ||
| "description": "A map containing custom configuration properties. Please note that interoperability is not guaranteed.", | ||
| "additionalProperties": { | ||
| "type": ["string", "number", "boolean"] | ||
| } | ||
| } | ||
| }, | ||
| "required": ["enable"], | ||
| "additionalProperties": false, | ||
| "examples": [ | ||
| { | ||
| "version": "2025-02-03", | ||
| "enable": true, | ||
| "config": { | ||
| "min_snapshot_to_keep": 1, | ||
| "max_snapshot_age_days": 2, | ||
| "max_ref_age_days": 3, | ||
| "key1": "value1" | ||
| } | ||
| } | ||
| ] | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does the JSON magically land at the location specified in the ID somehow? Or do we always need a followup PR?
Also, it looks a little funny to use dates here given that the date in the PR may not align with the date the schema actually becomes effective. In the worst case, we could merge two versions in one day. Maybe just an incrementing number is easier?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately no. I hope I can publish it once for all based on the directory structure.
I want to keep them as the same for date as these are first batch, should be fine as nobody is using it. Once we release them at 1.0. We should follow the date schema strictly.