#include <core/storage/query_engine/planning/materialize_options.hpp>

Public Attributes
size_t	num_segments = 0

std::function< bool(size_t, const std::shared_ptr< sframe_rows > &)>	write_callback

bool	disable_optimization = false

bool	only_first_pass_optimizations = false

bool	naive_mode = false

bool	partial_materialize = true

std::string	output_index_file = ""

std::vector< std::string >	output_column_names

Detailed Description

Materialization options.

This options can be used to control each stage of the materialization pipeline. Used in the materialize methods.

Definition at line 30 of file materialize_options.hpp.

Member Data Documentation

◆ disable_optimization

bool turi::query_eval::materialize_options::disable_optimization = false

Disables query optimizations.

Definition at line 56 of file materialize_options.hpp.

◆ naive_mode

bool turi::query_eval::materialize_options::naive_mode = false

If true, then the naive materialize algorithm will be run. All nodes will be explicitly materialized, and no optimization will be performed. Useful for error checking the optimizations.

Definition at line 70 of file materialize_options.hpp.

◆ num_segments

size_t turi::query_eval::materialize_options::num_segments = 0

The number of segments to break parallel processing into. Also may affect the number of segments of the output SFrame.

Definition at line 36 of file materialize_options.hpp.

◆ only_first_pass_optimizations

bool turi::query_eval::materialize_options::only_first_pass_optimizations = false

If Optimizations are enabled, enabling this will only run the first pass optimizations: project/union reordering.

Definition at line 62 of file materialize_options.hpp.

◆ output_column_names

std::vector<std::string> turi::query_eval::materialize_options::output_column_names

if set, this parameter defines the column names of the output sframe. Otherwise X1,X2,X3... is used. of the final sframe. Also see output_index_file. This argument has no effect if write_callback is set.

Definition at line 95 of file materialize_options.hpp.

◆ output_index_file

std::string turi::query_eval::materialize_options::output_index_file = ""

if set, these parameter defines the sframe output index file location of the final sframe. Also see output_column_names This argument has no effect if write_callback is set.

Definition at line 87 of file materialize_options.hpp.

◆ partial_materialize

bool turi::query_eval::materialize_options::partial_materialize = true

If true, the materialization algorithm will partially materialize the query plan until all remaining paths are linearly consumable.

For successful query execution, this should always be true. When this is false, query execution may fail for particular types of plans due to rate control issues.

Definition at line 80 of file materialize_options.hpp.

◆ write_callback

std::function<bool(size_t, const std::shared_ptr<sframe_rows>&)> turi::query_eval::materialize_options::write_callback

If set, the final sframe output will be streamed into the callback function and an empty SFrame will be returned.

The type of the callback function is

std::function<bool(size_t, const std::shared_ptr<sframe_rows>&)>,

where the first argument is the segment_id being processed, and the rest is the data. If true is returned, then the processing is stopped.

Definition at line 51 of file materialize_options.hpp.

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

core/storage/query_engine/planning/materialize_options.hpp

Public Attributes