StorageMetadata

Abstract Value Members

abstract def addPartition(partition: PartitionMetadata): Unit

Add (or update) metadata for a partition
Add (or update) metadata for a partition
partition
partition
abstract def close(): Unit

Definition Classes
Closeable → AutoCloseable
Annotations
@throws( classOf[java.io.IOException] )
abstract def encoding: String

The encoding of the underlying data files
The encoding of the underlying data files
returns
encoding
abstract def getPartition(name: String): Option[PartitionMetadata]

Get a partition by name.
Get a partition by name. Ensure that reload has been invoked at least once before calling this method
name
partition name
returns
partition metadata, if partition exists
abstract def getPartitions(prefix: Option[String] = None): Seq[PartitionMetadata]

Get all partitions, with an optional prefix filter.
Get all partitions, with an optional prefix filter. Ensure that reload has been invoked at least once before calling this method
prefix
prefix used to match partition names
returns
all partitions
abstract def leafStorage: Boolean

Are partitions stored as leaves (multiple partitions in a single folder), or does each partition have a unique folder.
Are partitions stored as leaves (multiple partitions in a single folder), or does each partition have a unique folder. Using leaf storage can reduce the level of nesting and make file system operations faster in some cases.
returns
leaf
abstract def removePartition(partition: PartitionMetadata): Unit

Update (or delete) metadata for a partition
Update (or delete) metadata for a partition
partition
partition
abstract def scheme: PartitionScheme

The partition scheme used to partition features for storage and querying
The partition scheme used to partition features for storage and querying
returns
partition scheme
abstract def sft: SimpleFeatureType

The schema for SimpleFeatures stored in the file system storage
The schema for SimpleFeatures stored in the file system storage
returns
schema
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 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] )
def get(key: String): Option[String]

Get a previously set key-value pair
Get a previously set key-value pair
key
key
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def invalidate(): Unit

Invalidate any cached state
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
def set(key: String, value: String): Unit

Set a key-value pair
Set a key-value pair
key
key
value
value
def setPartitions(partitions: Seq[PartitionMetadata]): Unit

Overwrite any existing partitions
Overwrite any existing partitions
partitions
partitions
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( ... )

Deprecated Value Members

def reload(): Unit

Annotations
@deprecated
Deprecated
deprecated with no replacement

Related Docs: object StorageMetadata | package api

trait StorageMetadata extends Compactable with Closeable

Abstract Value Members

abstract def addPartition(partition: PartitionMetadata): Unit

abstract def close(): Unit

abstract def encoding: String

abstract def getPartition(name: String): Option[PartitionMetadata]

abstract def getPartitions(prefix: Option[String] = None): Seq[PartitionMetadata]

abstract def leafStorage: Boolean

abstract def removePartition(partition: PartitionMetadata): Unit

abstract def scheme: PartitionScheme

abstract def sft: SimpleFeatureType

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 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

def get(key: String): Option[String]

final def getClass(): Class[_]

def hashCode(): Int

def invalidate(): Unit

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def set(key: String, value: String): Unit

def setPartitions(partitions: Seq[PartitionMetadata]): 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

Deprecated Value Members

def reload(): Unit

Inherited from Closeable

Inherited from AutoCloseable

Inherited from Compactable

Inherited from AnyRef

Inherited from Any

Ungrouped