AuditTableFile

Instance Constructors

new AuditTableFile(tableInfo: AuditTableInfo, regions: Seq[AuditTableRegionInfo], storageOps: FileStorageOps, baseFolder: Path, newRegionID: (AuditTableFile) ⇒ String)

tableInfo
static details about the table, with custom metadata
regions
list of region details
storageOps
object that actually interacts with the physical storage
baseFolder
parent folder which contains folders with table names
newRegionID
function that generates region ids

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
def activeRegionIDs(): Option[Seq[String]]

Returns regions ids for all active regions.
def allBetween(from: Option[Timestamp], to: Option[Timestamp]): Option[Dataset[_]]

Include all records between the given timestamps.
Include all records between the given timestamps.
returns
if no data in storage layer, return None

Definition Classes
AuditTableFile → AuditTable
def append(ds: Dataset[_], lastUpdated: Column, appendTS: Timestamp): Try[(AuditTable, Long)]

Appends a new set of records to the audit table.
Appends a new set of records to the audit table.
Fails when is called second time on same instance.
ds
records to append
lastUpdated
column that returns java.sql.Timestamp that will be used for de-duplication on the primary keys
appendTS
timestamp of when the append has happened. It will not be used for de-duplications
returns
(new state of the AuditTable, count of appended records) or error

Definition Classes
AuditTableFile → AuditTable
final def asInstanceOf[T0]: T0

Definition Classes
Any
val baseFolder: Path

parent folder which contains folders with table names
def calcRegionStats(ds: Dataset[_]): (Long, Timestamp)

Attributes
protected
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val coldPath: Path

Attributes
protected
def commitHotToCold(compactTS: Timestamp, rowsPerPartition: Int): Try[AuditTableFile]

Compacts all hot regions into one cold.
Compacts all hot regions into one cold.

Attributes
protected
def compact(compactTS: Timestamp, trashMaxAge: Duration): Try[AuditTableFile.this.type]

Request optimisation of the storage layer.
Request optimisation of the storage layer.
Fails when is called second time on same instance.
compactTS
timestamp of when the compaction is requested, will not be used for any filtering of the data
trashMaxAge
Maximum age of old region files kept in the .Trash folder after a compaction has happened.
returns
new state of the AuditTable

Definition Classes
AuditTableFile → AuditTable
def compactCold(compactTS: Timestamp, rowsPerRegion: Int, rowsPerPartition: Int): Try[AuditTableFile]

Merges all regions below specific fresh cold into one cold region.
Merges all regions below specific fresh cold into one cold region.

Attributes
protected
def compactRegions(typePath: Path, toCompact: Seq[AuditTableRegionInfo], compactTS: Timestamp, rowsPerPartition: Int): Try[AuditTableFile]

Attributes
protected
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 getLatestTimestamp(): Option[Timestamp]

Returns latest timestamp of records stored in the audit table.
Returns latest timestamp of records stored in the audit table.

Definition Classes
AuditTableFile → AuditTable
def hashCode(): Int

Definition Classes
AnyRef → Any
val hotPath: Path

Attributes
protected
def initNewTable(): Try[AuditTableFile.this.type]

Initializes audit table in the storage layer.
Initializes audit table in the storage layer. It will also persist all of the metadata (name, primary keys, custom meta) to the storage layer.
returns
new state of the table or error

Definition Classes
AuditTableFile → AuditTable
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isTraceEnabled(): Boolean

