Collaboration diagram for DBM routines:

Modules
	SDBM library

Data Structures
struct	apr_datum_t

Macros
#define	APR_DBM_READONLY 1

#define	APR_DBM_READWRITE 2

#define	APR_DBM_RWCREATE 3

#define	APR_DBM_RWTRUNC 4

Typedefs
typedef struct apr_dbm_driver_t	apr_dbm_driver_t

typedef struct apr_dbm_t	apr_dbm_t

Functions
apr_status_t	apr_dbm_get_driver (const apr_dbm_driver_t *driver, const char name, const apu_err_t *result, apr_pool_t pool)

apr_status_t	apr_dbm_open_ex (apr_dbm_t *dbm, const char type, const char name, apr_int32_t mode, apr_fileperms_t perm, apr_pool_t cntxt)

apr_status_t	apr_dbm_open2 (apr_dbm_t *pdb, const apr_dbm_driver_t driver, const char name, apr_int32_t mode, apr_fileperms_t perm, apr_pool_t pool)

apr_status_t	apr_dbm_open (apr_dbm_t *dbm, const char name, apr_int32_t mode, apr_fileperms_t perm, apr_pool_t *cntxt)

void	apr_dbm_close (apr_dbm_t *dbm)

apr_status_t	apr_dbm_fetch (apr_dbm_t dbm, apr_datum_t key, apr_datum_t pvalue)

apr_status_t	apr_dbm_store (apr_dbm_t *dbm, apr_datum_t key, apr_datum_t value)

apr_status_t	apr_dbm_delete (apr_dbm_t *dbm, apr_datum_t key)

int	apr_dbm_exists (apr_dbm_t *dbm, apr_datum_t key)

apr_status_t	apr_dbm_firstkey (apr_dbm_t dbm, apr_datum_t pkey)

apr_status_t	apr_dbm_nextkey (apr_dbm_t dbm, apr_datum_t pkey)

void	apr_dbm_freedatum (apr_dbm_t *dbm, apr_datum_t data)

char *	apr_dbm_geterror (apr_dbm_t dbm, int errcode, char *errbuf, apr_size_t errbufsize)

apr_status_t	apr_dbm_get_usednames_ex (apr_pool_t pool, const char type, const char pathname, const char used1, const char *used2)

void	apr_dbm_get_usednames (apr_pool_t pool, const char pathname, const char used1, const char used2)

Detailed Description

Macro Definition Documentation

◆ APR_DBM_READONLY

#define APR_DBM_READONLY 1

open for read-only access

◆ APR_DBM_READWRITE

#define APR_DBM_READWRITE 2

open for read-write access

◆ APR_DBM_RWCREATE

#define APR_DBM_RWCREATE 3

open for r/w, create if needed

◆ APR_DBM_RWTRUNC

#define APR_DBM_RWTRUNC 4

open for r/w, truncating an existing DB if present

Typedef Documentation

◆ apr_dbm_driver_t

typedef struct apr_dbm_driver_t apr_dbm_driver_t

Structure representing a dbm driver.

◆ apr_dbm_t

typedef struct apr_dbm_t apr_dbm_t

Structure for referencing a dbm

Function Documentation

◆ apr_dbm_close()

void apr_dbm_close ( apr_dbm_t * dbm )

Close a dbm file previously opened by apr_dbm_open

Parameters

dbm	The database to close

◆ apr_dbm_delete()

apr_status_t apr_dbm_delete	(	apr_dbm_t *	dbm,
		apr_datum_t	key
	)

Delete a dbm record value by key

Parameters

dbm	The database
key	The key datum of the record to delete

Remarks: It is not an error to delete a non-existent record.

◆ apr_dbm_exists()

int apr_dbm_exists	(	apr_dbm_t *	dbm,
		apr_datum_t	key
	)

Search for a key within the dbm

Parameters

dbm	The database
key	The datum describing a key to test

◆ apr_dbm_fetch()

