danielcweeks commented on code in PR #4944: URL: https://github.com/apache/iceberg/pull/4944#discussion_r889640475
########## format/puffin-spec.md: ########## @@ -0,0 +1,139 @@ +--- +url: puffin-spec +toc: false +--- +<!-- + - Licensed to the Apache Software Foundation (ASF) under one or more + - contributor license agreements. See the NOTICE file distributed with + - this work for additional information regarding copyright ownership. + - The ASF licenses this file to You under the Apache License, Version 2.0 + - (the "License"); you may not use this file except in compliance with + - the License. You may obtain a copy of the License at + - + - http://www.apache.org/licenses/LICENSE-2.0 + - + - Unless required by applicable law or agreed to in writing, software + - distributed under the License is distributed on an "AS IS" BASIS, + - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + - See the License for the specific language governing permissions and + - limitations under the License. + --> + +# Puffin file format + +This is a specification for the Puffin, a file format designed to store +information such as indexes and statistics about data managed in an +Iceberg table that cannot be stored directly within the Iceberg manifest. A +Puffin file contains arbitrary pieces of information (here called "blobs"), +along with metadata necessary to interpret them. The blobs supported by Iceberg +are documented at [Blob types](#blob-types). + +## Format specification Review Comment: @rdblue should we have a qualifier in this spec relating to restrictions for how Puffiin data can be used in context of Iceberg? Specifically, I feel like we should be explicit that Puffin data must not be required in order to read/interpret data in iceberg format (i.e. it can be used for optimizations and annotating data, but must not be required for correct interpretation of table data). We don't want Puffin to be a vector to extend the table format for representation. -- 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]
