FileSystemStorage

Abstract Value Members

abstract def context: FileSystemContext

Handle to the file context, root path and configuration
abstract def getFilePaths(partition: String): Seq[StorageFilePath]

Get the full paths to any files contained in the partition
Get the full paths to any files contained in the partition
partition
partition
returns
file paths
abstract def getReader(query: Query, partition: Option[String] = None, threads: Int = 1): CloseableFeatureIterator

Get a reader for all relevant partitions
Get a reader for all relevant partitions
query
query
partition
restrict results to a single partition
threads
suggested threads used for reading data files
returns
reader
abstract def getWriter(filter: Filter, partition: Option[String] = None, threads: Int = 1): FileSystemUpdateWriter

Gets a modifying writer.
Gets a modifying writer. This method is thread-safe and can be called multiple times, although if a feature is modified multiple times concurrently, the last update 'wins'. There is no guarantee that any concurrent modifications will be reflected in the returned writer.
filter
the filter used to select features for modification
partition
restrict results to a single partition (writes will go to the appropriate partition, regardless)
threads
suggested threads used for reading data files
abstract def getWriter(partition: String): FileSystemWriter

Get a writer for a given partition.
Get a writer for a given partition. This method is thread-safe and can be called multiple times, although this can result in multiple data files.
partition
partition
returns
writer
abstract def metadata: StorageMetadata

The metadata for this storage instance
The metadata for this storage instance
returns
metadata
abstract def compact(partition: Option[String], threads: Int): Unit

Compact a partition - merge multiple data files into a single file.
Compact a partition - merge multiple data files into a single file.
Care should be taken with this method. Currently, there is no guarantee for correct behavior if multiple threads or storage instances attempt to compact the same partition simultaneously.
partition
partition to compact, or all partitions
threads
suggested threads to use for file system operations

Definition Classes
Compactable
Annotations
@deprecated
Deprecated
replaced with compact(Option[String], Option[Long], Int)

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(): Unit

Definition Classes
FileSystemStorage → Closeable → AutoCloseable
def compact(partition: Option[String], fileSize: Option[Long] = None, threads: Int = 1): Unit

Compact a partition - merge multiple data files into a single file.
Compact a partition - merge multiple data files into a single file.
Care should be taken with this method. Currently, there is no guarantee for correct behavior if multiple threads or storage instances attempt to compact the same partition simultaneously.
partition
partition to compact, or all partitions
fileSize
approximate target size of files, in bytes
threads
suggested threads to use for file system operations

Definition Classes
Compactable
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getPartitionFilters(filter: Filter, partition: Option[String] = None): Seq[PartitionFilter]

Get partitions that match a given filter.
Get partitions that match a given filter. Each set of partitions will have a simplified filter that should be applied to that set
If there are no partitions that match the filter, an empty list will be returned
returns
partitions and predicates for each partition
def getPartitions(filter: Filter): Seq[PartitionMetadata]

Gets a list of partitions that match the given filter
Gets a list of partitions that match the given filter
returns
partitions
def getPartitions: Seq[PartitionMetadata]

Pass through to get all partitions from the metadata
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object FileSystemStorage | package api

trait FileSystemStorage extends Compactable with Closeable

Abstract Value Members

abstract def context: FileSystemContext

abstract def getFilePaths(partition: String): Seq[StorageFilePath]

abstract def getReader(query: Query, partition: Option[String] = None, threads: Int = 1): CloseableFeatureIterator

abstract def getWriter(filter: Filter, partition: Option[String] = None, threads: Int = 1): FileSystemUpdateWriter

abstract def getWriter(partition: String): FileSystemWriter

abstract def metadata: StorageMetadata

abstract def compact(partition: Option[String], threads: Int): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close(): Unit

def compact(partition: Option[String], fileSize: Option[Long] = None, threads: Int = 1): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getPartitionFilters(filter: Filter, partition: Option[String] = None): Seq[PartitionFilter]

def getPartitions(filter: Filter): Seq[PartitionMetadata]

def getPartitions: Seq[PartitionMetadata]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Closeable

Inherited from AutoCloseable

Inherited from Compactable

Inherited from AnyRef

Inherited from Any

Ungrouped