org.apache.drill.exec.server.options

Class SystemOptionManager

java.lang.Object

org.apache.drill.exec.server.options.BaseOptionManager

org.apache.drill.exec.server.options.SystemOptionManager

All Implemented Interfaces:

AutoCloseable, Iterable<OptionValue>, OptionManager, OptionSet

public class SystemOptionManager
extends BaseOptionManager
implements AutoCloseable

OptionManager that holds options within DrillbitContext. Only one instance of this class exists per drillbit. Options set at the system level affect the entire system and persist between restarts.

All the system options are externalized into conf file. While adding a new system option a validator should be added and the default value for the option should be set in the conf files(example : drill-module.conf) under the namespace drill.exec.options.

The SystemOptionManager loads all the validators and the default values for the options are fetched from the config. The validators are populated with the default values fetched from the config. If the option is not set in the conf files config option is missing exception will be thrown.

If the option is set using ALTER, the value that is set will be returned. Else the default value that is loaded into validator from the config will be returned.

Constructor Summary

Constructors

Constructor and Description
SystemOptionManager(DrillConfig bootConfig) Test-only, in-memory version of the system option manager.
SystemOptionManager(LogicalPlanPersistence lpPersistence, PersistentStoreProvider provider, DrillConfig bootConfig)
SystemOptionManager(LogicalPlanPersistence lpPersistence, PersistentStoreProvider provider, DrillConfig bootConfig, CaseInsensitiveMap<OptionDefinition> definitions)

Method Summary

Modifier and Type	Method and Description
void	close()
static CaseInsensitiveMap<OptionDefinition>	createDefaultOptionDefinitions() Creates the OptionDefinitions to be registered with the SystemOptionManager.
void	deleteAllLocalOptions() Deletes all options.
void	deleteLocalOption(String name) Deletes the option.
OptionValue	getDefault(String optionName) Gets the default value for the specified option.
OptionValue	getOption(String name) Gets the option value for the given option name.
OptionDefinition	getOptionDefinition(String name) Gets the OptionDefinition associated with the name.
OptionList	getOptionList() Gets the list of options managed this manager.
protected OptionValue.OptionScope	getScope()
SystemOptionManager	init() Initializes this option manager.
Iterator<OptionValue>	iterator()
protected void	setLocalOptionHelper(OptionValue value)

Methods inherited from class org.apache.drill.exec.server.options.BaseOptionManager

getBoolean, getDouble, getInt, getInternalOptionList, getLong, getOption, getOption, getOption, getOption, getPublicOptionList, getString, setLocalOption, setLocalOption, setLocalOption, setLocalOption, setLocalOption, setLocalOption

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SystemOptionManager

public SystemOptionManager(LogicalPlanPersistence lpPersistence,
                           PersistentStoreProvider provider,
                           DrillConfig bootConfig)

SystemOptionManager

public SystemOptionManager(LogicalPlanPersistence lpPersistence,
                           PersistentStoreProvider provider,
                           DrillConfig bootConfig,
                           CaseInsensitiveMap<OptionDefinition> definitions)

SystemOptionManager

public SystemOptionManager(DrillConfig bootConfig)

Test-only, in-memory version of the system option manager.

Parameters:

bootConfig - Drill config

Method Detail

createDefaultOptionDefinitions

public static CaseInsensitiveMap<OptionDefinition> createDefaultOptionDefinitions()

Creates the OptionDefinitions to be registered with the SystemOptionManager.

Returns:

A map

init

public SystemOptionManager init()
                         throws Exception

Initializes this option manager.

Returns:

this option manager

Throws:

Exception - if unable to initialize option manager

iterator

public Iterator<OptionValue> iterator()

Specified by:

iterator in interface Iterable<OptionValue>

getOption

public OptionValue getOption(String name)

Description copied from interface: OptionSet

Gets the option value for the given option name. This interface also provides convenient methods to get typed option values: OptionSet.getOption(TypeValidators.BooleanValidator validator), OptionSet.getOption(TypeValidators.DoubleValidator validator), OptionSet.getOption(TypeValidators.LongValidator validator), and OptionSet.getOption(TypeValidators.StringValidator validator).

Specified by:

getOption in interface OptionSet

Parameters:

name - option name

Returns:

the option value, null if the option does not exist

getDefault

public OptionValue getDefault(String optionName)

Description copied from interface: OptionSet

Gets the default value for the specified option.

Specified by:

getDefault in interface OptionSet

Parameters:

optionName - The option to retrieve the default value for.

Returns:

The default value for the option.

setLocalOptionHelper

protected void setLocalOptionHelper(OptionValue value)

Specified by:

setLocalOptionHelper in class BaseOptionManager

getScope

protected OptionValue.OptionScope getScope()

Specified by:

getScope in class BaseOptionManager

deleteLocalOption

public void deleteLocalOption(String name)

Description copied from interface: OptionManager

Deletes the option. If the option name is valid (exists in the set of validators produced by createDefaultOptionDefinitions()), but the option was not set within this manager, calling this method should be a no-op.

Specified by:

deleteLocalOption in interface OptionManager

Parameters:

name - option name

deleteAllLocalOptions

public void deleteAllLocalOptions()

Description copied from interface: OptionManager

Deletes all options. If no options are set, calling this method should be no-op.

Specified by:

deleteAllLocalOptions in interface OptionManager

getOptionDefinition

public OptionDefinition getOptionDefinition(String name)

Gets the OptionDefinition associated with the name.

Specified by:

getOptionDefinition in interface OptionManager

Parameters:

name - name of the option

Returns:

the associated option definition

Throws:

UserException - - if the definition is not found

getOptionList

public OptionList getOptionList()

Description copied from interface: OptionManager

Gets the list of options managed this manager.

Specified by:

getOptionList in interface OptionManager

Returns:

the list of options

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception