graphar::AdjListOffsetArrowChunkReader Class Reference

The arrow chunk reader for edge offset. More...

#include <chunk_reader.h>

Public Types
using	range_t = std::pair< IdType, IdType >

Public Member Functions
	AdjListOffsetArrowChunkReader (const std::shared_ptr< EdgeInfo > &edge_info, AdjListType adj_list_type, const std::string &prefix)
	Initialize the AdjListOffsetArrowChunkReader. More...
Status	seek (IdType id)
	Sets chunk position indicator for reader by internal vertex id. If internal vertex id is not found, will return Status::IndexError error. After seeking to an invalid vertex id, the next call to GetChunk function may undefined, e.g. return an non exist path. More...
Result< std::shared_ptr< arrow::Array > >	GetChunk ()
	Get the current offset chunk as arrow::Array.
Status	next_chunk ()
	Sets chunk position indicator to next chunk. if current chunk is the last chunk, will return Status::IndexError error.
IdType	GetChunkIndex () const noexcept
	Get current vertex chunk index.

Static Public Member Functions
static Result< std::shared_ptr< AdjListOffsetArrowChunkReader > >	Make (const std::shared_ptr< EdgeInfo > &edge_info, AdjListType adj_list_type, const std::string &prefix)
	Create an AdjListOffsetArrowChunkReader instance from edge info. More...
static Result< std::shared_ptr< AdjListOffsetArrowChunkReader > >	Make (const std::shared_ptr< GraphInfo > &graph_info, const std::string &src_type, const std::string &edge_type, const std::string &dst_type, AdjListType adj_list_type)
	Create an AdjListOffsetArrowChunkReader instance from graph info. More...

Detailed Description

The arrow chunk reader for edge offset.

Definition at line 390 of file chunk_reader.h.

Constructor & Destructor Documentation

AdjListOffsetArrowChunkReader()

graphar::AdjListOffsetArrowChunkReader::AdjListOffsetArrowChunkReader	(	const std::shared_ptr< EdgeInfo > &	edge_info,
		AdjListType	adj_list_type,
		const std::string &	prefix
	)

Initialize the AdjListOffsetArrowChunkReader.

Parameters

edge_info	The edge info that describes the edge type.
adj_list_type	The adj list type for the edges. Note that the adj list type must be AdjListType::ordered_by_source or AdjListType::ordered_by_dest.
prefix	The absolute prefix.

Definition at line 734 of file chunk_reader.cc.

Member Function Documentation

Make() [1/2]

Result< std::shared_ptr< AdjListOffsetArrowChunkReader > > graphar::AdjListOffsetArrowChunkReader::Make ( const std::shared_ptr< EdgeInfo > &  edge_info, AdjListType  adj_list_type, const std::string &  prefix  )

static

Create an AdjListOffsetArrowChunkReader instance from edge info.

Parameters

edge_info	The edge info.
adj_list_type	The adj list type for the edges.
prefix	The absolute prefix of the graph.

Definition at line 810 of file chunk_reader.cc.

Make() [2/2]

Result< std::shared_ptr< AdjListOffsetArrowChunkReader > > graphar::AdjListOffsetArrowChunkReader::Make ( const std::shared_ptr< GraphInfo > &  graph_info, const std::string &  src_type, const std::string &  edge_type, const std::string &  dst_type, AdjListType  adj_list_type  )

static

Create an AdjListOffsetArrowChunkReader instance from graph info.

Parameters

graph_info	The graph info.
src_type	The source vertex type.
edge_type	The edge type.
dst_type	The destination vertex type.
adj_list_type	The adj list type for the edges.

Definition at line 823 of file chunk_reader.cc.

seek()

Status graphar::AdjListOffsetArrowChunkReader::seek

(

IdType

id

)

Sets chunk position indicator for reader by internal vertex id. If internal vertex id is not found, will return Status::IndexError error. After seeking to an invalid vertex id, the next call to GetChunk function may undefined, e.g. return an non exist path.

Parameters

id	the internal vertex id.

Definition at line 764 of file chunk_reader.cc.

---

The documentation for this class was generated from the following files:

• src/graphar/arrow/chunk_reader.h
• src/graphar/arrow/chunk_reader.cc