Turi Create  4.0
turi::index_file_information Struct Reference

#include <core/storage/sframe_data/sarray_index_file.hpp>

Public Attributes

std::string index_file
 Input file name.
 
int version = -1
 The format version of the sarray.
 
size_t nsegments = 0
 The number of segments in the array.
 
size_t block_size = 0
 block_size; Required for version 1.
 
std::string content_type
 The datatype of the array (typeid(T).name()).
 
std::vector< size_t > segment_sizes
 The length of each segment (number of entries).
 
std::vector< std::string > segment_files
 The file name of each segment.
 
std::map< std::string, std::string > metadata
 Any additional metadata stored with the array.
 

Detailed Description

Describes all the information in an sarray index file. The index_file_information struct contains all the information assocaited with a single sarray column. In a version 1 SArray, the index file describes a single column. As such index_file will point to the actual file location. In a version 2 SArray, the index file describes multiple columns. As such, index_file is of the form [file_location]:[column_number], and column_number may be non-zero. Column numbers are 0 indexed. segment_files are similar. In the v1 format, the segment_files point to the actual files. In the v2 format, the segment files are of the form [file_location]:[column_number].

Definition at line 38 of file sarray_index_file.hpp.


The documentation for this struct was generated from the following file: