db - com.ironcorelabs.davenport.db

Type Members

final case class CommitVersion(value: Long) extends AnyVal with Product with Serializable

A commit version of an existing value in the db.
A commit version of an existing value in the db.
Couchbase calls this a CAS (check and save) as it is passed back in with requests to update a value. If the value has been changed by another actor, then the update fails and the caller is left to handle the conflict.
final case class CommitVersionMismatch(key: Key) extends DBError with Product with Serializable

If the CommitVersion for an update doesn't match.
final case class CreateDoc(key: Key, doc: RawJsonString) extends DBOp[\/[DBError, DBValue]] with Product with Serializable
final case class DBDocument[A](key: Key, commitVersion: CommitVersion, data: A) extends Product with Serializable

A document that's either destined to be put into the DB or came out of the DB.
A document that's either destined to be put into the DB or came out of the DB. Key - The key where the document is stored. commitVersion - The CommitVersion of the current document data - The data stored in the document, typically RawJsonString when it comes out of the DB.
sealed abstract class DBError extends AnyRef

ADT for errors that might happen in working with our grammar.
sealed trait DBOp[A] extends AnyRef

Any database operation must be represented by a DBOp
type DBOps[A] = Free[[x]Coyoneda[DBOp, x], A]

A Free Co-yoneda of DBOp classes
type DBProg[A] = EitherT[DBOps, DBError, A]

The basic building block sent to the datastore.
The basic building block sent to the datastore.
Effectively this captures expected return type of DBError \/ A and a series of DBOp classes or functions combined together. When passed to an datastore such as MemDatastore or CouchDatastore, these are executed.
type DBValue = DBDocument[RawJsonString]

Convienent alias for the document type we return.
final case class DeserializationError(key: Key, errorMessage: String) extends DBError with Product with Serializable

Deserialization failures will be wrapped up in this type.
Deserialization failures will be wrapped up in this type.
key
The key that was requested
errorMessage
The underlying failure message from the parse failure.
final case class GeneralError(ex: Throwable) extends DBError with Product with Serializable

All other errors will be exceptions that come out of the underlying store.
All other errors will be exceptions that come out of the underlying store. They'll be wrapped up in this type.
final case class GetCounter(key: Key) extends DBOp[\/[DBError, Long]] with Product with Serializable
final case class GetDoc(key: Key) extends DBOp[\/[DBError, DBValue]] with Product with Serializable
final case class IncrementCounter(key: Key, delta: Long = 1) extends DBOp[\/[DBError, Long]] with Product with Serializable
final case class Key(value: String) extends AnyVal with Product with Serializable

Just a string.
Just a string. This is used for type safety.
final case class RawJsonString(value: String) extends AnyVal with Product with Serializable

Just a string.
Just a string. This is used for type safety.
final case class RemoveKey(key: Key) extends DBOp[\/[DBError, Unit]] with Product with Serializable
final case class UpdateDoc(key: Key, doc: RawJsonString, commitVersion: CommitVersion) extends DBOp[\/[DBError, DBValue]] with Product with Serializable
final case class ValueExists(key: Key) extends DBError with Product with Serializable

If a value already exists at key.
final case class ValueNotFound(key: Key) extends DBError with Product with Serializable

If no value was found at the requested key.

Value Members

object DBDocument extends Serializable
implicit val DBOpsMonad: Monad[DBOps]
object RawJsonString extends Serializable
object batch

Object that contains batch operations for DB.
Object that contains batch operations for DB. They have been separated out because they cannot be mixed with DBProg operations without first lifting them into a process via liftToProcess.
def createDoc(k: Key, doc: RawJsonString): DBProg[DBValue]

Create a document with the given key
def getCounter(k: Key): DBProg[Long]

Fetch a counter from the DB given a key
def getDoc(k: Key): DBProg[DBValue]

Return a document given some key
def incrementCounter(k: Key, delta: Long = 1): DBProg[Long]

