Database.Monarch.Binary

TokyoTyrant Original Binary Protocol(http://fallabs.com/tokyotyrant/spex.html#protocol).

Documentation

put

Arguments

:: ByteString

key

-> ByteString

value

-> Monarch ()

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

putKeep

Arguments

:: ByteString

key

-> ByteString

value

-> Monarch ()

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

putCat

Arguments

:: ByteString

key

-> ByteString

value

-> Monarch ()

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

putShiftLeft

Arguments

:: ByteString

key

-> ByteString

value

-> Int

width

-> Monarch ()

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

Arguments

:: ByteString

key

-> ByteString

value

-> Monarch ()

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

out

Arguments

:: ByteString

key

-> Monarch ()

Remove a record.

get

Arguments

:: ByteString

key

-> Monarch (Maybe ByteString)

Retrieve a record.

multipleGet

Arguments

:: [ByteString]

keys

-> Monarch [(ByteString, ByteString)]

Retrieve records.

valueSize

Arguments

:: ByteString

key

-> Monarch (Maybe Int)

Get the size of the value of a record.

iterInit :: Monarch ()

Initialize the iterator.

iterNext :: Monarch (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

:: ByteString

key prefix

-> Maybe Int

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

-> Monarch [ByteString]

Get forward matching keys.

addInt

Arguments

:: ByteString

key

-> Int

value

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

:: ByteString

key

-> Double

value

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

:: ByteString

function

-> [ExtOption]

option flags

-> ByteString

key

-> ByteString

value

-> Monarch ByteString

Call a function of the script language extension.

sync :: Monarch ()

Synchronize updated contents with the file and the device.

optimize

Arguments

:: ByteString

parameter

-> Monarch ()

Optimize the storage.

vanish :: Monarch ()

Remove all records.

copy

Arguments

:: ByteString

path

-> Monarch ()

Copy the database file.

restore

Arguments

:: Integral a

=> ByteString

path

-> a

beginning time stamp in microseconds

-> [RestoreOption]

option flags

-> Monarch ()

Restore the database file from the update log.

setMaster

Arguments

:: Integral a

=> ByteString

host

-> Int

port

-> a

beginning time stamp in microseconds

-> [RestoreOption]

option flags

-> Monarch ()

Set the replication master.

recordNum :: Monarch Int64

Get the number of records.

size :: Monarch Int64

Get the size of the database.

status :: Monarch ByteString

Get the status string of the database.

misc

Arguments

:: ByteString

function name

-> [MiscOption]

option flags

-> [ByteString]

arguments

-> Monarch [ByteString]

Call a versatile function for miscellaneous operations.