org.apache.drill.exec.server.options

Class SessionOptionManager

java.lang.Object

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

org.apache.drill.exec.server.options.FallbackOptionManager

org.apache.drill.exec.server.options.InMemoryOptionManager

org.apache.drill.exec.server.options.SessionOptionManager

All Implemented Interfaces:

Iterable<OptionValue>, OptionManager, OptionSet

public class SessionOptionManager
extends InMemoryOptionManager

OptionManager that holds options within UserSession context. Options set at the session level only apply to queries that you run during the current Drill connection. Session level settings override system level settings. NOTE that currently, the effects of deleting a short lived option (see OptionValidator.isShortLived()) are undefined. For example, we inject an exception (passed through an option), then try to delete the option, depending on where the exception was injected, the reset query could either succeed or the exception could actually be thrown in the reset query itself.

Field Summary

Fields inherited from class org.apache.drill.exec.server.options.InMemoryOptionManager

options

Fields inherited from class org.apache.drill.exec.server.options.FallbackOptionManager

fallback

Constructor Summary

Constructors

Constructor and Description
SessionOptionManager(OptionManager systemOptions, UserSession session)

Method Summary

Modifier and Type	Method and Description
OptionValue	getDefault(String optionName) Gets the default value for the specified option.
protected OptionValue.OptionScope	getScope()
SystemOptionManager	getSystemOptionManager() Gets the SystemOptionManager.
void	setLocalOptionHelper(OptionValue value)

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

deleteAllLocalOptions, deleteLocalOption

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

getOption, getOptionDefinition, getOptionList, iterator

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

SessionOptionManager

public SessionOptionManager(OptionManager systemOptions,
                            UserSession session)

Method Detail

setLocalOptionHelper

public void setLocalOptionHelper(OptionValue value)

Overrides:

setLocalOptionHelper in class InMemoryOptionManager

getSystemOptionManager

public SystemOptionManager getSystemOptionManager()

Gets the SystemOptionManager.

Returns:

The SystemOptionManager.

getDefault

public OptionValue getDefault(String optionName)

Description copied from interface: OptionSet

Gets the default value for the specified option.

Parameters:

optionName - The option to retrieve the default value for.

Returns:

The default value for the option.

getScope

protected OptionValue.OptionScope getScope()

Specified by:

getScope in class BaseOptionManager