[Back]

# API of depot

`require 'depot'`
  The library `depot' should be included in application codes. An instance of the class `Depot' is used as a database handle. `Depot' performs Mix-in of `Enumerable'. Each method of `Depot' throws an exception of `Depot::EANY' or its sub classes when an error occurs: `Depot::ENOERR', `Depot::EFATAL', `Depot::EMODE', `Depot::EBROKEN', `Depot::EKEEP', `Depot::ENOITEM', `Depot::EALLOC', `Depot::EMAP', `Depot::EOPEN', `Depot::ECLOSE', `Depot::ETRUNC', `Depot::ESYNC', `Depot::ESTAT', `Depot::ESEEK', `Depot::EREAD', `Depot::EWRITE', `Depot::ELOCK', `Depot::EUNLINK', `Depot::EMKDIR', `Depot::ERMDIR' and `Depot::EMISC'.

`depot = Depot::new(name, omode, bnum)`
  Constructor: Get a database handle. `name' specifies the name of a database file. `omode' specifies the connection mode: `Depot::OWRITER' as a writer, `Depot::OREADER' as a reader. If the mode is `Depot::OWRITER', the following may be added by bitwise or: `Depot::OCREAT', which means it creates a new database if not exist, `Depot::OTRUNC', which means it creates a new database regardless if one exists. Both of `Depot::OREADER' and `Depot::OWRITER' can be added to by bitwise or: `Depot::ONOLCK', which means it opens a database file without file locking, or `Depot::OLCKNB', which means locking is performed without blocking. `Depot::OCREAT' can be added to by bitwise or: `Depot::OSPARSE', which means it creates a database file as a sparse file. If it is omitted, `Depot::OREADER' is specified. `bnum' specifies the number of elements of the bucket array. If it is omitted or not more than 0, the default value is specified. The size of a bucket array is determined on creating, and can not be changed except for by optimization of the database. Suggested size of a bucket array is about from 0.5 to 4 times of the number of all records to store. The return value is the database handle. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs. If a block parameter is given, this method works as an iterator. A database handle is opened and passed via the first argument of the block. The database handle is surely closed when the block is over. While connecting as a writer, an exclusive lock is invoked to the database file. While connecting as a reader, a shared lock is invoked to the database file. The thread blocks until the lock is achieved. If `Depot::ONOLCK' is used, the application is responsible for exclusion control.

`depot = Depot::open(name, omode, bnum)`
  Constructor: An alias of `new'.

`bool = depot.close()`
  Method: Close the database handle. The return value is always true. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs. Because the region of a closed handle is released, it becomes impossible to use the handle. Updating a database is assured to be written when the handle is closed. If a writer opens a database but does not close it appropriately, the database will be broken.

`depot.silent = bool`
  Method: Set the flag whether to repress frequent exceptions. The return value is the assigned value.

`bool = depot.put(key, val, dmode)`
  Method: Store a record. `key' specifies a key. Although it must be an instance of String, binary data is okey. `val' specifies a value. Although it must be an instance of String, binary data is okey. `dmode' specifies behavior when the key overlaps, by the following values: `Depot::DOVER', which means the specified value overwrites the existing one, `Depot::DKEEP', which means the existing value is kept, `Depot::DCAT', which means the specified value is concatenated at the end of the existing value. If it is omitted, `Depot::DOVER' is specified. The return value is always true. However, if the silent flag is true and replace is cancelled, false is returned instead of exception. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs or replace is cancelled.

`bool = depot.store(key, val)`
  Method: An alias of `put'.

`depot[key] = val`
  Method: An alias of `put'.

`bool = depot.out(key)`
  Method: Delete a record. `key' specifies a key. Although it must be an instance of String, binary data is okey. The return value is always true. However, if the silent flag is true and no record corresponds, false is returned instead of exception. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs or no record corresponds.

`bool = depot.delete(key)`
  Method: An alias of `out'.

`bool = depot.clear()`
  Method: Delete all records. The return value is always true. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs.

`str = depot.get(key, start, max)`
  Method: Retrieve a record. `key' specifies a key. Although it must be an instance of String, binary data is okey. `start' specifies the offset address of the beginning of the region of the value to be read. If it is negative or omitted, the offset is specified as 0. `max' specifies the max size to be read. If it is negative or omitted, the size to read is unlimited. The return value is an instance of the value of the corresponding record. If the silent flag is true and no record corresponds, nil is returned instead of exception. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs, no record corresponds, or the size of the value of the corresponding record is less than `max'.

`str = depot.fetch(key, defval)`
  Method: Retrieve a record. `key' specifies a key. Although it must be an instance of String, binary data is okey. `defval' specifies the default value used when no record corresponds. If it is omitted, nil is specified. The return value is an instance of the value of the corresponding record, or the default value if no record corresponds. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs.

