Package org.apache.druid.data.input.impl

Class LocalInputSource

java.lang.Object

org.apache.druid.data.input.AbstractInputSource

org.apache.druid.data.input.impl.LocalInputSource

All Implemented Interfaces:

SplittableInputSource<List<File>>, SystemFieldInputSource, InputSource

public class LocalInputSource
extends AbstractInputSource
implements SplittableInputSource<List<File>>, SystemFieldInputSource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_KEY

Fields inherited from interface org.apache.druid.data.input.InputSource

TYPE_PROPERTY

Fields inherited from interface org.apache.druid.data.input.impl.SplittableInputSource

DEFAULT_SPLIT_HINT_SPEC

Fields inherited from interface org.apache.druid.data.input.impl.systemfield.SystemFieldInputSource

SYSTEM_FIELDS_PROPERTY

Constructor Summary

Constructors

Constructor	Description
LocalInputSource(File baseDir, String filter)
LocalInputSource(File baseDir, String filter, List<File> files, SystemFields systemFields)

Method Summary

Modifier and Type	Method	Description
Stream<InputSplit<List<File>>>	createSplits(InputFormat inputFormat, SplitHintSpec splitHintSpec)	Creates a Stream of InputSplits.
boolean	equals(Object o)
int	estimateNumSplits(InputFormat inputFormat, SplitHintSpec splitHintSpec)	Returns an estimated total number of splits to be created via SplittableInputSource.createSplits(org.apache.druid.data.input.InputFormat, org.apache.druid.data.input.SplitHintSpec).
protected InputSourceReader	formattableReader(InputRowSchema inputRowSchema, InputFormat inputFormat, File temporaryDirectory)
File	getBaseDir()
Set<SystemField>	getConfiguredSystemFields()	System fields that this input source is configured to return.
List<File>	getFiles()
String	getFilter()
SystemFields	getSystemFields()
Object	getSystemFieldValue(InputEntity entity, SystemField field)	Compute the value of a system field for a particular InputEntity.
Set<String>	getTypes()	The types of input sources uses.
int	hashCode()
boolean	needsFormat()	Returns true if this inputSource supports different InputFormats.
String	toString()
SplittableInputSource<List<File>>	withSplit(InputSplit<List<File>> split)	Helper method for ParallelIndexSupervisorTask.

Methods inherited from class org.apache.druid.data.input.AbstractInputSource

fixedFormatReader, reader

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.druid.data.input.InputSource

reader

Methods inherited from interface org.apache.druid.data.input.impl.SplittableInputSource

getSplitHintSpecOrDefault, isSplittable

Field Details

TYPE_KEY

public static final String TYPE_KEY

See Also:

• Constant Field Values

Constructor Details

LocalInputSource

public LocalInputSource(@Nullable
 File baseDir,
 @Nullable
 String filter,
 @Nullable
 List<File> files,
 @Nullable
 SystemFields systemFields)

LocalInputSource

public LocalInputSource(File baseDir,
 String filter)

Method Details

getTypes

@Nonnull
public Set<String> getTypes()

Description copied from interface: InputSource

The types of input sources uses. A set is returned here, as some InputSource implementation allow for combining of multiple input sources.

Specified by:

getTypes in interface InputSource

Returns:

The types of input sources uses

getBaseDir

@Nullable
public File getBaseDir()

getFilter

@Nullable
public String getFilter()

getConfiguredSystemFields

public Set<SystemField> getConfiguredSystemFields()

Description copied from interface: SystemFieldInputSource

System fields that this input source is configured to return. This is not the same set that SystemFieldInputSource.getSystemFieldValue(InputEntity, SystemField) returns nonnull for. For example, if a LocalInputSource is configured to return SystemField.BUCKET then it will show up in this list, even though its value is always null. For another example in a different direction, if a LocalInputSource is *not* configured to return SystemField.URI, then it will *not* show up in this list, even though its value from SystemFieldInputSource.getSystemFieldValue(InputEntity, SystemField) would be nonnull.

Specified by:

getConfiguredSystemFields in interface SystemFieldInputSource

getSystemFields

public SystemFields getSystemFields()

getFiles

public List<File> getFiles()

createSplits

public Stream<InputSplit<List<File>>> createSplits(InputFormat inputFormat,
 @Nullable
 SplitHintSpec splitHintSpec)

Description copied from interface: SplittableInputSource

Creates a Stream of InputSplits. The returned stream is supposed to be evaluated lazily to avoid consuming too much memory. Note that this interface also has SplittableInputSource.estimateNumSplits(org.apache.druid.data.input.InputFormat, org.apache.druid.data.input.SplitHintSpec) which is related to this method. The implementations should be careful to NOT cache the created splits in memory. Implementations can consider InputFormat.isSplittable() and SplitHintSpec to create splits in the same way with SplittableInputSource.estimateNumSplits(org.apache.druid.data.input.InputFormat, org.apache.druid.data.input.SplitHintSpec).

Specified by:

createSplits in interface SplittableInputSource<List<File>>

estimateNumSplits

public int estimateNumSplits(InputFormat inputFormat,
 @Nullable
 SplitHintSpec splitHintSpec)

Description copied from interface: SplittableInputSource

Returns an estimated total number of splits to be created via SplittableInputSource.createSplits(org.apache.druid.data.input.InputFormat, org.apache.druid.data.input.SplitHintSpec). The estimated number of splits doesn't have to be accurate and can be different from the actual number of InputSplits returned from SplittableInputSource.createSplits(org.apache.druid.data.input.InputFormat, org.apache.druid.data.input.SplitHintSpec). This will be used to estimate the progress of a phase in parallel indexing. See TaskMonitor for more details of the progress estimation. This method can be expensive if an implementation iterates all directories or whatever substructure to find all input entities. Implementations can consider InputFormat.isSplittable() and SplitHintSpec to find splits in the same way with SplittableInputSource.createSplits(org.apache.druid.data.input.InputFormat, org.apache.druid.data.input.SplitHintSpec).

Specified by:

estimateNumSplits in interface SplittableInputSource<List<File>>

withSplit

public SplittableInputSource<List<File>> withSplit(InputSplit<List<File>> split)

Description copied from interface: SplittableInputSource

Helper method for ParallelIndexSupervisorTask. Most of implementations can simply create a new instance with the given split.

Specified by:

withSplit in interface SplittableInputSource<List<File>>

getSystemFieldValue

public Object getSystemFieldValue(InputEntity entity,
 SystemField field)

Description copied from interface: SystemFieldInputSource

Compute the value of a system field for a particular InputEntity.

Specified by:

getSystemFieldValue in interface SystemFieldInputSource

needsFormat

public boolean needsFormat()

Description copied from interface: InputSource

Returns true if this inputSource supports different InputFormats. Some inputSources such as LocalInputSource can store files of any format. These storage types require an InputFormat to be passed so that InputSourceReader can parse data properly. However, some storage types have a fixed format. For example, druid inputSource always reads segments. These inputSources should return false for this method.

Specified by:

needsFormat in interface InputSource

formattableReader

protected InputSourceReader formattableReader(InputRowSchema inputRowSchema,
 InputFormat inputFormat,
 @Nullable
 File temporaryDirectory)

Overrides:

formattableReader in class AbstractInputSource

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object