mutable
A Database System for Research and Fast Prototyping
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Data Fields | Private Member Functions
m::Options Struct Reference

Singleton class representing options provided as command line argument to the binaries. More...

#include <Options.hpp>

Collaboration diagram for m::Options:
[legend]

Public Types

enum  PlanTableType { PT_auto , PT_SmallOrDense , PT_LargeAndSparse }
 Type of plan tables available for query optimization. More...
 

Public Member Functions

 Options (const Options &)=delete
 
Options & operator= (const Options &)=delete
 

Static Public Member Functions

static Options & Get ()
 Return a reference to the single Options instance.
 

Data Fields

bool show_help
 
bool show_version
 
bool list_data_layouts
 
bool list_cardinality_estimators
 
bool list_plan_enumerators
 
bool list_backends
 
bool list_cost_functions
 
bool list_schedulers
 
bool list_table_properties
 
bool has_color
 
bool show_prompt
 
bool quiet
 
bool times
 
bool statistics
 
bool echo
 
bool ast
 
bool astdot
 
bool graph
 
bool graphdot
 
bool graph2sql
 
bool plan
 
bool plandot
 
bool physplan
 
bool dryrun
 If true, do not pass the query to the backend for execution.
 
bool benchmark
 If true, the results of queries are dropped and not passed back to the user.
 
PlanTableType plan_table_type = PT_auto
 The type of plan table to use for query optimization.
 
const char * injected_cardinalities_file
 
const char * output_partial_plans_file
 
bool train_cost_models
 If true, run the procedure to train cost models for query building blocks at startup.
 
const char * plugins
 A comma seperated list of libraries that are loaded dynamically.
 

Private Member Functions

 Options ()=default
 

Detailed Description

Singleton class representing options provided as command line argument to the binaries.

Implements Scott Meyer's singleton pattern.

Definition at line 11 of file Options.hpp.

Member Enumeration Documentation

◆ PlanTableType

enum m::Options::PlanTableType

Type of plan tables available for query optimization.

Enumerator
PT_auto 
PT_SmallOrDense 
PT_LargeAndSparse 

Definition at line 14 of file Options.hpp.

Constructor & Destructor Documentation

◆ Options() [1/2]

m::Options::Options ( )
privatedefault

◆ Options() [2/2]

m::Options::Options ( const Options &  )
delete

Member Function Documentation

◆ Get()

Options & Options::Get ( )
static

Return a reference to the single Options instance.

Definition at line 9 of file Options.cpp.

Referenced by m::idx::ArrayIndex< Key >::bulkload(), m::InjectionCardinalityEstimator::estimate_join(), m::learn_spns::execute(), m::QueryDatabase::execute(), m::CreateDatabase::execute(), m::DropDatabase::execute(), m::UseDatabase::execute(), m::CreateTable::execute(), m::DropTable::execute(), m::CreateIndex::execute(), m::DropIndex::execute(), m::execute_statement(), m::pe::hs::heuristic_search(), m::InjectionCardinalityEstimator::InjectionCardinalityEstimator(), m::wasm::detail::instantiate(), load_plugins(), main(), m::pe::hs::HeuristicSearch::operator()(), m::InjectionCardinalityEstimator::operator()(), m::Optimizer::optimize(), m::Optimizer::optimize_join_order(), m::wasm::detail::print_memory_consumption(), m::process_stream(), m::ai::StateManager< State, Expand, Heurisitc, HasRegularQueue, HasBeamQueue, Config, Context >::update_least_path_cost(), and m::ai::StateManager< State, Expand, Heurisitc, HasRegularQueue, HasBeamQueue, Config, Context >::Partitions< true >::~Partitions().

◆ operator=()

Options & m::Options::operator= ( const Options &  )
delete

Field Documentation

◆ ast

bool m::Options::ast

Definition at line 41 of file Options.hpp.

Referenced by main().

◆ astdot

bool m::Options::astdot

Definition at line 42 of file Options.hpp.

Referenced by main().

◆ benchmark

bool m::Options::benchmark

If true, the results of queries are dropped and not passed back to the user.

Definition at line 54 of file Options.hpp.

Referenced by main().

◆ dryrun

bool m::Options::dryrun

If true, do not pass the query to the backend for execution.

Definition at line 51 of file Options.hpp.

Referenced by m::QueryDatabase::execute(), and main().

◆ echo

bool m::Options::echo

Definition at line 40 of file Options.hpp.

Referenced by main().

◆ graph

bool m::Options::graph

Definition at line 43 of file Options.hpp.

Referenced by m::QueryDatabase::execute(), and main().

◆ graph2sql

bool m::Options::graph2sql

Definition at line 45 of file Options.hpp.

Referenced by main().

◆ graphdot

bool m::Options::graphdot

Definition at line 44 of file Options.hpp.

Referenced by m::QueryDatabase::execute(), and main().

◆ has_color

bool m::Options::has_color

Definition at line 33 of file Options.hpp.

Referenced by main().

◆ injected_cardinalities_file

const char* m::Options::injected_cardinalities_file

Definition at line 60 of file Options.hpp.

◆ list_backends

bool m::Options::list_backends

Definition at line 27 of file Options.hpp.

Referenced by main().

◆ list_cardinality_estimators

bool m::Options::list_cardinality_estimators

Definition at line 25 of file Options.hpp.

Referenced by main().

◆ list_cost_functions

bool m::Options::list_cost_functions

Definition at line 28 of file Options.hpp.

Referenced by main().

◆ list_data_layouts

bool m::Options::list_data_layouts

Definition at line 24 of file Options.hpp.

Referenced by main().

◆ list_plan_enumerators

bool m::Options::list_plan_enumerators

Definition at line 26 of file Options.hpp.

Referenced by main().

◆ list_schedulers

bool m::Options::list_schedulers

Definition at line 29 of file Options.hpp.

Referenced by main().

◆ list_table_properties

bool m::Options::list_table_properties

Definition at line 30 of file Options.hpp.

Referenced by main().

◆ output_partial_plans_file

const char* m::Options::output_partial_plans_file

Definition at line 61 of file Options.hpp.

Referenced by main().

◆ physplan

bool m::Options::physplan

Definition at line 48 of file Options.hpp.

Referenced by m::QueryDatabase::execute(), and main().

◆ plan

bool m::Options::plan

Definition at line 46 of file Options.hpp.

Referenced by main().

◆ plan_table_type

PlanTableType m::Options::plan_table_type = PT_auto

The type of plan table to use for query optimization.

Definition at line 57 of file Options.hpp.

Referenced by main().

◆ plandot

bool m::Options::plandot

Definition at line 47 of file Options.hpp.

Referenced by main().

◆ plugins

const char* m::Options::plugins

A comma seperated list of libraries that are loaded dynamically.

Definition at line 67 of file Options.hpp.

◆ quiet

bool m::Options::quiet

Definition at line 35 of file Options.hpp.

Referenced by m::pe::hs::heuristic_search(), and main().

◆ show_help

bool m::Options::show_help

Definition at line 22 of file Options.hpp.

Referenced by main().

◆ show_prompt

bool m::Options::show_prompt

Definition at line 34 of file Options.hpp.

Referenced by main().

◆ show_version

bool m::Options::show_version

Definition at line 23 of file Options.hpp.

Referenced by main().

◆ statistics

bool m::Options::statistics

Definition at line 39 of file Options.hpp.

Referenced by m::pe::hs::heuristic_search(), and main().

◆ times

bool m::Options::times

Definition at line 38 of file Options.hpp.

Referenced by main().

◆ train_cost_models

bool m::Options::train_cost_models

If true, run the procedure to train cost models for query building blocks at startup.

Definition at line 64 of file Options.hpp.

Referenced by main().

The documentation for this struct was generated from the following files:
mutable website
GitHub
Generated by   doxygen 1.9.6