Database.KyotoCabinet.Operations

Logging options

data LoggingOptions

Constructors

LoggingOptions

Fields

• logFile :: LogFile

  The file in which the log messages will be written

• logKind :: [LogKind]
• logPrefix :: String

  The prefix of each log message

data LogFile

Constructors

File FilePath

StdOut

StdErr

data LogKind

Constructors

Debug

Info

Warn

Error

defaultLoggingOptions :: LoggingOptions

Default logging options, outputting to stdout, all messages, and no prefix.

Opening mode

data Mode

Constructors

Reader [ReadMode]

Writer [WriteMode] [ReadMode]

data WriteMode

Constructors

Create

Truncate

AutoTran

AutoSync

data ReadMode

Constructors

NoLock

TryLock

NoRepair

Exceptions

data KCException

Constructors

KCException

Fields

• excFunction :: String
• excError :: KCError
• excMsg :: String

Instances

Show KCException

Methods

showsPrec :: Int -> KCException -> ShowS

show :: KCException -> String

showList :: [KCException] -> ShowS

Exception KCException

Methods

toException :: KCException -> SomeException

fromException :: SomeException -> Maybe KCException

displayException :: KCException -> String

data KCError

Constructors

Success

NotImplemented

InvalidOperation

NoRepository

NoPermission

BrokenFile

RecordDuplication

NoRecord

LogicalInconsistency

SystemError

MiscError

Instances

Show KCError

Methods

showsPrec :: Int -> KCError -> ShowS

show :: KCError -> String

showList :: [KCError] -> ShowS

Type class

class WithDB db where

A thing that has database

Minimal complete definition

getDB

Methods

getDB :: db -> DB

Access database

Instances

WithDB Tree

Methods

getDB :: Tree -> DB

WithDB Text

Methods

getDB :: Text -> DB

WithDB Stash

Methods

getDB :: Stash -> DB

WithDB ProtoTree

Methods

getDB :: ProtoTree -> DB

WithDB ProtoHash

Methods

getDB :: ProtoHash -> DB

WithDB Hash

Methods

getDB :: Hash -> DB

WithDB Forest

Methods

getDB :: Forest -> DB

WithDB Dir

Methods

getDB :: Dir -> DB

WithDB CacheTree

Methods

getDB :: CacheTree -> DB

WithDB CacheHash

Methods

getDB :: CacheHash -> DB

data DB

Polymorphic database

Operations

Closing

close :: WithDB db => db -> IO ()

Visitor

type VisitorFull

Arguments

 = ByteString

Key

-> ByteString

Value

-> IO (Either VisitorAction ByteString)

If a ByteString is returned, the value is changed.

type VisitorEmpty

Arguments

 = ByteString

-> IO (Maybe ByteString)

If the ByteString is present, the value will be added.

data VisitorAction

Constructors

NoOperation

Don't do anything

Remove

Remove the record

type Writable = Bool

accept :: WithDB db => db -> ByteString -> VisitorFull -> VisitorEmpty -> Writable -> IO ()

Executes the VisitorFull on the existent records, and VisitorEmpty on the missing ones.

acceptBulk :: WithDB db => db -> [ByteString] -> VisitorFull -> VisitorEmpty -> Writable -> IO ()

iterate :: WithDB db => db -> VisitorFull -> Writable -> IO ()

scanPara :: WithDB db => db -> VisitorFull -> Int -> IO ()

Scan each record in parallel

Setting

set :: WithDB db => db -> ByteString -> ByteString -> IO ()

setBulk :: WithDB db => db -> [(ByteString, ByteString)] -> Bool -> IO Int64

add :: WithDB db => db -> ByteString -> ByteString -> IO ()

replace :: WithDB db => db -> ByteString -> ByteString -> IO ()

append :: WithDB db => db -> ByteString -> ByteString -> IO ()

Getting

get :: WithDB db => db -> ByteString -> IO (Maybe ByteString)

getBulk :: WithDB db => db -> [ByteString] -> Bool -> IO [(ByteString, ByteString)]

Remove

remove :: WithDB db => db -> ByteString -> IO ()

removeBulk :: WithDB db => db -> [ByteString] -> Bool -> IO Int64

seize :: WithDB db => db -> ByteString -> IO (Maybe ByteString)

Retrieve the value of a record and remove it atomically

clear :: WithDB db => db -> IO ()

Copying/Backup

copy :: WithDB db => db -> FilePath -> IO ()

dump :: WithDB db => db -> FilePath -> IO ()

load :: WithDB db => db -> FilePath -> IO ()

Info and statistics

count :: WithDB db => db -> IO Int64

size :: WithDB db => db -> IO Int64

path :: WithDB db => db -> IO String

Get the path of the database file

status :: WithDB db => db -> IO String

Merging

data MergeMode

Constructors

Set

Add

Replace

Append

data GenericDB

Constructors

WithDB db => GenericDB db

merge :: WithDB db => db -> [GenericDB] -> MergeMode -> IO ()

Cursors

data Cursor

Creation

cursor :: WithDB db => db -> IO Cursor

Visitor

curAccept :: Cursor -> VisitorFull -> Bool -> Bool -> IO ()

Setting

curSetValue :: Cursor -> ByteString -> Bool -> IO ()

Getting

curGetKey :: Cursor -> Bool -> IO ByteString

curGetValue :: Cursor -> Bool -> IO ByteString

curGet :: Cursor -> Bool -> IO (ByteString, ByteString)

Removing

curRemove :: Cursor -> IO ()

curSeize :: Cursor -> IO (ByteString, ByteString)

Moving

curJump :: Cursor -> IO ()

curJumpKey :: Cursor -> ByteString -> IO ()

curJumpBack :: Cursor -> IO ()

curJumpBackKey :: Cursor -> ByteString -> IO ()

curStep :: Cursor -> IO ()

curStepBack :: Cursor -> IO ()