org.apache.drill.exec.store

Interface StoragePluginRegistry

All Superinterfaces:

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

All Known Implementing Classes:

StoragePluginRegistryImpl

public interface StoragePluginRegistry
extends Iterable<Map.Entry<String,StoragePlugin>>, AutoCloseable

Field Summary

Fields

Modifier and Type	Field and Description
static String	INFORMATION_SCHEMA_PLUGIN
static String	PSTORE_NAME
static String	STORAGE_PLUGIN_REGISTRY_IMPL
static String	SYS_PLUGIN

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.
StoragePlugin	createOrUpdate(String name, StoragePluginConfig config, boolean persist) Create a plugin by name and configuration.
void	deletePlugin(String name) Delete a plugin by name
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.

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SYS_PLUGIN

static final String SYS_PLUGIN

See Also:

Constant Field Values

INFORMATION_SCHEMA_PLUGIN

static final String INFORMATION_SCHEMA_PLUGIN

See Also:

Constant Field Values

STORAGE_PLUGIN_REGISTRY_IMPL

static final String STORAGE_PLUGIN_REGISTRY_IMPL

See Also:

Constant Field Values

PSTORE_NAME

static final String PSTORE_NAME

See Also:

Constant Field Values

Method Detail

init

void init()
          throws DrillbitStartupException

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

Throws:

DrillbitStartupException

deletePlugin

void deletePlugin(String name)

Delete a plugin by name

Parameters:

name - The name of the storage plugin to delete.

createOrUpdate

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

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

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

StoragePlugin getPlugin(String name)
                        throws ExecutionSetupException

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

Parameters:

name - The name of the plugin

Returns:

The StoragePlugin instance.

Throws:

ExecutionSetupException

getPlugin

StoragePlugin getPlugin(StoragePluginConfig config)
                        throws ExecutionSetupException

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

Parameters:

config - The configuration for the plugin.

Returns:

The StoragePlugin instance.

Throws:

ExecutionSetupException

addPlugin

void addPlugin(String name,
             StoragePlugin plugin)

Add a plugin to the registry using the provided name.

Parameters:

name -

plugin -

getFormatPlugin

FormatPlugin getFormatPlugin(StoragePluginConfig storageConfig,
                           FormatPluginConfig formatConfig)
                             throws ExecutionSetupException

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

Parameters:

storageConfig - The storage config for the associated FileSystemPlugin

formatConfig - The format config for the associated FormatPlugin

Returns:

A FormatPlugin

Throws:

ExecutionSetupException

getStore

PersistentStore<StoragePluginConfig> getStore()

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

Returns:

PStore for StoragePlugin configuration objects.

getSchemaFactory

SchemaFactory getSchemaFactory()

Get the Schema factory associated with this storage plugin registry.

Returns:

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