org.apache.drill.exec.store.dfs.easy

Class EasyFormatPlugin<T extends FormatPluginConfig>

java.lang.Object

org.apache.drill.exec.store.dfs.easy.EasyFormatPlugin<T>

All Implemented Interfaces:

FormatPlugin

Direct Known Subclasses:

AvroFormatPlugin, HttpdLogFormatPlugin, JSONFormatPlugin, PcapFormatPlugin, SequenceFileFormatPlugin, TextFormatPlugin

public abstract class EasyFormatPlugin<T extends FormatPluginConfig>
extends Object
implements FormatPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected T	formatConfig

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EasyFormatPlugin(String name, DrillbitContext context, org.apache.hadoop.conf.Configuration fsConf, StoragePluginConfig storageConfig, T formatConfig, boolean readable, boolean writable, boolean blockSplittable, boolean compressible, List<String> extensions, String defaultName)

Method Summary

Methods

Modifier and Type	Method and Description
T	getConfig()
DrillbitContext	getContext()
org.apache.hadoop.conf.Configuration	getFsConf()
AbstractGroupScan	getGroupScan(String userName, FileSelection selection, List<SchemaPath> columns)
FormatMatcher	getMatcher()
String	getName()
Set<StoragePluginOptimizerRule>	getOptimizerRules()
abstract int	getReaderOperatorType()
abstract RecordReader	getRecordReader(FragmentContext context, DrillFileSystem dfs, FileWork fileWork, List<SchemaPath> columns, String userName)
abstract RecordWriter	getRecordWriter(FragmentContext context, EasyWriter writer)
protected ScanStats	getScanStats(PlannerSettings settings, EasyGroupScan scan)
StoragePluginConfig	getStorageConfig()
AbstractWriter	getWriter(PhysicalOperator child, String location, List<String> partitionColumns)
CloseableRecordBatch	getWriterBatch(FragmentContext context, RecordBatch incoming, EasyWriter writer)
abstract int	getWriterOperatorType()
boolean	isBlockSplittable() Whether or not you can split the format based on blocks within file boundaries.
boolean	isCompressible() Method indicates whether or not this format could also be in a compression container (for example: csv.gz versus csv).
boolean	supportsAutoPartitioning() Indicates whether this FormatPlugin supports auto-partitioning for CTAS statements
abstract boolean	supportsPushDown()
boolean	supportsRead()
boolean	supportsWrite()

Methods inherited from class java.lang.Object

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

Field Detail

formatConfig

protected final T extends FormatPluginConfig formatConfig

Constructor Detail

EasyFormatPlugin

protected EasyFormatPlugin(String name,
                DrillbitContext context,
                org.apache.hadoop.conf.Configuration fsConf,
                StoragePluginConfig storageConfig,
                T formatConfig,
                boolean readable,
                boolean writable,
                boolean blockSplittable,
                boolean compressible,
                List<String> extensions,
                String defaultName)

Method Detail

getFsConf

public org.apache.hadoop.conf.Configuration getFsConf()

Specified by:

getFsConf in interface FormatPlugin

getContext

public DrillbitContext getContext()

Specified by:

getContext in interface FormatPlugin

getName

public String getName()

Specified by:

getName in interface FormatPlugin

supportsPushDown

public abstract boolean supportsPushDown()

isBlockSplittable

public boolean isBlockSplittable()

Whether or not you can split the format based on blocks within file boundaries. If not, the simple format engine will only split on file boundaries.

Returns:

True if splittable.

isCompressible

public boolean isCompressible()

Method indicates whether or not this format could also be in a compression container (for example: csv.gz versus csv). If this format uses its own internal compression scheme, such as Parquet does, then this should return false.

Returns:

true if it is compressible

getRecordReader

public abstract RecordReader getRecordReader(FragmentContext context,
                           DrillFileSystem dfs,
                           FileWork fileWork,
                           List<SchemaPath> columns,
                           String userName)
                                      throws ExecutionSetupException

Throws:

ExecutionSetupException

getRecordWriter

public abstract RecordWriter getRecordWriter(FragmentContext context,
                           EasyWriter writer)
                                      throws IOException

Throws:

IOException

getWriterBatch

public CloseableRecordBatch getWriterBatch(FragmentContext context,
                                  RecordBatch incoming,
                                  EasyWriter writer)
                                    throws ExecutionSetupException

Throws:

ExecutionSetupException

getScanStats

protected ScanStats getScanStats(PlannerSettings settings,
                     EasyGroupScan scan)

getWriter

public AbstractWriter getWriter(PhysicalOperator child,
                       String location,
                       List<String> partitionColumns)
                         throws IOException

Specified by:

getWriter in interface FormatPlugin

Throws:

IOException

getGroupScan

public AbstractGroupScan getGroupScan(String userName,
                             FileSelection selection,
                             List<SchemaPath> columns)
                               throws IOException

Specified by:

getGroupScan in interface FormatPlugin

Throws:

IOException

getConfig

public T getConfig()

Specified by:

getConfig in interface FormatPlugin

getStorageConfig

public StoragePluginConfig getStorageConfig()

Specified by:

getStorageConfig in interface FormatPlugin

supportsRead

public boolean supportsRead()

Specified by:

supportsRead in interface FormatPlugin

supportsWrite

public boolean supportsWrite()

Specified by:

supportsWrite in interface FormatPlugin

supportsAutoPartitioning

public boolean supportsAutoPartitioning()

Description copied from interface: FormatPlugin

Indicates whether this FormatPlugin supports auto-partitioning for CTAS statements

Specified by:

supportsAutoPartitioning in interface FormatPlugin

Returns:

true if auto-partitioning is supported

getMatcher

public FormatMatcher getMatcher()

Specified by:

getMatcher in interface FormatPlugin

getOptimizerRules

public Set<StoragePluginOptimizerRule> getOptimizerRules()

Specified by:

getOptimizerRules in interface FormatPlugin

getReaderOperatorType

public abstract int getReaderOperatorType()

getWriterOperatorType

public abstract int getWriterOperatorType()