db_hash

hash information for dbopen() 

Miscellaneous Information


SYNOPSIS

#include <sys/types.h>

#include <db.h>

typedef struct {
	u_int bsize;
	u_int ffactor;
	u_int nelem;
	u_int cachesize;
	u_int32_t (*hash)(const void *, size_t);
	int lorder;
} HASHINFO;


DESCRIPTION

The dbopen() function is the library interface to database files. One of the supported file formats is hash files. The general description of the database access methods is in dbopen(). This manual page describes only the hash specific information.

The hash data structure is an extensible, dynamic hashing scheme.

The access method specific data structure provided to dbopen() is defined in the <db.h> include file as shown in the SYNOPSIS section. The elements of this structure are as follows:

bsize  

Specifies the hash table bucket size, and is, by default, 256 bytes. It may be preferable to increase the page size for disk-resident tables and tables with large data items.

ffactor  

Indicates a desired density within the hash table. It is an approximation of the number of keys allowed to accumulate in any one bucket, determining when the hash table grows or shrinks. The default value is 8.

nelem  

Specifies an estimate of the final size of the hash table. If not set or set too low, hash tables expand gracefully as keys are entered, although a slight performance degradation may be noticed. The default value is 1.

cachesize  

A suggested maximum size, in bytes, of the memory cache. This value is only advisory, and the access method allocates more memory rather than fail.

hash  

The hash field specifies a user defined hash function. Since no hash function performs equally well on all possible data, the user may find that the built-in hash function does poorly on a particular data set. User specified hash functions must take two arguments (a pointer to a byte string and a length) and return a 32-bit quantity to be used as the hash value.

lorder  

The byte order for integers in the stored database metadata. The number should represent the order as an integer; for example, big endian order would be the number 4,321. If lorder is 0 (no order is specified) the current host order is used. If the file already exists, the specified value is ignored and the value specified when the tree was created is used.

If the file already exists (and the O_TRUNC flag is not specified), the values specified for the parameters bsize, ffactor, lorder and nelem are ignored and the values specified when the tree was created are used.

If a hash function is specified, dbopen() attempts to determine if the hash function specified is the same as the one with which the database was created, and fails if it is not.


CONFORMANCE

4.4BSD.


AVAILABILITY

PTC MKS Toolkit for Professional Developers
PTC MKS Toolkit for Professional Developers 64-Bit Edition
PTC MKS Toolkit for Enterprise Developers
PTC MKS Toolkit for Enterprise Developers 64-Bit Edition


SEE ALSO

Functions:
dbopen()

Miscellaneous:
db_btree, db_recno


PTC MKS Toolkit 10.3 Documentation Build 39.