mtbl_iter(3) [debian man page]

MTBL_ITER(3)															      MTBL_ITER(3)

NAME

       mtbl_iter - iterate over a sequence of key-value pairs

SYNOPSIS

       #include <mtbl.h>

       mtbl_res
       mtbl_iter_next(struct mtbl_iter *it,
	       const uint8_t * *key, size_t *len_key,
	       const uint8_t * *val, size_t *len_val);

       void
       mtbl_iter_destroy(struct mtbl_iter **it);

DESCRIPTION

       The mtbl_iter interface is used to return a sequence of one or more key-value pairs. Once the caller obtains an mtbl_iter object,
       mtbl_iter_next() should be repeatedly called on it until there are no more key-value entries to retrieve, at which point the iterator
       object must be freed by calling mtbl_iter_destroy().

RETURN VALUE

       mtbl_iter_next() returns mtbl_res_success if a key-value entry was successfully retrieved, in which case key and val will point to buffers
       of length len_key and len_val respectively. The value mtbl_res_failure is returned if there are no more entries to read, or if the it
       argument is NULL.

SEE ALSO

       mtbl_source(3)

								    05/29/2012							      MTBL_ITER(3)

MTBL(7) 																   MTBL(7)

NAME

       mtbl - immutable sorted string library

SYNOPSIS

       #include <mtbl.h>

       gcc [flags] files -lmtbl [libraries]

DESCRIPTION

       The mtbl library provides interfaces for creating, searching, and merging Sorted String Table (SSTable) files in the MTBL format, which
       provide an immutable mapping of keys to values. Sorted String Tables are compact and provide fast random access to keys and key ranges.
       Keys and values are arbitrary byte arrays, and MTBL SSTables may not contain duplicate keys.

       The six main interfaces provided by the mtbl library are:

       mtbl_iter(3)
	   Iterator objects provide a consistent interface for iterating over the key-value entries returned by other interfaces.

       mtbl_source(3)
	   Source objects provide functions for obtaining iterators from an underlying data source. The mtbl_reader and mtbl_merger interfaces
	   provide functions for obtaining references to a source object. The source methods return an mtbl_iter object.

       mtbl_reader(3)
	   Reader objects provide read-only access to MTBL files.

       mtbl_writer(3)
	   Writer objects initialize a new MTBL file from a sequence of key-value entries provided by the caller. Keys must be in sorted order
	   based on lexicographical byte value, and keys may not be duplicated.

       mtbl_merger(3)
	   Merger objects receive multiple sequences of key-value entries from one or more mtbl_source objects and combine them into a single,
	   sorted sequence. The combined, merged output sequence is provided via the mtbl_source interface.

       mtbl_sorter(3)
	   Sorter objects receive a sequence of key-value entries provided by the caller and return them in sorted order. The caller must provide
	   a callback function to merge values in the case of entries with duplicate keys. The sorted output sequence may be retrieved via the
	   mtbl_iter interface or be dumped to an mtbl_writer object.

       mtbl_fileset(3)
	   Fileset objects automatically maintain an mtbl_source built on top of the mtbl_merger and mtbl_reader interfaces. The set of underlying
	   mtbl_reader objects is kept synchronized with a "setfile" on disk listing MTBL files.

       Additionally, several utility interfaces are provided:

       mtbl_crc32c(3)
	   Calculates the CRC32C checksum of a byte array.

       mtbl_fixed(3)
	   Functions for fixed-width encoding and decoding of 32 and 64 bit integers.

       mtbl_varint(3)
	   Functions for varint encoding and decoding of 32 and 64 bit integers.

								    05/29/2012								   MTBL(7)