| // 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. |
| |
| // Package parquet provides an implementation of Apache Parquet for Go. |
| // |
| // Apache Parquet is an open-source columnar data storage format using the record |
| // shredding and assembly algorithm to accomodate complex data structures which |
| // can then be used to efficiently store the data. |
| // |
| // This implementation is a native go implementation for reading and writing the |
| // parquet file format. |
| // |
| // Install |
| // |
| // You can download the library via: |
| // go get -u github.com/apache/arrow/go/parquet |
| // |
| // In addition, two cli utilities are provided: |
| // go install github.factset.com/mtopol/parquet-go/cmd/parquet_reader |
| // go install github.factset.com/mtopol/parquet-go/cmd/parquet_schema |
| // |
| // Modules |
| // |
| // This top level parquet package contains the basic common types and reader/writer |
| // properties along with some utilities that are used throughout the other modules. |
| // |
| // The file module contains the functions for directly reading/writing parquet files |
| // including Column Readers and Column Writers. |
| // |
| // The metadata module contains the types for managing the lower level file/rowgroup/column |
| // metadata inside of a ParquetFile including inspecting the statistics. |
| // |
| // The pqarrow module contains helper functions and types for converting directly |
| // between Parquet and Apache Arrow formats. |
| // |
| // The schema module contains the types for manipulating / inspecting / creating |
| // parquet file schemas. |
| // |
| // Primitive Types |
| // |
| // The Parquet Primitive Types and their corresponding Go types are Boolean (bool), |
| // Int32 (int32), Int64 (int64), Int96 (parquet.Int96), Float (float32), Double (float64), |
| // ByteArray (parquet.ByteArray) and FixedLenByteArray (parquet.FixedLenByteArray). |
| // |
| // Encodings |
| // |
| // The encoding types supported in this package are: |
| // Plain, Plain/RLE Dictionary, Delta Binary Packed (only integer types), Delta Byte Array |
| // (only ByteArray), Delta Length Byte Array (only ByteArray) |
| // |
| // Tip: Some platforms don't necessarily support all kinds of encodings. If you're not |
| // sure what to use, just use Plain and Dictionary encoding. |
| package parquet |
| |
| //go:generate thrift -o internal -r --gen go ../../cpp/src/parquet/parquet.thrift |
