Opening & accessing the RPM database. More...

Collaboration diagram for Database API.:

Files
file	rpmdb.h
file	rpmlib.h

Functions
RPM_PUBLIC_API rpmop	rpmdbOp (rpmdb db, rpmdbOpX opx)
RPM_PUBLIC_API int	rpmdbOpenAll (rpmdb db)
RPM_PUBLIC_API int	rpmdbCountPackages (rpmdb db, const char *name)
RPM_PUBLIC_API unsigned int	rpmdbGetIteratorOffset (rpmdbMatchIterator mi)
RPM_PUBLIC_API int	rpmdbGetIteratorCount (rpmdbMatchIterator mi)
RPM_PUBLIC_API unsigned int	rpmdbGetIteratorFileNum (rpmdbMatchIterator mi)
RPM_PUBLIC_API int	rpmdbAppendIterator (rpmdbMatchIterator mi, const unsigned int *hdrNums, unsigned int nHdrNums)
RPM_PUBLIC_API int	rpmdbSetIteratorRE (rpmdbMatchIterator mi, rpmTagVal tag, rpmMireMode mode, const char *pattern)
RPM_PUBLIC_API int	rpmdbSetIteratorRewrite (rpmdbMatchIterator mi, int rewrite)
RPM_PUBLIC_API int	rpmdbSetIteratorModified (rpmdbMatchIterator mi, int modified)
RPM_PUBLIC_API int	rpmdbSetHdrChk (rpmdbMatchIterator mi, rpmts ts, rpmRC(hdrchk)(rpmts ts, const void uh, size_t uc, char **msg))
RPM_PUBLIC_API rpmdbMatchIterator	rpmdbInitIterator (rpmdb db, rpmDbiTagVal rpmtag, const void *keyp, size_t keylen)
RPM_PUBLIC_API Header	rpmdbNextIterator (rpmdbMatchIterator mi)
RPM_PUBLIC_API rpmdbMatchIterator	rpmdbFreeIterator (rpmdbMatchIterator mi)
RPM_PUBLIC_API rpmdbIndexIterator	rpmdbIndexKeyIteratorInit (rpmdb db, rpmDbiTag rpmtag)
RPM_PUBLIC_API rpmdbIndexIterator	rpmdbIndexIteratorInit (rpmdb db, rpmDbiTag rpmtag)
RPM_PUBLIC_API int	rpmdbIndexIteratorNext (rpmdbIndexIterator ii, const void *key, size_t keylen)
RPM_PUBLIC_API int	rpmdbIndexIteratorNextTd (rpmdbIndexIterator ii, rpmtd keytd)
RPM_PUBLIC_API unsigned int	rpmdbIndexIteratorNumPkgs (rpmdbIndexIterator ii)
RPM_PUBLIC_API unsigned int	rpmdbIndexIteratorPkgOffset (rpmdbIndexIterator ii, unsigned int nr)
RPM_PUBLIC_API unsigned int	rpmdbIndexIteratorTagNum (rpmdbIndexIterator ii, unsigned int nr)
RPM_PUBLIC_API rpmdbIndexIterator	rpmdbIndexIteratorFree (rpmdbIndexIterator ii)
RPM_PUBLIC_API int	rpmdbCtrl (rpmdb db, rpmdbCtrlOp ctrl)
RPM_PUBLIC_API char *	rpmdbCookie (rpmdb db)
RPM_PUBLIC_API int	rpmdbStat (const char prefix, struct stat statbuf)
RPM_PUBLIC_API int	rpmdbFStat (rpmdb db, struct stat *statbuf)

Detailed Description

Opening & accessing the RPM database.

Function Documentation

◆ rpmdbAppendIterator()

RPM_PUBLIC_API int rpmdbAppendIterator	(	rpmdbMatchIterator	mi,
		const unsigned int *	hdrNums,
		unsigned int	nHdrNums )

Append items to set of package instances to iterate.

Parameters

mi	rpm database iterator
hdrNums	array of package instances
nHdrNums	number of elements in array

Returns: 0 on success, 1 on failure (bad args)

◆ rpmdbCookie()

RPM_PUBLIC_API char * rpmdbCookie ( rpmdb db )

Retrieve rpm database changed-cookie. Useful for eg. determining cache validity.

Parameters

db	rpm database

Returns: cookie string (malloced), or NULL on error

◆ rpmdbCountPackages()

RPM_PUBLIC_API int rpmdbCountPackages	(	rpmdb	db,
		const char *	name )

