Database.Monarch

This module provide TokyoTyrant monadic access interface.

Documentation

type Monarch = MonarchT IO

data MonarchT m a

The Monarch monad transformer to provide TokyoTyrant access.

Instances

MonadTrans MonarchT

MonadTransControl MonarchT

(Applicative base, Applicative (MonarchT m), Monad base, Monad (MonarchT m), MonadBase base m) => MonadBase base (MonarchT m)

(MonadBase base (MonarchT m), MonadBaseControl base m) => MonadBaseControl base (MonarchT m)

(Monad (MonarchT m), Monad m) => MonadError Code (MonarchT m)

(Monad (MonarchT m), Monad m) => MonadReader Connection (MonarchT m)

Monad m => Monad (MonarchT m)

Functor m => Functor (MonarchT m)

(Functor (MonarchT m), Monad m, Functor m) => Applicative (MonarchT m)

(Monad (MonarchT m), MonadIO m) => MonadIO (MonarchT m)

data Connection

Connection with TokyoTyrant

Instances

(Monad (MonarchT m), Monad m) => MonadReader Connection (MonarchT m)

type ConnectionPool = Pool Connection

Connection pool with TokyoTyrant

withMonarchConn

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

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

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> MonarchT m a

action

-> Connection

connection

-> m (Either Code a)

Run action with a connection.

runMonarchPool

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

Options for scripting extension

Constructors

RecordLocking

record locking

GlobalLocking

global locking

Instances

BitFlag32 ExtOption

data RestoreOption

Options for restore

Constructors

ConsistencyChecking

consistency checking

Instances

BitFlag32 RestoreOption

data MiscOption

Options for miscellaneous operation

Constructors

NoUpdateLog

omission of update log

Instances

BitFlag32 MiscOption

data Code

Error code

Constructors

Success

InvalidOperation

HostNotFound

ConnectionRefused

SendError

ReceiveError

ExistingRecord

NoRecordFound

MiscellaneousError

Instances

Eq Code

Show Code

Error Code

(Monad (MonarchT m), Monad m) => MonadError Code (MonarchT m)

put

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

key

-> ByteString

value

-> MonarchT m ()

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

putKeep

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

key

-> ByteString

value

-> MonarchT m ()

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

putCat

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

key

-> ByteString

value

-> MonarchT m ()

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

putShiftLeft

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

key

-> ByteString

value

-> Int

width

-> MonarchT 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.

multiplePut

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> [(ByteString, ByteString)]

key & value pairs

-> MonarchT m ()

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

putNoResponse

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

key

-> ByteString

value

-> MonarchT m ()

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

out

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

key

-> MonarchT m ()

Remove a record.

multipleOut

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> [ByteString]

keys

-> MonarchT m ()

Remove records.

get

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

key

-> MonarchT m (Maybe ByteString)

Retrieve a record.

multipleGet

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> [ByteString]

keys

-> MonarchT m [(ByteString, ByteString)]

Retrieve records.

valueSize

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

key

-> MonarchT m (Maybe Int)

Get the size of the value of a record.

iterInit :: (MonadBaseControl IO m, MonadIO m) => MonarchT m ()

Initialize the iterator.

iterNext :: (MonadBaseControl IO m, MonadIO m) => MonarchT m (Maybe ByteString)

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

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

key prefix

-> Maybe Int

maximum number of keys to be fetched. Nothing means unlimited.

-> MonarchT m [ByteString]

Get forward matching keys.

addInt

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

key

-> Int

value

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

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

key

-> Double

value

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

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

function

-> [ExtOption]

option flags

-> ByteString

key

-> ByteString

value

-> MonarchT m ByteString

Call a function of the script language extension.

sync :: (MonadBaseControl IO m, MonadIO m) => MonarchT m ()

Synchronize updated contents with the file and the device.

optimize

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

parameter

-> MonarchT m ()

Optimize the storage.

vanish :: (MonadBaseControl IO m, MonadIO m) => MonarchT m ()

Remove all records.

copy

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

path

-> MonarchT m ()

Copy the database file.

restore

Arguments

:: (MonadBaseControl IO m, MonadIO m, Integral a)

=> ByteString

path

-> a

beginning time stamp in microseconds

-> [RestoreOption]

option flags

-> MonarchT m ()

Restore the database file from the update log.

setMaster

Arguments

:: (MonadBaseControl IO m, MonadIO m, Integral a)

=> ByteString

host

-> Int

port

-> a

beginning time stamp in microseconds

-> [RestoreOption]

option flags

-> MonarchT m ()

Set the replication master.

recordNum :: (MonadBaseControl IO m, MonadIO m) => MonarchT m Int64

Get the number of records.

size :: (MonadBaseControl IO m, MonadIO m) => MonarchT m Int64

Get the size of the database.

status :: (MonadBaseControl IO m, MonadIO m) => MonarchT m ByteString

Get the status string of the database.

misc

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> ByteString

function name

-> [MiscOption]

option flags

-> [ByteString]

arguments

-> MonarchT m [ByteString]

Call a versatile function for miscellaneous operations.