apr_status_t apr_dbm_fetch	(	apr_dbm_t *	dbm,
		apr_datum_t	key,
		apr_datum_t *	pvalue
	)

Fetch a dbm record value by key

Parameters

dbm	The database
key	The key datum to find this record
pvalue	The value datum retrieved for this record

◆ apr_dbm_firstkey()

apr_status_t apr_dbm_firstkey	(	apr_dbm_t *	dbm,
		apr_datum_t *	pkey
	)

Retrieve the first record key from a dbm

Parameters

dbm	The database
pkey	The key datum of the first record

◆ apr_dbm_freedatum()

void apr_dbm_freedatum	(	apr_dbm_t *	dbm,
		apr_datum_t	data
	)

Proactively toss any memory associated with the apr_datum_t.

Parameters

dbm	The database
data	The datum to free.

◆ apr_dbm_get_driver()

apr_status_t apr_dbm_get_driver	(	const apr_dbm_driver_t **	driver,
		const char *	name,
		const apu_err_t **	result,
		apr_pool_t *	pool
	)

apr_dm_get_driver: get the driver struct for a name

If the driver cannot be found, or cannot be opened, details of the error are returned in apu_err_t.

Parameters

driver	- pointer to driver struct.
name	- driver name
result	- result and error message on failure
pool	- (process) pool to register cleanup

Returns: APR_SUCCESS for success; APR_ENOTIMPL for no driver (when DSO not enabled); APR_EDSOOPEN if DSO driver file can't be opened; APR_ESYMNOTFOUND if the driver file doesn't contain a driver

◆ apr_dbm_get_usednames()

void apr_dbm_get_usednames	(	apr_pool_t *	pool,
		const char *	pathname,
		const char **	used1,
		const char **	used2
	)

If the specified file/path were passed to apr_dbm_open(), return the actual file/path names which would be (created and) used. At most, two files may be used; used2 may be NULL if only one file is used.

Parameters

pool	The pool for allocating used1 and used2.
pathname	The path name to generate used-names from.
used1	The first pathname used by the apr_dbm implementation.
used2	The second pathname used by apr_dbm. If only one file is used by the specific implementation, this will be set to NULL.

Remarks: The dbm file(s) don't need to exist. This function only manipulates the pathnames.

◆ apr_dbm_get_usednames_ex()

apr_status_t apr_dbm_get_usednames_ex	(	apr_pool_t *	pool,
		const char *	type,
		const char *	pathname,
		const char **	used1,
		const char **	used2
	)

If the specified file/path were passed to apr_dbm_open(), return the actual file/path names which would be (created and) used. At most, two files may be used; used2 may be NULL if only one file is used.

Parameters

pool	The pool for allocating used1 and used2.
type	The type of DBM you require info on

See also: apr_dbm_open_ex

Parameters

pathname	The path name to generate used-names from.
used1	The first pathname used by the apr_dbm implementation.
used2	The second pathname used by apr_dbm. If only one file is used by the specific implementation, this will be set to NULL.

Returns: An error if the specified type is invalid.

Remarks: The dbm file(s) don't need to exist. This function only manipulates the pathnames.

◆ apr_dbm_geterror()

char* apr_dbm_geterror	(	apr_dbm_t *	dbm,
		int *	errcode,
		char *	errbuf,
		apr_size_t	errbufsize
	)

Report more information when an apr_dbm function fails.

Parameters

dbm	The database
errcode	A DBM-specific value for the error (for logging). If this isn't needed, it may be NULL.
errbuf	Location to store the error text
errbufsize	The size of the provided buffer

Returns: The errbuf parameter, for convenience.

◆ apr_dbm_nextkey()

apr_status_t apr_dbm_nextkey	(	apr_dbm_t *	dbm,
		apr_datum_t *	pkey
	)

Retrieve the next record key from a dbm

Parameters

dbm	The database
pkey	The key datum of the next record

◆ apr_dbm_open()