Increment a counter in the DB and return for some key and delta
def liftDisjunction[A](either: \/[DBError, A]): DBProg[A]
def liftIntoDBProg[A](either: \/[Throwable, A]): DBProg[A]
def liftIntoDBProg[A](opt: Option[A], errormessage: String): DBProg[A]
def liftIntoDBProg[A](opt: Option[A], dbError: DBError): DBProg[A]

The liftIntoDBProg operations allow any function or value to be deferred to the executor.
The liftIntoDBProg operations allow any function or value to be deferred to the executor.
This will most often be used when using for comprehensions mixing DBOp operations with other data extraction such as json de/serialization.
def modifyDoc(k: Key, f: (RawJsonString) ⇒ RawJsonString): DBProg[DBValue]

Convenience function to fetch a doc and transform it via a function f
Convenience function to fetch a doc and transform it via a function f
In practice, this is more an example showing how to build a function like this. More commonly a higher level class that can be serialized to the db will have a modify function that transforms and calls this under the hood.
def removeKey(k: Key): DBProg[Unit]

Remove a doc from the DB given its key
def updateDoc(k: Key, doc: RawJsonString, commitVersion: CommitVersion): DBProg[DBValue]

Update a doc given its key, new value, and correct commitVersion

db

package db

Type Members

final case class CommitVersion(value: Long) extends AnyVal with Product with Serializable

final case class CommitVersionMismatch(key: Key) extends DBError with Product with Serializable

final case class CreateDoc(key: Key, doc: RawJsonString) extends DBOp[\/[DBError, DBValue]] with Product with Serializable

final case class DBDocument[A](key: Key, commitVersion: CommitVersion, data: A) extends Product with Serializable

sealed abstract class DBError extends AnyRef

sealed trait DBOp[A] extends AnyRef

type DBOps[A] = Free[[x]Coyoneda[DBOp, x], A]

type DBProg[A] = EitherT[DBOps, DBError, A]

type DBValue = DBDocument[RawJsonString]

final case class DeserializationError(key: Key, errorMessage: String) extends DBError with Product with Serializable

final case class GeneralError(ex: Throwable) extends DBError with Product with Serializable

final case class GetCounter(key: Key) extends DBOp[\/[DBError, Long]] with Product with Serializable

final case class GetDoc(key: Key) extends DBOp[\/[DBError, DBValue]] with Product with Serializable

final case class IncrementCounter(key: Key, delta: Long = 1) extends DBOp[\/[DBError, Long]] with Product with Serializable

final case class Key(value: String) extends AnyVal with Product with Serializable

final case class RawJsonString(value: String) extends AnyVal with Product with Serializable

final case class RemoveKey(key: Key) extends DBOp[\/[DBError, Unit]] with Product with Serializable

final case class UpdateDoc(key: Key, doc: RawJsonString, commitVersion: CommitVersion) extends DBOp[\/[DBError, DBValue]] with Product with Serializable

final case class ValueExists(key: Key) extends DBError with Product with Serializable

final case class ValueNotFound(key: Key) extends DBError with Product with Serializable

Value Members

object DBDocument extends Serializable

implicit val DBOpsMonad: Monad[DBOps]

object RawJsonString extends Serializable

object batch

def createDoc(k: Key, doc: RawJsonString): DBProg[DBValue]

def getCounter(k: Key): DBProg[Long]

def getDoc(k: Key): DBProg[DBValue]

def incrementCounter(k: Key, delta: Long = 1): DBProg[Long]

def liftDisjunction[A](either: \/[DBError, A]): DBProg[A]

def liftIntoDBProg[A](either: \/[Throwable, A]): DBProg[A]

def liftIntoDBProg[A](opt: Option[A], errormessage: String): DBProg[A]

def liftIntoDBProg[A](opt: Option[A], dbError: DBError): DBProg[A]

def modifyDoc(k: Key, f: (RawJsonString) ⇒ RawJsonString): DBProg[DBValue]

def removeKey(k: Key): DBProg[Unit]

def updateDoc(k: Key, doc: RawJsonString, commitVersion: CommitVersion): DBProg[DBValue]

Inherited from AnyRef

Inherited from Any

Ungrouped