ArrowResultSet.h File Reference

#include "CompilationOptions.h"
#include "DataMgr/DataMgr.h"
#include "Descriptors/RelAlgExecutionDescriptor.h"
#include "ResultSet.h"
#include "TargetMetaInfo.h"
#include "TargetValue.h"
#include <type_traits>
#include "arrow/api.h"
#include "arrow/ipc/api.h"

Include dependency graph for ArrowResultSet.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	ArrowResultSetRowIterator
struct	ArrowResult
class	ArrowResultSet
class	ArrowResultSetConverter
struct	ArrowResultSetConverter::ColumnBuilder
struct	ArrowResultSetConverter::SerializedArrowOutput

Typedefs
using	ValueArray = boost::variant< std::vector< bool >, std::vector< int8_t >, std::vector< int16_t >, std::vector< int32_t >, std::vector< int64_t >, std::vector< arrow::Decimal128 >, std::vector< float >, std::vector< double >, std::vector< std::string >, std::vector< std::vector< int8_t >>, std::vector< std::vector< int16_t >>, std::vector< std::vector< int32_t >>, std::vector< std::vector< int64_t >>, std::vector< std::vector< float >>, std::vector< std::vector< double >>, std::vector< std::vector< std::string >>>
template<typename T >
using	Vec2 = std::vector< std::vector< T >>

Enumerations
enum	ArrowTransport { ArrowTransport::SHARED_MEMORY = 0, ArrowTransport::WIRE = 1 }
enum	ArrowStringRemapMode { ArrowStringRemapMode::ALL_STRINGS_REMAPPED, ArrowStringRemapMode::ONLY_TRANSIENT_STRINGS_REMAPPED, ArrowStringRemapMode::INVALID }

Functions
std::unique_ptr< ArrowResultSet >	result_set_arrow_loopback (const ExecutionResult &results)
std::unique_ptr< ArrowResultSet >	result_set_arrow_loopback (const ExecutionResult *results, const std::shared_ptr< ResultSet > &rows, const ExecutorDeviceType device_type=ExecutorDeviceType::CPU)
std::unique_ptr< ArrowResultSet >	result_set_arrow_loopback (const ExecutionResult *results, const std::shared_ptr< ResultSet > &rows, const ExecutorDeviceType device_type, const size_t min_result_size_for_bulk_dictionary_fetch, const double max_dictionary_to_result_size_ratio_for_bulk_dictionary_fetch)
template<typename T >
constexpr auto	scale_epoch_values ()

Typedef Documentation

using ValueArray = boost::variant<std::vector<bool>, std::vector<int8_t>, std::vector<int16_t>, std::vector<int32_t>, std::vector<int64_t>, std::vector<arrow::Decimal128>, std::vector<float>, std::vector<double>, std::vector<std::string>, std::vector<std::vector<int8_t>>, std::vector<std::vector<int16_t>>, std::vector<std::vector<int32_t>>, std::vector<std::vector<int64_t>>, std::vector<std::vector<float>>, std::vector<std::vector<double>>, std::vector<std::vector<std::string>>>

Definition at line 52 of file ArrowResultSet.h.

template<typename T >

using Vec2 = std::vector<std::vector<T>>

Definition at line 55 of file ArrowResultSet.h.

Enumeration Type Documentation

enum ArrowStringRemapMode

strong

Enumerator
ALL_STRINGS_REMAPPED
ONLY_TRANSIENT_STRINGS_REMAPPED
INVALID

Definition at line 222 of file ArrowResultSet.h.

                                {
  ALL_STRINGS_REMAPPED,
  ONLY_TRANSIENT_STRINGS_REMAPPED,
  INVALID
};

enum ArrowTransport

strong

Enumerator
SHARED_MEMORY
WIRE

Definition at line 95 of file ArrowResultSet.h.

{ SHARED_MEMORY = 0, WIRE = 1 };

Function Documentation

std::unique_ptr<ArrowResultSet> result_set_arrow_loopback

(

const ExecutionResult &

results

)

Definition at line 328 of file ArrowResultSet.cpp.

References ExecutionResult::getRows(), and ExecutionResult::getTargetsMeta().

                                    {
  // NOTE(wesm): About memory ownership

  // After calling ReadRecordBatch, the buffers inside arrow::RecordBatch now
  // share ownership of the memory in serialized_arrow_output.records (zero
  // copy). Not necessary to retain these buffers. Same is true of any
  // dictionaries contained in serialized_arrow_output.schema; the arrays
  // reference that memory (zero copy).
  return std::make_unique<ArrowResultSet>(results.getRows(), results.getTargetsMeta());
}

Here is the call graph for this function:

std::unique_ptr<ArrowResultSet> result_set_arrow_loopback	(	const ExecutionResult *	results,
		const std::shared_ptr< ResultSet > &	rows,
		const ExecutorDeviceType	device_type = ExecutorDeviceType::CPU
	)

Definition at line 340 of file ArrowResultSet.cpp.

References ExecutionResult::getTargetsMeta(), and report::rows.

                                          {
  return results ? std::make_unique<ArrowResultSet>(
                       rows, results->getTargetsMeta(), device_type)
                 : std::make_unique<ArrowResultSet>(rows, device_type);
}

Here is the call graph for this function:

std::unique_ptr<ArrowResultSet> result_set_arrow_loopback	(	const ExecutionResult *	results,
		const std::shared_ptr< ResultSet > &	rows,
		const ExecutorDeviceType	device_type,
		const size_t	min_result_size_for_bulk_dictionary_fetch,
		const double	max_dictionary_to_result_size_ratio_for_bulk_dictionary_fetch
	)

Definition at line 349 of file ArrowResultSet.cpp.

References ExecutionResult::getTargetsMeta(), and report::rows.

                                                                                {
  std::vector<TargetMetaInfo> dummy_targets_meta;
  return results ? std::make_unique<ArrowResultSet>(
                       rows,
                       results->getTargetsMeta(),
                       device_type,
                       min_result_size_for_bulk_dictionary_fetch,
                       max_dictionary_to_result_size_ratio_for_bulk_dictionary_fetch)
                 : std::make_unique<ArrowResultSet>(
                       rows,
                       dummy_targets_meta,
                       device_type,
                       min_result_size_for_bulk_dictionary_fetch,
                       max_dictionary_to_result_size_ratio_for_bulk_dictionary_fetch);
}

Here is the call graph for this function:

template<typename T >

constexpr auto scale_epoch_values

(

)

Definition at line 360 of file ArrowResultSet.h.

                                    {
  return std::is_same<T, arrow::Date32Builder>::value ||
         std::is_same<T, arrow::Date64Builder>::value;
}