apr_status_t apr_dbm_open	(	apr_dbm_t **	dbm,
		const char *	name,
		apr_int32_t	mode,
		apr_fileperms_t	perm,
		apr_pool_t *	cntxt
	)

Open a dbm file by file name

Parameters

dbm	The newly opened database
name	The dbm file name to open
mode	The flag value APR_DBM_READONLY open for read-only access APR_DBM_READWRITE open for read-write access APR_DBM_RWCREATE open for r/w, create if needed APR_DBM_RWTRUNC open for r/w, truncate if already there
perm	Permissions to apply to if created
cntxt	The pool to use when creating the dbm

Remarks: The dbm name may not be a true file name, as many dbm packages append suffixes for separate data and index files.

◆ apr_dbm_open2()

apr_status_t apr_dbm_open2	(	apr_dbm_t **	pdb,
		const apr_dbm_driver_t *	driver,
		const char *	name,
		apr_int32_t	mode,
		apr_fileperms_t	perm,
		apr_pool_t *	pool
	)

Open a dbm file by file name and driver

Parameters

pdb	The newly opened database
driver	The dbm driver to use
name	The dbm file name to open
mode	The flag value APR_DBM_READONLY open for read-only access APR_DBM_READWRITE open for read-write access APR_DBM_RWCREATE open for r/w, create if needed APR_DBM_RWTRUNC open for r/w, truncate if already there
perm	Permissions to apply to if created
pool	The pool to use when creating the dbm

Remarks: The dbm name may not be a true file name, as many dbm packages append suffixes for separate data and index files.

◆ apr_dbm_open_ex()

apr_status_t apr_dbm_open_ex	(	apr_dbm_t **	dbm,
		const char *	type,
		const char *	name,
		apr_int32_t	mode,
		apr_fileperms_t	perm,
		apr_pool_t *	cntxt
	)

Open a dbm file by file name and type of DBM

Parameters

dbm	The newly opened database
type	The type of the DBM (not all may be available at run time) db for Berkeley DB files lmdb for LMDB files gdbm for GDBM files ndbm for NDBM files sdbm for SDBM files (always available) default for the default DBM type
name	The dbm file name to open
mode	The flag value APR_DBM_READONLY open for read-only access APR_DBM_READWRITE open for read-write access APR_DBM_RWCREATE open for r/w, create if needed APR_DBM_RWTRUNC open for r/w, truncate if already there
perm	Permissions to apply to if created
cntxt	The pool to use when creating the dbm

Remarks: The dbm name may not be a true file name, as many dbm packages append suffixes for seperate data and index files.

Bug:: In apr-util 0.9 and 1.x, the type arg was case insensitive. This was highly inefficient, and as of 2.x the dbm name must be provided in the correct case (lower case for all bundled providers)

◆ apr_dbm_store()

apr_status_t apr_dbm_store	(	apr_dbm_t *	dbm,
		apr_datum_t	key,
		apr_datum_t	value
	)

Store a dbm record value by key

Parameters

dbm	The database
key	The key datum to store this record by
value	The value datum to store in this record

Modules

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ APR_DBM_READONLY

◆ APR_DBM_READWRITE

◆ APR_DBM_RWCREATE

◆ APR_DBM_RWTRUNC

Typedef Documentation

◆ apr_dbm_driver_t

◆ apr_dbm_t

Function Documentation

◆ apr_dbm_close()

◆ apr_dbm_delete()

◆ apr_dbm_exists()

◆ apr_dbm_fetch()

◆ apr_dbm_firstkey()

◆ apr_dbm_freedatum()

◆ apr_dbm_get_driver()

◆ apr_dbm_get_usednames()

◆ apr_dbm_get_usednames_ex()

◆ apr_dbm_geterror()

◆ apr_dbm_nextkey()

◆ apr_dbm_open()

◆ apr_dbm_open2()

◆ apr_dbm_open_ex()

◆ apr_dbm_store()