Return number of instances of package in rpm database.

Parameters

db	rpm database
name	rpm package name

Returns: number of instances

◆ rpmdbCtrl()

RPM_PUBLIC_API int rpmdbCtrl	(	rpmdb	db,
		rpmdbCtrlOp	ctrl )

manipulate the rpm database

Parameters

db	rpm database
ctrl	operation

Returns: 0 on success; != 0 on error

◆ rpmdbFreeIterator()

RPM_PUBLIC_API rpmdbMatchIterator rpmdbFreeIterator ( rpmdbMatchIterator mi )

Destroy rpm database iterator.

Parameters

mi	rpm database iterator

Returns: NULL always

◆ rpmdbFStat()

RPM_PUBLIC_API int rpmdbFStat	(	rpmdb	db,
		struct stat *	statbuf )

Perform stat() on an open rpm database

Parameters

	db	rpm database
[out]	statbuf	returned data from stat()

Returns: 0 on success, -1 on error

◆ rpmdbGetIteratorCount()

RPM_PUBLIC_API int rpmdbGetIteratorCount ( rpmdbMatchIterator mi )

Return number of elements in rpm database iterator.

Parameters

mi	rpm database iterator

Returns: number of elements

◆ rpmdbGetIteratorFileNum()

RPM_PUBLIC_API unsigned int rpmdbGetIteratorFileNum ( rpmdbMatchIterator mi )

Return index to the array of elements (eg files) being iterated.

Parameters

mi	rpm database iterator

Returns: array index

◆ rpmdbGetIteratorOffset()

RPM_PUBLIC_API unsigned int rpmdbGetIteratorOffset ( rpmdbMatchIterator mi )

Return header join key for current position of rpm database iterator.

Parameters

mi	rpm database iterator

Returns: current header join key

◆ rpmdbIndexIteratorFree()

RPM_PUBLIC_API rpmdbIndexIterator rpmdbIndexIteratorFree ( rpmdbIndexIterator ii )

Free index iterator

Parameters

ii	index iterator return NULL

◆ rpmdbIndexIteratorInit()

RPM_PUBLIC_API rpmdbIndexIterator rpmdbIndexIteratorInit	(	rpmdb	db,
		rpmDbiTag	rpmtag )

Get an iterator for an index

Parameters

db	rpm database
RPM Tag API.	the index to iterate over

Returns: the index iterator

◆ rpmdbIndexIteratorNext()

RPM_PUBLIC_API int rpmdbIndexIteratorNext	(	rpmdbIndexIterator	ii,
		const void **	key,
		size_t *	keylen )

Get the next key - Warning! Keys are not zero terminated! Binary tags may even contain zero bytes

Parameters

ii	index iterator
key	address to save the pointer to the key
keylen	address to save the length of the key to

Returns: 0 on success; != 0 on error or end of index

◆ rpmdbIndexIteratorNextTd()

RPM_PUBLIC_API int rpmdbIndexIteratorNextTd	(	rpmdbIndexIterator	ii,
		rpmtd	keytd )

Get the next key into a tag data container. Caller is responsible for calling rpmtdFreeData() to freeing the data returned in keytd once done with it.

Parameters

ii	index iterator
keytd	tag container to store the key in

Returns: 0 on success; != 0 on error or end of index

◆ rpmdbIndexIteratorNumPkgs()

RPM_PUBLIC_API unsigned int rpmdbIndexIteratorNumPkgs ( rpmdbIndexIterator ii )

Get number of entries for current key

Parameters

ii	index iterator

Returns: number of entries. 0 on error.

◆ rpmdbIndexIteratorPkgOffset()

RPM_PUBLIC_API unsigned int rpmdbIndexIteratorPkgOffset	(	rpmdbIndexIterator	ii,
		unsigned int	nr )

Get package offset of entry

Parameters

ii	index iterator
nr	number of the entry

Returns: db offset of pkg

◆ rpmdbIndexIteratorTagNum()

RPM_PUBLIC_API unsigned int rpmdbIndexIteratorTagNum	(	rpmdbIndexIterator	ii,
		unsigned int	nr )

Get tag number of entry

Parameters

ii	index iterator
nr	number of the entry

Returns: number of tag within the package

◆ rpmdbIndexKeyIteratorInit()

RPM_PUBLIC_API rpmdbIndexIterator rpmdbIndexKeyIteratorInit	(	rpmdb	db,
		rpmDbiTag	rpmtag )

