Trait/Object

org.locationtech.geomesa.index.metadata

TableBasedMetadata

Related Docs: object TableBasedMetadata | package metadata

Permalink

trait TableBasedMetadata[T] extends GeoMesaMetadata[T] with LazyLogging

Metadata persisted in a database table. The underlying table will be lazily created when required. Metadata values are cached with a configurable timeout to save repeated database reads.

T

type param

Linear Supertypes
LazyLogging, GeoMesaMetadata[T], Closeable, AutoCloseable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TableBasedMetadata
  2. LazyLogging
  3. GeoMesaMetadata
  4. Closeable
  5. AutoCloseable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def checkIfTableExists: Boolean

    Permalink

    Checks if the underlying table exists

    Checks if the underlying table exists

    Attributes
    protected
  2. abstract def close(): Unit

    Permalink
    Definition Classes
    Closeable → AutoCloseable
    Annotations
    @throws( classOf[java.io.IOException] )
  3. abstract def createEmptyBackup(timestamp: String): TableBasedMetadata[T]

    Permalink

    Create an instance to use for backup

    Create an instance to use for backup

    timestamp

    formatted timestamp for the current time

    Attributes
    protected
  4. abstract def createTable(): Unit

    Permalink

    Creates the underlying table

    Creates the underlying table

    Attributes
    protected
  5. abstract def delete(typeName: String, keys: Seq[String]): Unit

    Permalink

    Deletes multiple rows

    Deletes multiple rows

    typeName

    simple feature type name

    keys

    keys

    Attributes
    protected
  6. abstract def scanKeys(): CloseableIterator[(String, String)]

    Permalink

    Reads all row keys from the underlying table

    Reads all row keys from the underlying table

    returns

    matching tuples of (typeName, key)

    Attributes
    protected
  7. abstract def scanValue(typeName: String, key: String): Option[Array[Byte]]

    Permalink

    Reads a value from the underlying table

    Reads a value from the underlying table

    typeName

    simple feature type name

    key

    key

    returns

    value, if it exists

    Attributes
    protected
  8. abstract def scanValues(typeName: String, prefix: String = ""): CloseableIterator[(String, Array[Byte])]

    Permalink

    Reads row keys from the underlying table

    Reads row keys from the underlying table

    typeName

    simple feature type name

    prefix

    scan prefix, or empty string for all values

    returns

    matching tuples of (key, value)

    Attributes
    protected
  9. abstract def serializer: MetadataSerializer[T]

    Permalink

    Serializer

  10. abstract def write(typeName: String, rows: Seq[(String, Array[Byte])]): Unit

    Permalink

    Writes key/value pairs

    Writes key/value pairs

    rows

    keys/values

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. def backup(typeName: String): Unit

    Permalink

    Create a back up of this metadata

    Create a back up of this metadata

    typeName

    simple feature type name

    Definition Classes
    TableBasedMetadataGeoMesaMetadata
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def delete(typeName: String): Unit

    Permalink

    Deletes all values associated with a given feature type

    Deletes all values associated with a given feature type

    typeName

    simple feature type name

    Definition Classes
    TableBasedMetadataGeoMesaMetadata
  8. def ensureTableExists(): Unit

    Permalink
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def getFeatureTypes: Array[String]

    Permalink

    Returns existing simple feature types

    Returns existing simple feature types

    returns

    simple feature type names

    Definition Classes
    TableBasedMetadataGeoMesaMetadata
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. def insert(typeName: String, kvPairs: Map[String, T]): Unit

    Permalink

    Insert multiple values at once - may be more efficient than single inserts

    Insert multiple values at once - may be more efficient than single inserts

    typeName

    simple feature type name

    kvPairs

    key/values

    Definition Classes
    TableBasedMetadataGeoMesaMetadata
  16. def insert(typeName: String, key: String, value: T): Unit

    Permalink

    Insert a value - any existing value under the given key will be overwritten

    Insert a value - any existing value under the given key will be overwritten

    typeName

    simple feature type name

    key

    key

    value

    value

    Definition Classes
    TableBasedMetadataGeoMesaMetadata
  17. def invalidateCache(typeName: String, key: String): Unit

    Permalink

    Invalidates any cached value for the given key

    Invalidates any cached value for the given key

    typeName

    simple feature type name

    key

    key

    Definition Classes
    TableBasedMetadataGeoMesaMetadata
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. def read(typeName: String, key: String, cache: Boolean): Option[T]

    Permalink

    Reads a value

    Reads a value

    typeName

    simple feature type name

    key

    key

    cache

    may return a cached value if true, otherwise may use a slower lookup

    returns

    value, if present

    Definition Classes
    TableBasedMetadataGeoMesaMetadata
  24. def readRequired(typeName: String, key: String): T

    Permalink

    Reads a value.

    Reads a value. Throws an exception if value is missing

    typeName

    simple feature type name

    key

    key

    returns

    value

    Definition Classes
    GeoMesaMetadata
  25. def remove(typeName: String, keys: Seq[String]): Unit

    Permalink

    Delete multiple keys at once - may be more efficient than single deletes

    Delete multiple keys at once - may be more efficient than single deletes

    typeName

    simple feature type name

    keys

    keys

    Definition Classes
    TableBasedMetadataGeoMesaMetadata
  26. def remove(typeName: String, key: String): Unit

    Permalink

    Delete a key

    Delete a key

    typeName

    simple feature type name

    key

    key

    Definition Classes
    TableBasedMetadataGeoMesaMetadata
  27. def scan(typeName: String, prefix: String, cache: Boolean): Seq[(String, T)]

    Permalink

    Scan for keys starting with a given prefix

    Scan for keys starting with a given prefix

    typeName

    simple feature type name

    prefix

    key prefix

    cache

    may return a cached value if true, otherwise may use a slower lookup

    returns

    keys -> values

    Definition Classes
    TableBasedMetadataGeoMesaMetadata
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from LazyLogging

Inherited from GeoMesaMetadata[T]

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped