include/parquet/index_location.h

0001 // Licensed to the Apache Software Foundation (ASF) under one
0002 // or more contributor license agreements.  See the NOTICE file
0003 // distributed with this work for additional information
0004 // regarding copyright ownership.  The ASF licenses this file
0005 // to you under the Apache License, Version 2.0 (the
0006 // "License"); you may not use this file except in compliance
0007 // with the License.  You may obtain a copy of the License at
0008 //
0009 //   http://www.apache.org/licenses/LICENSE-2.0
0010 //
0011 // Unless required by applicable law or agreed to in writing,
0012 // software distributed under the License is distributed on an
0013 // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
0014 // KIND, either express or implied.  See the License for the
0015 // specific language governing permissions and limitations
0016 // under the License.
0017
0018 #pragma once
0019
0020 #include <cstdint>
0021 #include <vector>
0022
0023 #include "parquet/platform.h"
0024
0025 namespace parquet {
0026
0027 enum class PARQUET_EXPORT IndexKind : uint8_t {
0028   kColumnIndex,
0029   kOffsetIndex,
0030   kBloomFilter,
0031 };
0032
0033 /// \brief Location to a Parquet index (page index or bloom filter).
0034 struct PARQUET_EXPORT IndexLocation {
0035   // File offset of the given index, in bytes
0036   int64_t offset;
0037   // Length of the given index, in bytes
0038   int32_t length;
0039 };
0040
0041 /// \brief Identifier for a column chunk.
0042 struct PARQUET_EXPORT ColumnChunkId {
0043   int32_t row_group_index;
0044   int32_t column_index;
0045 };
0046
0047 using IndexLocations = std::vector<std::pair<ColumnChunkId, IndexLocation>>;
0048
0049 }  // namespace parquet