Liking cljdoc? Tell your friends :D

clj-halodb.core


closeclj

(close db)
source

db?clj

(db? x)

Returns whether it is an instance of HaloDB.

Returns whether it is an instance of HaloDB.
sourceraw docstring

default-directoryclj

source

deleteclj

(delete db k)
source

getclj

(get db k)
(get db k f)

Returns a result string of fetching value with given key from the db. If f is specified, f is applied to the result and returns it.

Returns a result string of fetching value with given key from the db.
If f is specified, f is applied to the result and returns it.
sourceraw docstring

get-bytesclj

(get-bytes db k)
(get-bytes db k f)

Returns a result bytes of fetching value with given key from the db. If f is specified, f is applied to the result and returns it.

Returns a result bytes of fetching value with given key from the db.
If f is specified, f is applied to the result and returns it.
sourceraw docstring

openclj

(open)
(open directory)
(open directory opts)

Returns a new HaloDB instance. The default directory is 'halodb-store'.

Returns a new HaloDB instance.
The default directory is 'halodb-store'.
sourceraw docstring

optionsclj

(options)
(options {:keys [compaction-threshold-per-file max-file-size
                 max-tombstone-file-size flush-data-size-bytes sync-write
                 number-of-records compaction-job-rate
                 clean-up-in-memory-index-on-close
                 clean-up-tombstone-during-open use-memory-pool fixed-key-size
                 memory-pool-chunk-size build-index-threads]
          :as opts})

Returns a new HaloDBOptions instance. The argument opts can contain key-values named as following:

:compaction-threshold-per-file :max-file-size :max-tombstone-file-size :flush-data-size-bytes :sync-write :number-of-records :compaction-job-rate :clean-up-in-memory-index-on-close :clean-up-tombstone-during-open :use-memory-pool :fixed-key-size :memory-pool-chunk-size :build-index-threads

Please refer the official documents of yahoo/HaloDB.

Returns a new HaloDBOptions instance.
The argument opts can contain key-values named as following:

:compaction-threshold-per-file
:max-file-size
:max-tombstone-file-size
:flush-data-size-bytes
:sync-write
:number-of-records
:compaction-job-rate
:clean-up-in-memory-index-on-close
:clean-up-tombstone-during-open
:use-memory-pool
:fixed-key-size
:memory-pool-chunk-size
:build-index-threads

Please refer the official documents of yahoo/HaloDB.
sourceraw docstring

pause-compactionclj

(pause-compaction db)
source

putclj

(put db m)
(put db m f)

Put the given map into the db. If f is specified, f is applied to the value before putting.

Put the given map into the db.
If f is specified, f is applied to the value before putting.
sourceraw docstring

reset-statsclj

(reset-stats db)
source

resume-compactionclj

(resume-compaction db)
source

sizeclj

(size db)
source

statsclj

(stats db)
source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close