Outdated egg!

This is an egg for CHICKEN 4, the unsupported old release. You're almost certainly looking for the CHICKEN 5 version of this egg, if it exists.

If it does not exist, there may be equivalent functionality provided by another egg; have a look at the egg index. Otherwise, please consider porting this egg to the current version of CHICKEN.

tokyocabinet
  1. Outdated egg!
  2. tokyocabinet
    1. Description
    2. Author
    3. Requirements
    4. Documentation
      1. tc-hdb-open
      2. tc-hdb-close
      3. tc-hdb-put!
      4. tc-hdb-delete!
      5. tc-hdb-get
      6. tc-hdb-vsize
      7. tc-hdb-iter-init
      8. tc-hdb-iter-next
      9. tc-hdb-fold
      10. tc-hdb-ecode
      11. tc-bdb-open
      12. tc-bdb-close
      13. tc-bdb-get
      14. tc-bdb-ecode
      15. tc-tdb-open
      16. tc-tdb-close
      17. tc-tdb-get-tabcols
      18. tc-tdb-vsize
      19. tc-tdb-ecode
    5. Limitations
    6. Changelog
    7. License

Description

Tokyo Cabinet DBM bindings for Chicken.

Author

Alex Shinn

Requirements

No eggs are required, but you must have tokyocabinet installed on your OS.

Documentation

The following flags and procedures are defined (currently, the APIs for the hash database (hdb), the B-tree database (bdb), and the table database (tdb) are provided; fixed-length databases may be provided later). For more information, consult the tokyocabinet(3) manual pages.

tc-hdb-open

[procedure] (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 specifies creation and locking behavior; by default files are opened for reading (TC_HDBOREADER), writing (TC_HDBOWRITER) and creating (TC_HDBOCREAT).

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

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

These flags to tc-hdb-open specify creation and locking behavior.

tc-hdb-close

[procedure] (tc-hdb-close HDB)

Closes and frees the database handle.

tc-hdb-put!

[procedure] (tc-hdb-put! HDB KEY VALUE)

Put (KEY, VALUE) into hash database HDB.

tc-hdb-delete!

[procedure] (tc-hdb-delete! HDB KEY)

Delete KEY from hash database HDB.

tc-hdb-get

[procedure] (tc-hdb-get HDB KEY)

Returns the string VALUE associated with KEY in hash database HDB, or #f if KEY does not exist.

tc-hdb-vsize

[procedure] (tc-hdb-vsize HDB KEY)

The size of the value for KEY (measured in bytes).

tc-hdb-iter-init

[procedure] (tc-hdb-iter-init HDB)

tc-hdb-iter-next

[procedure] (tc-hdb-iter-next HDB)

Returns a STRING

tc-hdb-fold

[procedure] (tc-hdb-fold HDB KONS KNIL)

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

tc-hdb-ecode

[procedure] (tc-hdb-ecode HDB)

Returns the error code from the last tc-hdb operation. 0 means no error.

tc-bdb-open

[procedure] (tc-bdb-open FILE #!key FLAGS MUTEX? LEAF-MEMBERS NON-LEAF-MEMBERS NUM-BUCKETS RECORD-ALIGNMENT NUM-FREE-BLOCKS TUNE-OPTS LEAF-CACHE NON-LEAF-CACHE MMAP-SIZE)

Returns a BDB object as a c-pointer. FLAGS specifies creation and locking behavior; by default files are opened for reading (TC_BDBOREADER), writing (TC_BDBOWRITER) and creating (TC_BDBOCREAT).

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

[constant] TC_BDBOWRITER
[constant] TC_BDBOREADER
[constant] TC_BDBOCREAT
[constant] TC_BDBOTRUNC
[constant] TC_BDBONOLCK
[constant] TC_BDBOLCKNB

These flags to tc-bdb-open specify creation and locking behavior.

tc-bdb-close

[procedure] (tc-bdb-close BDB)

tc-bdb-get

[procedure] (tc-bdb-get BDB KEY)

Returns the string VALUE associated with KEY in database BDB, or #f if KEY does not exist.

tc-bdb-ecode

[procedure] (tc-bdb-ecode BDB)

Returns the error code from the last tc-bdb operation. 0 means no error.

tc-tdb-open

[procedure] (tc-tdb-open TDB #!key FLAGS MUTEX? NUM-BUCKETS RECORD-ALIGNMENT NUM-FREE-BLOCKS TUNE-OPTS CACHE-LIMIT LEAF-CACHE NON-LEAF-CACHE MMAP-SIZE)

Returns a TDB object as a c-pointer.

tc-tdb-close

[procedure] (tc-tdb-close TDB)

Closes the table database TDB.

tc-tdb-get-tabcols

[procedure] (tc-tdb-get-tabcols TDB KEY)

The attribute-value pairs for key KEY from table database TDB as one string with tab character as separator: attr1 TAB val1 TAB attr2 TAB val2 ...

tc-tdb-vsize

[procedure] (tc-tdb-vsize TDB KEY)

The size of the value for KEY (measured in bytes).

tc-tdb-ecode

[procedure] (tc-tdb-ecode TDB)

Returns the error code from the last tc-tdb operation. 0 means no error.

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.

For unknown reasons, table databases cannot be opened if mmap-size is greater than 0.

Changelog

License

 
 Copyright (c) 2008-2011, 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.