Get an iterator for index keys

Parameters

db	rpm database
RPM Tag API.	the index to iterate over

Returns: the index iterator

◆ rpmdbInitIterator()

RPM_PUBLIC_API rpmdbMatchIterator rpmdbInitIterator	(	rpmdb	db,
		rpmDbiTagVal	rpmtag,
		const void *	keyp,
		size_t	keylen )

Return database iterator.

Parameters

db	rpm database
RPM Tag API.	database index tag
keyp	key data (NULL for sequential access)
keylen	key data length (0 will use strlen(keyp))

Returns: NULL on failure

◆ rpmdbNextIterator()

RPM_PUBLIC_API Header rpmdbNextIterator ( rpmdbMatchIterator mi )

Return next package header from iteration.

Parameters

mi	rpm database iterator

Returns: NULL on end of iteration.

◆ rpmdbOp()

RPM_PUBLIC_API rpmop rpmdbOp	(	rpmdb	db,
		rpmdbOpX	opx )

Retrieve operation timestamp from rpm database.

Parameters

db	rpm database
opx	operation timestamp index

Returns: pointer to operation timestamp.

◆ rpmdbOpenAll()

RPM_PUBLIC_API int rpmdbOpenAll ( rpmdb db )

Open all database indices.

Parameters

db	rpm database

Returns: 0 on success

◆ rpmdbSetHdrChk()

RPM_PUBLIC_API int rpmdbSetHdrChk	(	rpmdbMatchIterator	mi,
		rpmts	ts,
		rpmRC(*	hdrchk )(rpmts ts, const void uh, size_t uc, char *msg) )

Modify iterator to verify retrieved header blobs.

Parameters

mi	rpm database iterator
ts	transaction set
(*hdrchk)	headerCheck() vector

Returns: 0 always

◆ rpmdbSetIteratorModified()

RPM_PUBLIC_API int rpmdbSetIteratorModified	(	rpmdbMatchIterator	mi,
		int	modified )

Modify iterator to mark header for lazy write on release.

Parameters

mi	rpm database iterator
modified	new value of modified

Returns: previous value

◆ rpmdbSetIteratorRE()

RPM_PUBLIC_API int rpmdbSetIteratorRE	(	rpmdbMatchIterator	mi,
		rpmTagVal	tag,
		rpmMireMode	mode,
		const char *	pattern )

Add pattern to iterator selector.

Parameters

mi	rpm database iterator
tag	rpm tag
mode	type of pattern match
pattern	pattern to match

Returns: 0 on success

◆ rpmdbSetIteratorRewrite()

RPM_PUBLIC_API int rpmdbSetIteratorRewrite	(	rpmdbMatchIterator	mi,
		int	rewrite )

Prepare iterator for lazy writes.

Note: Must be called before rpmdbNextIterator() with CDB model database.

Parameters

mi	rpm database iterator
rewrite	new value of rewrite

Returns: previous value

◆ rpmdbStat()

RPM_PUBLIC_API int rpmdbStat	(	const char *	prefix,
		struct stat *	statbuf )

Perform stat() on rpm database

Parameters

	prefix	prefix or NULL for /
[out]	statbuf	returned data from stat()

Returns: 0 on success, -1 on error

Files

Functions

Detailed Description

Function Documentation

◆ rpmdbAppendIterator()

◆ rpmdbCookie()

◆ rpmdbCountPackages()

◆ rpmdbCtrl()

◆ rpmdbFreeIterator()

◆ rpmdbFStat()

◆ rpmdbGetIteratorCount()

◆ rpmdbGetIteratorFileNum()

◆ rpmdbGetIteratorOffset()

◆ rpmdbIndexIteratorFree()

◆ rpmdbIndexIteratorInit()

◆ rpmdbIndexIteratorNext()

◆ rpmdbIndexIteratorNextTd()

◆ rpmdbIndexIteratorNumPkgs()

◆ rpmdbIndexIteratorPkgOffset()

◆ rpmdbIndexIteratorTagNum()

◆ rpmdbIndexKeyIteratorInit()

◆ rpmdbInitIterator()

◆ rpmdbNextIterator()

◆ rpmdbOp()

◆ rpmdbOpenAll()

◆ rpmdbSetHdrChk()

◆ rpmdbSetIteratorModified()

◆ rpmdbSetIteratorRE()

◆ rpmdbSetIteratorRewrite()

◆ rpmdbStat()