tokyocabinet

  1. tokyocabinet
    1. Description
    2. Author
    3. Requirements
    4. Download
    5. Documentation
      1. tc-hdb-open
      2. tc-hdb-close
      3. tc-hdb-put!
      4. tc-hdb-delete!
      5. tc-hdb-get
      6. tc-hdb-iter-init
      7. tc-hdb-iter-next
      8. tc-hdb-fold
    6. Limitations
    7. Changelog
    8. License

Description

Tokyo Cabinet DBM bindings for Chicken.

Author

Alex Shinn

Requirements

None

Download

tokyocabinet.egg

Documentation

The following flags and procedures are defined (currently only the hash database API is provided - B-trees and fixed-length databases may be provided later). For more information, consult the tokyocabinet(3) manual pages.

tc-hdb-open

(tc-hdb-open FILE #!key FLAGS

                       TUNE-OPTS
                       MUTEX?
                       NUM-BUCKETS
                       RECORD-ALIGNMENT
                       NUM-FREE-BLOCKS
                       CACHE-LIMIT
                       MMAP-SIZE)

Returns a HDB object as a c-pointer. FLAGS specify the creation and locking behavior and can include any of the following:

[constant] TC_HDBOWRITER
[constant] TC_HDBOREADER
[constant] TC_HDBOCREAT
[constant] TC_HDBOTRUNC
[constant] TC_HDBONOLCK
[constant] TC_HDBOLCKNB

By default files are opened for reading and writing and creating.

TUNE-OPTS, along with the other keywords specify options to the tchdbtune function. MUTEX? opens the file under mutex mode (as with tchdbsetmutex).

tc-hdb-close

(tc-hdb-close HDB)

Closes and frees the database handle.

tc-hdb-put!

(tc-hdb-put! HDB KEY VALUE)

tc-hdb-delete!

(tc-hdb-delete! DBF KEY)

tc-hdb-get

(tc-hdb-get HDB KEY)

Returns a STRING

tc-hdb-iter-init

(tc-hdb-iter-init HDB)

tc-hdb-iter-next

(tc-hdb-iter-next HDB)

Returns a STRING

tc-hdb-fold

(tc-hdb-fold HDB KONS KNIL)

Returns the accumulated result. Specify ALIST-CONS for the KONS to get an alist representation of the database.

Limitations

Procedures which accept or return strings, such as tc-hdb-get and tc-hdb-put, are subject to the maximum string length limit imposed by Chicken. On 32-bit platforms, this is 16 megabytes. On a 64-bit platform, it is 72 petabytes. If you try to store or retrieve objects exceeding this limit, an error will occur.

Changelog

License

 Copyright (c) 2008, Alex Shinn
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
 conditions are met:
 
   Redistributions of source code must retain the above copyright notice, this list of conditions and the following
     disclaimer. 
   Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
     disclaimer in the documentation and/or other materials provided with the distribution. 
   Neither the name of the author nor the names of its contributors may be used to endorse or promote
     products derived from this software without specific prior written permission. 
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.