org.apache.drill.exec.store

Class StoragePluginRegistryImpl

java.lang.Object

org.apache.drill.exec.store.StoragePluginRegistryImpl

All Implemented Interfaces:

AutoCloseable, Iterable<Map.Entry<String,StoragePlugin>>, StoragePluginRegistry

public class StoragePluginRegistryImpl
extends Object
implements StoragePluginRegistry

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	StoragePluginRegistryImpl.DrillSchemaFactory

Field Summary

Fields inherited from interface org.apache.drill.exec.store.StoragePluginRegistry

INFORMATION_SCHEMA_PLUGIN, PSTORE_NAME, STORAGE_PLUGIN_REGISTRY_IMPL, SYS_PLUGIN

Constructor Summary

Constructors

Constructor and Description
StoragePluginRegistryImpl(DrillbitContext context)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPlugin(String name, StoragePlugin plugin) Add a plugin to the registry using the provided name.
void	close()
StoragePlugin	createOrUpdate(String name, StoragePluginConfig config, boolean persist) Create a plugin by name and configuration.
void	definePlugin(String name, StoragePluginConfig config, StoragePlugin plugin) Add a plugin and configuration.
void	deletePlugin(String name) Delete a plugin by name
static Map<Object,Constructor<? extends StoragePlugin>>	findAvailablePlugins(ScanResult classpathScan) Get a list of all available storage plugin class constructors.
FormatPlugin	getFormatPlugin(StoragePluginConfig storageConfig, FormatPluginConfig formatConfig) Get the Format plugin for the FileSystemPlugin associated with the provided storage config and format config.
StoragePlugin	getPlugin(StoragePluginConfig config) Get a plugin by configuration.
StoragePlugin	getPlugin(String name) Get a plugin by name.
SchemaFactory	getSchemaFactory() Get the Schema factory associated with this storage plugin registry.
PersistentStore<StoragePluginConfig>	getStore() Get the PStore for this StoragePluginRegistry.
void	init() Initialize the storage plugin registry.
Iterator<Map.Entry<String,StoragePlugin>>	iterator()

Methods inherited from class java.lang.Object

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

Constructor Detail

StoragePluginRegistryImpl

public StoragePluginRegistryImpl(DrillbitContext context)

Method Detail

getStore

public PersistentStore<StoragePluginConfig> getStore()

Description copied from interface: StoragePluginRegistry

Get the PStore for this StoragePluginRegistry. (Used in the management layer.)

Specified by:

getStore in interface StoragePluginRegistry

Returns:

PStore for StoragePlugin configuration objects.

init

public void init()
          throws DrillbitStartupException

Description copied from interface: StoragePluginRegistry

Initialize the storage plugin registry. Must be called before the registry is used.

Specified by:

init in interface StoragePluginRegistry

Throws:

DrillbitStartupException

definePlugin

public void definePlugin(String name,
                StoragePluginConfig config,
                StoragePlugin plugin)

Add a plugin and configuration. Assumes neither exists. Primarily for testing.

Parameters:

name - plugin name

config - plugin config

plugin - plugin implementation

addPlugin

public void addPlugin(String name,
             StoragePlugin plugin)

Description copied from interface: StoragePluginRegistry

Add a plugin to the registry using the provided name.

Specified by:

addPlugin in interface StoragePluginRegistry

deletePlugin

public void deletePlugin(String name)

Description copied from interface: StoragePluginRegistry

Delete a plugin by name

Specified by:

deletePlugin in interface StoragePluginRegistry

Parameters:

name - The name of the storage plugin to delete.

createOrUpdate

public StoragePlugin createOrUpdate(String name,
                           StoragePluginConfig config,
                           boolean persist)
                             throws ExecutionSetupException

Description copied from interface: StoragePluginRegistry

Create a plugin by name and configuration. If the plugin already exists, update the plugin

Specified by:

createOrUpdate in interface StoragePluginRegistry

Parameters:

name - The name of the plugin

config - The plugin configuration

persist - Whether to persist the plugin for later use or treat it as ephemeral.

Returns:

The StoragePlugin instance.

Throws:

ExecutionSetupException

getPlugin

public StoragePlugin getPlugin(String name)
                        throws ExecutionSetupException

Description copied from interface: StoragePluginRegistry

Get a plugin by name. Create it based on the PStore saved definition if it doesn't exist.

Specified by:

getPlugin in interface StoragePluginRegistry

Parameters:

name - The name of the plugin

Returns:

The StoragePlugin instance.

Throws:

ExecutionSetupException

getPlugin

public StoragePlugin getPlugin(StoragePluginConfig config)
                        throws ExecutionSetupException

Description copied from interface: StoragePluginRegistry

Get a plugin by configuration. If it doesn't exist, create it.

Specified by:

getPlugin in interface StoragePluginRegistry

Parameters:

config - The configuration for the plugin.

Returns:

The StoragePlugin instance.

Throws:

ExecutionSetupException

getFormatPlugin

public FormatPlugin getFormatPlugin(StoragePluginConfig storageConfig,
                           FormatPluginConfig formatConfig)
                             throws ExecutionSetupException

Description copied from interface: StoragePluginRegistry

Get the Format plugin for the FileSystemPlugin associated with the provided storage config and format config.

Specified by:

getFormatPlugin in interface StoragePluginRegistry

Parameters:

storageConfig - The storage config for the associated FileSystemPlugin

formatConfig - The format config for the associated FormatPlugin

Returns:

A FormatPlugin

Throws:

ExecutionSetupException

iterator

public Iterator<Map.Entry<String,StoragePlugin>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<String,StoragePlugin>>

getSchemaFactory

public SchemaFactory getSchemaFactory()

Description copied from interface: StoragePluginRegistry

Get the Schema factory associated with this storage plugin registry.

Specified by:

getSchemaFactory in interface StoragePluginRegistry

Returns:

A SchemaFactory that can register the schemas associated with this plugin registry.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

findAvailablePlugins

public static Map<Object,Constructor<? extends StoragePlugin>> findAvailablePlugins(ScanResult classpathScan)

Get a list of all available storage plugin class constructors.

Parameters:

classpathScan - A classpath scan to use.

Returns:

A Map of StoragePluginConfig => StoragePlugin.() constructors.