Documentation

Example

   import Control.Monad
   import Database.TokyoCabinet.ADB

   main = do adb <- new
             -- open the abstract database object
             -- "+" means that the database will be an on-memory tree database
             open adb "+" >>= err adb "open failed"
             -- store records
             puts adb [("foo", "hop"), ("bar", "step"), ("baz", "jump")] >>=
                      err adb "put failed" . (all id)
             -- retrieve records
             get_print adb "foo"
             -- traverse records
             iterinit adb
             iter adb >>= mapM_ (k -> putStr (k++":") >> get_print adb k)
             -- close the database
             close adb >>= err adb "close failed"
       where
         puts :: ADB -> [(String, String)] -> IO [Bool]
         puts adb = mapM (uncurry $ put adb)

         get_print :: ADB -> String -> IO ()
         get_print adb key = get adb key >>=
                             maybe (error "something goes wrong") putStrLn

         err :: ADB -> String -> Bool -> IO ()
         err adb msg = flip unless $ error msg

         iter :: ADB -> IO [String]
         iter adb = iternext adb >>=
                    maybe (return []) (x -> return . (x:) =<< iter adb)

data ADB Source

data ECODE Source

Represents error

Constructors

ESUCCESS	success
ETHREAD	threading error
EINVALID	invalid operation
ENOFILE	file not found
ENOPERM	no permission
EMETA	invalid meta data
ERHEAD	invalid record header
EOPEN	open error
ECLOSE	close error
ETRUNC	trunc error
ESYNC	sync error
ESTAT	stat error
ESEEK	seek error
EREAD	read error
EWRITE	write error
EMMAP	mmap error
ELOCK	lock error
EUNLINK	unlink error
ERENAME	rename error
EMKDIR	mkdir error
ERMDIR	rmdir error
EKEEP	existing record
ENOREC	no record found
EMISC	miscellaneous error

Instances

Eq ECODE
Ord ECODE
Show ECODE

new :: IO ADB Source

Create a Abstract database object.

delete :: ADB -> IO ()Source

Free ADB resource forcibly. ADB is kept by ForeignPtr, so Haskell runtime GC cleans up memory for almost situation. Most always, you don't need to call this. After call this, you must not touch ADB object. Its behavior is undefined.

open :: ADB -> String -> IO Bool Source

Open an abstract dataabse.

close :: ADB -> IO Bool Source

Close an abstract database object.

put :: (Storable k, Storable v) => ADB -> k -> v -> IO Bool Source

Stora a record into an abstract database object.

putkeep :: (Storable k, Storable v) => ADB -> k -> v -> IO Bool Source

Store a new record into an abstract database object.

putcat :: (Storable k, Storable v) => ADB -> k -> v -> IO Bool Source

Concatenate a value at the end of the existing record in an abstract database object.

out :: Storable k => ADB -> k -> IO Bool Source

Remove a record of an abstract database object.