org.apache.predictionio.data

storage

package storage

If you are an engine developer, please refer to the store package.

This package provides convenient access to underlying data access objects. The common entry point is Storage.

Developer APIs are available to advanced developers to add support of other data store backends.

Linear Supertypes
AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. storage
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class AccessKey(key: String, appid: Int, events: Seq[String]) extends Product with Serializable

    :: DeveloperApi :: Stores mapping of access keys, app IDs, and lists of allowed event names

  2. trait AccessKeys extends AnyRef

    :: DeveloperApi :: Base trait of the AccessKey data access object

  3. case class App(id: Int, name: String, description: Option[String]) extends Product with Serializable

    :: DeveloperApi :: Stores mapping of app IDs and names

  4. trait Apps extends AnyRef

    :: DeveloperApi :: Base trait of the App data access object

  5. trait BaseStorageClient extends AnyRef

    :: DeveloperApi :: Any storage backend drivers will need to implement this trait with exactly StorageClient as the class name.

  6. class BiMap[K, V] extends Serializable

    Immutable Bi-directional Map

  7. case class Channel(id: Int, name: String, appid: Int) extends Product with Serializable

    :: DeveloperApi :: Stores mapping of channel IDs, names and app ID

  8. trait Channels extends AnyRef

    :: DeveloperApi :: Base trait of the Channel data access object

  9. class DataMap extends Serializable

    A DataMap stores properties of the event or entity.

  10. case class DataMapException(msg: String, cause: Exception) extends Exception with Product with Serializable

    Exception class for DataMap

  11. case class EngineInstance(id: String, status: String, startTime: com.github.nscala_time.time.Imports.DateTime, endTime: com.github.nscala_time.time.Imports.DateTime, engineId: String, engineVersion: String, engineVariant: String, engineFactory: String, batch: String, env: Map[String, String], sparkConf: Map[String, String], dataSourceParams: String, preparatorParams: String, algorithmsParams: String, servingParams: String) extends Product with Serializable

    :: DeveloperApi :: Stores parameters, model, and other information for each engine instance

  12. class EngineInstanceSerializer extends CustomSerializer[EngineInstance]

    :: DeveloperApi :: JSON4S serializer for EngineInstance

  13. trait EngineInstances extends AnyRef

    :: DeveloperApi :: Base trait of the EngineInstance data access object

  14. class EntityIdIxMap extends Serializable

    :: Experimental ::

  15. class EntityMap[A] extends EntityIdIxMap

    :: Experimental ::

  16. case class EvaluationInstance(id: String = "", status: String = "", startTime: com.github.nscala_time.time.Imports.DateTime = ..., endTime: com.github.nscala_time.time.Imports.DateTime = ..., evaluationClass: String = "", engineParamsGeneratorClass: String = "", batch: String = "", env: Map[String, String] = ..., sparkConf: Map[String, String] = ..., evaluatorResults: String = "", evaluatorResultsHTML: String = "", evaluatorResultsJSON: String = "") extends Product with Serializable

    :: DeveloperApi :: Stores meta information for each evaluation instance.

  17. class EvaluationInstanceSerializer extends CustomSerializer[EvaluationInstance]

    :: DeveloperApi :: JSON4S serializer for EvaluationInstance

  18. trait EvaluationInstances extends AnyRef

    :: DeveloperApi :: Base trait of the EvaluationInstance data access object

  19. case class Event(eventId: Option[String] = scala.None, event: String, entityType: String, entityId: String, targetEntityType: Option[String] = scala.None, targetEntityId: Option[String] = scala.None, properties: DataMap = DataMap.apply(), eventTime: DateTime = org.joda.time.DateTime.now(), tags: Seq[String] = immutable.this.Nil, prId: Option[String] = scala.None, creationTime: DateTime = org.joda.time.DateTime.now()) extends Product with Serializable

    Each event in the Event Store can be represented by fields in this case class.

  20. trait LEvents extends AnyRef

    :: DeveloperApi :: Base trait of a data access object that directly returns Event without going through Spark's parallelization.

  21. case class Model(id: String, models: Array[Byte]) extends Product with Serializable

    :: DeveloperApi :: Stores model for each engine instance

  22. class ModelSerializer extends CustomSerializer[Model]

    :: DeveloperApi :: JSON4S serializer for Model

  23. trait Models extends AnyRef

    :: DeveloperApi :: Base trait for of the Model data access object

  24. case class NullModel() extends Product with Serializable

  25. trait PEvents extends Serializable

    :: DeveloperApi :: Base trait of a data access object that returns Event related RDD data structure.

  26. class PropertyMap extends DataMap

    A PropertyMap stores aggregated properties of the entity.

  27. case class StorageClientConfig(parallel: Boolean = false, test: Boolean = false, properties: Map[String, String] = ...) extends Product with Serializable

    :: DeveloperApi :: A wrapper of storage client configuration that will be populated by PredictionIO automatically, and passed to the StorageClient during instantiation.

  28. class StorageClientException extends RuntimeException

    :: DeveloperApi :: Thrown when a StorageClient runs into an exceptional condition

  29. class StorageException extends Exception

    :: DeveloperApi :: Thrown by data access objects when they run into exceptional conditions

Value Members

  1. object BatchEventsJson4sSupport

    Annotations
    @DeveloperApi()
  2. object BiMap extends Serializable

  3. object Channel extends Serializable

    :: DeveloperApi :: Companion object of Channel

  4. object DataMap extends Serializable

    Companion object of the DataMap class

  5. object DateTimeJson4sSupport

    :: DeveloperApi :: JSON4S serializer for Joda-Time

  6. object EntityIdIxMap extends Serializable

    :: Experimental ::

  7. object EventJson4sSupport

    :: DeveloperApi :: Support library for dealing with Event and JSON4S

  8. object EventValidation

    :: DeveloperApi :: Utilities for validating Events

  9. object LEventAggregator

    :: DeveloperApi :: Provides aggregation support of Events to LEvents.

  10. object PropertyMap extends Serializable

    Companion object of the PropertyMap class.

  11. object Storage extends Logging

    Backend-agnostic data storage layer with lazy initialization.

  12. package elasticsearch

    Elasticsearch implementation of storage traits, supporting meta data only

  13. package hbase

    HBase implementation of storage traits, supporting event data only

  14. package hdfs

    HDFS implementation of storage traits, supporting model data only

  15. package jdbc

    JDBC implementation of storage traits, supporting meta data, event data, and model data

  16. package localfs

    Local file system implementation of storage traits, supporting model data only

Inherited from AnyRef

Inherited from Any

Common

Event Data

Implementation

Meta Data

Model Data

Storage System

Ungrouped