Portability	unknown
Stability	experimental
Maintainer	n.ohkawa@gmail.com
Safe Haskell	None

Database.Monarch

Description

Provide TokyoTyrant monadic access interface.

Synopsis

Documentation

type Monarch = MonarchT IO Source

IO Specialized

data MonarchT m a Source

The Monarch monad transformer to provide TokyoTyrant access.

Instances

MonadTrans MonarchT
MonadTransControl MonarchT
MonadBase base m => MonadBase base (MonarchT m)
MonadBaseControl base m => MonadBaseControl base (MonarchT m)
Monad m => MonadError Code (MonarchT m)
Monad m => MonadReader Connection (MonarchT m)
Monad m => Monad (MonarchT m)
Functor m => Functor (MonarchT m)
(Monad m, Functor m) => Applicative (MonarchT m)
MonadIO m => MonadIO (MonarchT m)
(MonadBaseControl IO m, MonadIO m) => MonadMonarch (MonarchT m)

data Connection Source

Connection with TokyoTyrant

Instances

Monad m => MonadReader Connection (MonarchT m)

type ConnectionPool = Pool Connection Source

Connection pool with TokyoTyrant

withMonarchConn Source

Arguments

:: (MonadBaseControl IO m, MonadIO m)
=> String	host
-> Int	port
-> (Connection -> m a)
-> m a

Create a TokyoTyrant connection and run the given action. Don't use the given Connection outside the action.

withMonarchPool Source

Arguments

:: (MonadBaseControl IO m, MonadIO m)
=> String	host
-> Int	port
-> Int	number of connections
-> (ConnectionPool -> m a)
-> m a

Create a TokyoTyrant connection pool and run the given action. Don't use the given ConnectionPool outside the action.

runMonarchConn Source

Arguments

:: (MonadBaseControl IO m, MonadIO m)
=> MonarchT m a	action
-> Connection	connection
-> m (Either Code a)

Run action with a connection.

runMonarchPool Source

Arguments

:: (MonadBaseControl IO m, MonadIO m)
=> MonarchT m a	action
-> ConnectionPool	connection pool
-> m (Either Code a)

Run action with a unused connection from the pool.

data ExtOption Source

Options for scripting extension

Constructors

RecordLocking	record locking
GlobalLocking	global locking

data RestoreOption Source

Options for restore

Constructors

ConsistencyChecking

consistency checking

data MiscOption Source

Options for miscellaneous operation

Constructors

NoUpdateLog

omission of update log

data Code Source

Error code

Constructors

Success
InvalidOperation
HostNotFound
ConnectionRefused
SendError
ReceiveError
ExistingRecord
NoRecordFound
MiscellaneousError

Instances

Eq Code
Show Code
Error Code
Monad m => MonadError Code (MonarchT m)
Monad m => MonadError Code (MockT m)

class MonadMonarch m whereSource

Monad Monarch interfaces

Methods

put Source

Arguments

:: ByteString	key
-> ByteString	value
-> m ()

Store a record. If a record with the same key exists in the database, it is overwritten.

multiplePut Source

Arguments

:: [(ByteString, ByteString)]	key & value pairs
-> m ()

Store records. If a record with the same key exists in the database, it is overwritten.

putKeep Source

Arguments

:: ByteString	key
-> ByteString	value
-> m ()

Store a new record. If a record with the same key exists in the database, this function has no effect.

putCat Source

Arguments

:: ByteString	key
-> ByteString	value
-> m ()

Concatenate a value at the end of the existing record. If there is no corresponding record, a new record is created.

putShiftLeft Source

Arguments

:: ByteString	key
-> ByteString	value
-> Int	width
-> m ()

Concatenate a value at the end of the existing record and shift it to the left. If there is no corresponding record, a new record is created.

putNoResponse Source

Arguments

:: ByteString	key
-> ByteString	value
-> m ()

Store a record without response. If a record with the same key exists in the database, it is overwritten.

out Source

Arguments

:: (MonadBaseControl IO m, MonadIO m)
=> ByteString	key
-> m ()

Remove a record.

multipleOut Source

Arguments

:: [ByteString]	keys
-> m ()

Remove records.

get Source

Arguments

:: ByteString	key
-> m (Maybe ByteString)

Retrieve a record.

multipleGet Source

Arguments

:: [ByteString]	keys
-> m [(ByteString, ByteString)]

Retrieve records.

valueSize Source

Arguments

:: ByteString	key
-> m (Maybe Int)

Get the size of the value of a record.

iterInit :: m ()Source

Initialize the iterator.

iterNext :: m (Maybe ByteString)Source

Get the next key of the iterator. The iterator can be updated by multiple connections and then it is not assured that every record is traversed.

forwardMatchingKeys Source

Arguments

:: ByteString	key prefix
-> Maybe Int	maximum number of keys to be fetched. `Nothing` means unlimited.
-> m [ByteString]

Get forward matching keys.

addInt Source

Arguments

:: ByteString	key
-> Int	value
-> m Int

Add an integer to a record. If the corresponding record exists, the value is treated as an integer and is added to. If no record corresponds, a new record of the additional value is stored.

addDouble Source

Arguments

:: ByteString	key
-> Double	value
-> m Double

Add a real number to a record. If the corresponding record exists, the value is treated as a real number and is added to. If no record corresponds, a new record of the additional value is stored.

ext Source

Arguments

:: ByteString	function
-> [ExtOption]	option flags
-> ByteString	key
-> ByteString	value
-> m ByteString

Call a function of the script language extension.

sync :: m ()Source

Synchronize updated contents with the file and the device.

optimize Source

Arguments

:: ByteString	parameter
-> m ()

Optimize the storage.

vanish :: m ()Source

Remove all records.

copy Source

Arguments

:: ByteString	path
-> m ()

Copy the database file.

restore Source

Arguments

:: Integral a
=> ByteString	path
-> a	beginning time stamp in microseconds
-> [RestoreOption]	option flags
-> m ()

Restore the database file from the update log.

setMaster Source

Arguments

:: Integral a
=> ByteString	host
-> Int	port
-> a	beginning time stamp in microseconds
-> [RestoreOption]	option flags
-> m ()

Set the replication master.

recordNum :: m Int64 Source

Get the number of records.

size :: m Int64 Source

Get the size of the database.

status :: m ByteString Source

Get the status string of the database.

misc Source

Arguments

:: ByteString	function name
-> [MiscOption]	option flags
-> [ByteString]	arguments
-> m [ByteString]

Call a versatile function for miscellaneous operations.

Instances

(MonadBaseControl IO m, MonadIO m) => MonadMonarch (MonarchT m)
(MonadBaseControl IO m, MonadIO m) => MonadMonarch (MockT m)