Packages

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

    Checks if the underlying table exists

    Checks if the underlying table exists

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

    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

    Creates the underlying table

    Creates the underlying table

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

    Deletes multiple rows

    Deletes multiple rows

    typeName

    simple feature type name

    keys

    keys

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

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

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

    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]

    Serializer

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

    Writes key/value pairs

    Writes key/value pairs

    rows

    keys/values

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def backup(typeName: String): Unit

    Create a back up of this metadata

    Create a back up of this metadata

    typeName

    simple feature type name

    Definition Classes
    TableBasedMetadata → GeoMesaMetadata
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def delete(typeName: String): Unit

    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
    TableBasedMetadata → GeoMesaMetadata
  8. def ensureTableExists(): Unit
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def getFeatureTypes: Array[String]

    Returns existing simple feature types

    Returns existing simple feature types

    returns

    simple feature type names

    Definition Classes
    TableBasedMetadata → GeoMesaMetadata
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def insert(typeName: String, kvPairs: Map[String, T]): Unit

    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
    TableBasedMetadata → GeoMesaMetadata
  15. def insert(typeName: String, key: String, value: T): Unit

    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
    TableBasedMetadata → GeoMesaMetadata
  16. def invalidateCache(typeName: String, key: String): Unit

    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
    TableBasedMetadata → GeoMesaMetadata
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. lazy val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
    Annotations
    @transient()
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def read(typeName: String, key: String, cache: Boolean): Option[T]

    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
    TableBasedMetadata → GeoMesaMetadata
  23. def readRequired(typeName: String, key: String): T

    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
  24. def remove(typeName: String, keys: Seq[String]): Unit

    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
    TableBasedMetadata → GeoMesaMetadata
  25. def remove(typeName: String, key: String): Unit

    Delete a key

    Delete a key

    typeName

    simple feature type name

    key

    key

    Definition Classes
    TableBasedMetadata → GeoMesaMetadata
  26. def resetCache(): Unit

    table cache should be cleared up when catalog is deleted in database

    table cache should be cleared up when catalog is deleted in database

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

    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
    TableBasedMetadata → GeoMesaMetadata
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from LazyLogging

Inherited from GeoMesaMetadata[T]

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped