Package org.apache.drill.exec.store.dfs

Interface FormatPlugin

All Known Implementing Classes:

AvroFormatPlugin, BasePcapFormatPlugin, DeltaFormatPlugin, EasyFormatPlugin, ExcelFormatPlugin, HDF5FormatPlugin, HttpdLogFormatPlugin, IcebergFormatPlugin, ImageFormatPlugin, JSONFormatPlugin, LogFormatPlugin, LTSVFormatPlugin, MSAccessFormatPlugin, ParquetFormatPlugin, PcapFormatPlugin, PcapngFormatPlugin, PdfFormatPlugin, SasFormatPlugin, SequenceFileFormatPlugin, ShpFormatPlugin, SpssFormatPlugin, SyslogFormatPlugin, TextFormatPlugin, XMLFormatPlugin

public interface FormatPlugin

Similar to a storage engine but built specifically to work within a FileSystem context.

Method Summary

Modifier and Type	Method	Description
FormatPluginConfig	getConfig()
DrillbitContext	getContext()
org.apache.hadoop.conf.Configuration	getFsConf()
AbstractGroupScan	getGroupScan(String userName, FileSelection selection, List<SchemaPath> columns)
default AbstractGroupScan	getGroupScan(String userName, FileSelection selection, List<SchemaPath> columns, MetadataProviderManager metadataProviderManager)
default AbstractGroupScan	getGroupScan(String userName, FileSelection selection, List<SchemaPath> columns, OptionManager options)
default AbstractGroupScan	getGroupScan(String userName, FileSelection selection, List<SchemaPath> columns, OptionManager options, MetadataProviderManager metadataProvider)
FormatMatcher	getMatcher()
String	getName()
default Set<? extends org.apache.calcite.plan.RelOptRule>	getOptimizerRules()	Deprecated.
default Set<? extends org.apache.calcite.plan.RelOptRule>	getOptimizerRules(PlannerPhase phase)
StoragePluginConfig	getStorageConfig()
AbstractWriter	getWriter(PhysicalOperator child, String location, List<String> partitionColumns)
DrillStatsTable.TableStatistics	readStatistics(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path statsTablePath)
boolean	supportsAutoPartitioning()	Indicates whether this FormatPlugin supports auto-partitioning for CTAS statements
boolean	supportsRead()
boolean	supportsStatistics()
boolean	supportsWrite()
void	writeStatistics(DrillStatsTable.TableStatistics statistics, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path statsTablePath)

Method Details

supportsRead

boolean supportsRead()

supportsWrite

boolean supportsWrite()

supportsAutoPartitioning

boolean supportsAutoPartitioning()

Indicates whether this FormatPlugin supports auto-partitioning for CTAS statements

Returns:

true if auto-partitioning is supported

getMatcher

FormatMatcher getMatcher()

getWriter

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

Throws:

IOException

getOptimizerRules

@Deprecated
default Set<? extends org.apache.calcite.plan.RelOptRule> getOptimizerRules()

Deprecated.

getOptimizerRules

default Set<? extends org.apache.calcite.plan.RelOptRule> getOptimizerRules(PlannerPhase phase)

getGroupScan

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

Throws:

IOException

getGroupScan

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

Throws:

IOException

getGroupScan

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

Throws:

IOException

getGroupScan

default AbstractGroupScan getGroupScan(String userName,
 FileSelection selection,
 List<SchemaPath> columns,
 OptionManager options,
 MetadataProviderManager metadataProvider)
                                throws IOException

Throws:

IOException

supportsStatistics

boolean supportsStatistics()

readStatistics

DrillStatsTable.TableStatistics readStatistics(org.apache.hadoop.fs.FileSystem fs,
 org.apache.hadoop.fs.Path statsTablePath)
                                        throws IOException

Throws:

IOException

writeStatistics

void writeStatistics(DrillStatsTable.TableStatistics statistics,
 org.apache.hadoop.fs.FileSystem fs,
 org.apache.hadoop.fs.Path statsTablePath)
              throws IOException

Throws:

IOException

getConfig

FormatPluginConfig getConfig()

getStorageConfig

StoragePluginConfig getStorageConfig()

getFsConf

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

getContext

DrillbitContext getContext()

getName

String getName()