`str = depot[key]`
  Method: An alias of `fetch'.

`num = depot.vsiz(key)`
  Method: Get the size of the value of a record. `key' specifies a key. Although it must be an instance of String, binary data is okey. The return value is the size of the value of the corresponding record. If the silent flag is true and no record corresponds, -1 is returned instead of exception. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs or no record corresponds. Because this method does not read the entity of a record, it is faster than `get'.

`bool = depot.iterinit()`
  Method: Initialize the iterator of the database handle. The return value is always true. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs. The iterator is used in order to access the key of every record stored in a database.

`str = depot.iternext()`
  Method: Get the next key of the iterator. The return value is the value of the next key. If the silent flag is true and no record corresponds, nil is returned instead of exception. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs or no record is to be get out of the iterator. It is possible to access every record by iteration of calling this method. However, it is not assured if updating the database is occurred while the iteration. Besides, the order of this traversal access method is arbitrary, so it is not assured that the order of storing matches the one of the traversal access.

`bool = depot.setalign(align)`
  Method: Set alignment of the database handle. `align' specifies the basic size of alignment. If it is omitted, alignment is cleared. The return value is always true. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs. If alignment is set to a database, the efficiency of overwriting values is improved. The size of alignment is suggested to be average size of the values of the records to be stored. If alignment is positive, padding whose size is multiple number of the alignment is placed. If alignment is negative, as `vsiz' is the size of a value, the size of padding is calculated with `(vsiz / pow(2, abs(align) - 1))'. Because alignment setting is not saved in a database, you should specify alignment every opening a database.

`bool = depot.setfbpsiz(size);`
  Method: Set the size of the free block pool. `size' specifies the size of the free block pool. If it is undef, the free block pool is not used. The return value is always true. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs. The default size of the free block pool is 16. If the size is greater, the space efficiency of overwriting values is improved with the time efficiency sacrificed.

`bool = depot.sync()`
  Method: Synchronize updating contents with the file and the device. The return value is always true. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs. This method is useful when another process uses the connected database file.

`bool = depot.optimize(bnum)`
  Method: Optimize the database. `bnum' specifies the number of the elements of the bucket array. If it is omitted or not more than 0, the default value is specified. The return value is always true. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs. In an alternating succession of deleting and storing with overwrite or concatenate, dispensable regions accumulate. This method is useful to do away with them.

`num = depot.fsiz()`
  Method: Get the size of the database file. The return value is the size of the database file. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs.

`num = depot.bnum()`
  Method: Get the number of the elements of the bucket array. The return value is the number of the elements of the bucket array An exception of `Depot::EANY' or its sub classes is thrown if an error occurs.

`num = depot.rnum()`
  Method: Get the number of the records stored in the database. The return value is the number of the records stored in the database. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs.

`num = depot.length()`
  Method: An alias of `rnum'.

`num = depot.size()`
  Method: An alias of `rnum'.

`bool = depot.writable()`
  Method: Check whether the database handle is a writer or not. The return value is true if the handle is a writer, false if not. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs.

`bool = depot.fatalerror()`
  Method: Check whether the database has a fatal error or not. The return value is true if the database has a fatal error, false if not. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs.

`depot.each() do |key, val| ... end`
  Iterator Method: Iterate a process with a pair of a key and a value of each record.

`depot.each_pair() do |key, val| ... end`
  Iterator Method: An alias of `each'.

`depot.each_key() do |key| ... end`
  Iterator Method: Iterate a process with a key of each record.

`depot.each_value() do |val| ... end`
  Iterator Method: Iterate a process with a value of each record.

`ary = depot.keys()`
  Method: Get an array of all keys. The return value is an array of all keys. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs.

`ary = depot.values()`
  Method: Get an array of all values. The return value is an array of all values. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs.

`str = depot.index(val)`
  Method: Retrieve a record with a value. `val' specifies a value. Although it must be an instance of String, binary data is okey. The return value is the key of the record with the specified value. An exception of `Depot::EANY' or its sub classes is thrown if an error occurs or no record corresponds. If two or more records correspond, the first found record is selected.

`num = depot.to_int()`
  Method: An alias of `rnum'.

`num = depot.to_i()`
  Method: An alias of `to_int'.

`str = depot.to_str()`
  Method: Get string standing for the instance.

`str = depot.to_s()`
  Method: An alias of `to_str'.

`ary = depot.to_ary()`
  Method: Get an array of alternation of each pair of a key and a value.

`ary = depot.to_a()`
  Method: An alias of `to_ary'.

`hash = depot.to_hash()`
  Method: Get a hash storing all records.

`hash = depot.to_h()`
  Method: An alias of `to_hash'.

`str = depot.inspect()`
  Method: An alias of `to_str'.

Generated by ./myrbdoc, 2010/08/05.