Attributes
protected
Definition Classes
Logging
def logDebug(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logDebug(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logError(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logError(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logInfo(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logInfo(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logName: String

Attributes
protected
Definition Classes
Logging
def logTrace(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logTrace(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logWarning(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logWarning(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def markToUpdate(): Unit

Each function that modifies the state of the storage layer must call this function in the first line.
Each function that modifies the state of the storage layer must call this function in the first line. As audit's table state can be modified only once.

Attributes
protected
def meta: Map[String, String]

Custom attributes assigned by the client application during table creation.
Custom attributes assigned by the client application during table creation.

Definition Classes
AuditTableFile → AuditTable
val metaBasePath: Path

Attributes
protected
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val newRegionID: (AuditTableFile) ⇒ String

function that generates region ids
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val regionInfoBasePath: Path

Attributes
protected
val regions: Seq[AuditTableRegionInfo]

list of region details
list of region details

Definition Classes
AuditTableFile → AuditTable
def snapshot(ts: Timestamp): Option[Dataset[_]]

Generates snapshot that contains only the latest records for the given timestamp.
Generates snapshot that contains only the latest records for the given timestamp. De-duplication happens on the primary keys.
ts
use records that are closest to this timestamp
returns
if no data in storage layer, return None

Definition Classes
AuditTableFile → AuditTable
val storageOps: FileStorageOps

object that actually interacts with the physical storage
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tableInfo: AuditTableInfo

static details about the table, with custom metadata
def tableName: String

Name of the table.
Name of the table.

Definition Classes
AuditTableFile → AuditTable
val tablePath: Path

Attributes
protected
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( ... )
var wasModified: Boolean

Not thread safe.
Not thread safe. Protection against using mutator functions more than one time.

Attributes
protected

Related Docs: object AuditTableFile | package storage

class AuditTableFile extends AuditTable with Logging

Instance Constructors

new AuditTableFile(tableInfo: AuditTableInfo, regions: Seq[AuditTableRegionInfo], storageOps: FileStorageOps, baseFolder: Path, newRegionID: (AuditTableFile) ⇒ String)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def activeRegionIDs(): Option[Seq[String]]

def allBetween(from: Option[Timestamp], to: Option[Timestamp]): Option[Dataset[_]]

def append(ds: Dataset[_], lastUpdated: Column, appendTS: Timestamp): Try[(AuditTable, Long)]

final def asInstanceOf[T0]: T0

val baseFolder: Path

def calcRegionStats(ds: Dataset[_]): (Long, Timestamp)

def clone(): AnyRef

val coldPath: Path

def commitHotToCold(compactTS: Timestamp, rowsPerPartition: Int): Try[AuditTableFile]

def compact(compactTS: Timestamp, trashMaxAge: Duration): Try[AuditTableFile.this.type]

def compactCold(compactTS: Timestamp, rowsPerRegion: Int, rowsPerPartition: Int): Try[AuditTableFile]

def compactRegions(typePath: Path, toCompact: Seq[AuditTableRegionInfo], compactTS: Timestamp, rowsPerPartition: Int): Try[AuditTableFile]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getLatestTimestamp(): Option[Timestamp]

def hashCode(): Int

val hotPath: Path

def initNewTable(): Try[AuditTableFile.this.type]

final def isInstanceOf[T0]: Boolean

def isTraceEnabled(): Boolean

def logDebug(msg: ⇒ String, throwable: Throwable): Unit

def logDebug(msg: ⇒ String): Unit

def logError(msg: ⇒ String, throwable: Throwable): Unit

def logError(msg: ⇒ String): Unit

def logInfo(msg: ⇒ String, throwable: Throwable): Unit

def logInfo(msg: ⇒ String): Unit

def logName: String

def logTrace(msg: ⇒ String, throwable: Throwable): Unit

def logTrace(msg: ⇒ String): Unit

def logWarning(msg: ⇒ String, throwable: Throwable): Unit

def logWarning(msg: ⇒ String): Unit

def markToUpdate(): Unit

def meta: Map[String, String]

val metaBasePath: Path

final def ne(arg0: AnyRef): Boolean

val newRegionID: (AuditTableFile) ⇒ String

final def notify(): Unit

final def notifyAll(): Unit

val regionInfoBasePath: Path

val regions: Seq[AuditTableRegionInfo]

def snapshot(ts: Timestamp): Option[Dataset[_]]

val storageOps: FileStorageOps

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

val tableInfo: AuditTableInfo

def tableName: String

val tablePath: Path

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

var wasModified: Boolean

Inherited from Logging

Inherited from AuditTable

Inherited from AnyRef

Inherited from Any

Ungrouped