format/src/main/thrift/carbondata_index.thrift

/*
 * 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.
 */

/**
 * File format description for CarbonData index file for btree.
 */
namespace java org.apache.carbondata.format

include "schema.thrift"
include "carbondata.thrift"

/**
 * Header information stored in index file
 */
struct IndexHeader{
  1: required i32 version; // Version used for data compatibility
  2: required list<schema.ColumnSchema> table_columns;	// Description of columns in this file
  3: required carbondata.SegmentInfo segment_info;	// Segment info (will be same/repeated for all files in this segment)
  4: optional i32 bucket_id; // Bucket number in which file contains
  5: optional i64 schema_time_stamp; // Timestamp to compare column schema against master schema
  6: optional bool is_sort; // True if the data is sorted in this file, it is used for compaction to decide whether to use merge sort or not
}

/**
 * Block index information stored in index file for every block
 */
struct BlockIndex{
  1: required i64 num_rows; // Total number of rows in this file
  2: required string file_name; // Block file name
  3: required i64 offset; // Offset of the footer
  4: required carbondata.BlockletIndex block_index;	// Blocklet index
  5: optional carbondata.BlockletInfo3 blocklet_info;
  6: optional i64 file_size // Record the valid size for appendable carbon file
}