Database.KyotoCabinet.DB.Tree

File tree database.

File database implemented with a B+: DBM with order.

• Persistence: persistent
• Algorithm: B+ tree
• Complexity: O(log n)
• Sequence: custom order
• Lock unit: page (rwlock)

Documentation

data Tree

Instances

WithDB Tree

Methods

getDB :: Tree -> DB

data TreeOptions

Constructors

TreeOptions

Fields

• alignmentPow :: Maybe Int8
• freePoolPow :: Maybe Int8
• options :: [Options]
• buckets :: Maybe Int64
• maxSize :: Maybe Int64
• defragInterval :: Maybe Int64
• compressor :: Maybe Compressor
• cipherKey :: Maybe String
• pageSize :: Maybe Int64
• comparator :: Maybe Comparator
• pageCacheSize :: Maybe Int64

Instances

Eq TreeOptions

Methods

(==) :: TreeOptions -> TreeOptions -> Bool

(/=) :: TreeOptions -> TreeOptions -> Bool

Ord TreeOptions

Methods

compare :: TreeOptions -> TreeOptions -> Ordering

(<) :: TreeOptions -> TreeOptions -> Bool

(<=) :: TreeOptions -> TreeOptions -> Bool

(>) :: TreeOptions -> TreeOptions -> Bool

(>=) :: TreeOptions -> TreeOptions -> Bool

max :: TreeOptions -> TreeOptions -> TreeOptions

min :: TreeOptions -> TreeOptions -> TreeOptions

Read TreeOptions

Methods

readsPrec :: Int -> ReadS TreeOptions

readList :: ReadS [TreeOptions]

readPrec :: ReadPrec TreeOptions

readListPrec :: ReadPrec [TreeOptions]

Show TreeOptions

Methods

showsPrec :: Int -> TreeOptions -> ShowS

show :: TreeOptions -> String

showList :: [TreeOptions] -> ShowS

defaultTreeOptions :: TreeOptions

data Compressor

Compression algorithm used. DEFLATE is the default one.

Constructors

Zlib

The raw zlib compressor

DEFLATE

zlib deflate compressor

Gz

zlib gzip compressor

LZO

LZO compressor

LZMA

LZMA compressor

Arc

Arcfour cipher

Instances

Eq Compressor

Methods

(==) :: Compressor -> Compressor -> Bool

(/=) :: Compressor -> Compressor -> Bool

Ord Compressor

Methods

compare :: Compressor -> Compressor -> Ordering

(<) :: Compressor -> Compressor -> Bool

(<=) :: Compressor -> Compressor -> Bool

(>) :: Compressor -> Compressor -> Bool

(>=) :: Compressor -> Compressor -> Bool

max :: Compressor -> Compressor -> Compressor

min :: Compressor -> Compressor -> Compressor

Read Compressor

Methods

readsPrec :: Int -> ReadS Compressor

readList :: ReadS [Compressor]

readPrec :: ReadPrec Compressor

readListPrec :: ReadPrec [Compressor]

Show Compressor

Methods

showsPrec :: Int -> Compressor -> ShowS

show :: Compressor -> String

showList :: [Compressor] -> ShowS

data Options

General tuning options

Constructors

Compress

Enable compression of the keys and the values

Instances

Eq Options

Methods

(==) :: Options -> Options -> Bool

(/=) :: Options -> Options -> Bool

Ord Options

Methods

compare :: Options -> Options -> Ordering

(<) :: Options -> Options -> Bool

(<=) :: Options -> Options -> Bool

(>) :: Options -> Options -> Bool

(>=) :: Options -> Options -> Bool

max :: Options -> Options -> Options

min :: Options -> Options -> Options

Read Options

Methods

readsPrec :: Int -> ReadS Options

readList :: ReadS [Options]

readPrec :: ReadPrec Options

readListPrec :: ReadPrec [Options]

Show Options

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

data Comparator

Comparator used in the tree. Lexical by default.

Constructors

Lexical

Decimal

Instances

Eq Comparator

Methods

(==) :: Comparator -> Comparator -> Bool

(/=) :: Comparator -> Comparator -> Bool

Ord Comparator

Methods

compare :: Comparator -> Comparator -> Ordering

(<) :: Comparator -> Comparator -> Bool

(<=) :: Comparator -> Comparator -> Bool

(>) :: Comparator -> Comparator -> Bool

(>=) :: Comparator -> Comparator -> Bool

max :: Comparator -> Comparator -> Comparator

min :: Comparator -> Comparator -> Comparator

Read Comparator

Methods

readsPrec :: Int -> ReadS Comparator

readList :: ReadS [Comparator]

readPrec :: ReadPrec Comparator

readListPrec :: ReadPrec [Comparator]

Show Comparator

Methods

showsPrec :: Int -> Comparator -> ShowS

show :: Comparator -> String

showList :: [Comparator] -> ShowS

makeTree :: FilePath -> LoggingOptions -> TreeOptions -> Mode -> IO Tree

openTree :: FilePath -> LoggingOptions -> Mode -> IO Tree