Database API.


Files

file  rpmlib.h
 In Memoriam: Steve Taylor <staylor@redhat.com> was here, now he's not.
file  dbconfig.c
file  hdrNVR.c
file  rpmdb.c
file  rpmdb.h
 Access RPM indices using Berkeley DB interface(s).

Data Structures

struct  rpmdb_s
 Describes the collection of index databases used by rpm. More...

Typedefs

typedef struct rpmdb_srpmdb
 Database of headers and tag value indices.
typedef struct
_rpmdbMatchIterator
rpmdbMatchIterator
 Database iterator.
typedef struct _dbiIndexSetdbiIndexSet
 A single element (i.e.

Enumerations

enum  rpmdbFlags { RPMDB_FLAG_JUSTCHECK = (1 << 0), RPMDB_FLAG_MINIMAL = (1 << 1), RPMDB_FLAG_CHROOT = (1 << 2) }

Functions

int rpmdbFindFpList (rpmdb db, fingerPrint *fpList, dbiIndexSet *matchList, int numItems)
 Find fingerprint matches in database.
unsigned int rpmdbGetIteratorFileNum (rpmdbMatchIterator mi)
rpmdb rpmdbUnlink (rpmdb db, const char *msg)
 Unreference a database instance.
rpmdb rpmdbLink (rpmdb db, const char *msg)
 Reference a database instance.
int rpmdbOpen (const char *prefix, rpmdb *dbp, int mode, int perms)
 Open rpm database.
int rpmdbInit (const char *prefix, int perms)
 Initialize database.
int rpmdbVerify (const char *prefix)
 Verify database components.
int rpmdbClose (rpmdb db)
 Close all database indices and free rpmdb.
int rpmdbSync (rpmdb db)
 Sync all database indices.
int rpmdbOpenAll (rpmdb db)
 Open all database indices.
int rpmdbCountPackages (rpmdb db, const char *name)
 Return number of instances of package in rpm database.
unsigned int rpmdbGetIteratorOffset (rpmdbMatchIterator mi)
 Return header join key for current position of rpm database iterator.
int rpmdbGetIteratorCount (rpmdbMatchIterator mi)
 Return number of elements in rpm database iterator.
int rpmdbAppendIterator (rpmdbMatchIterator mi, const int *hdrNums, int nHdrNums)
 Append items to set of package instances to iterate.
int rpmdbPruneIterator (rpmdbMatchIterator mi, int *hdrNums, int nHdrNums, int sorted)
 Remove items from set of package instances to iterate.
int rpmdbSetIteratorRE (rpmdbMatchIterator mi, rpmTag tag, rpmMireMode mode, const char *pattern)
 Add pattern to iterator selector.
int rpmdbSetIteratorRewrite (rpmdbMatchIterator mi, int rewrite)
 Prepare iterator for lazy writes.
int rpmdbSetIteratorModified (rpmdbMatchIterator mi, int modified)
 Modify iterator to mark header for lazy write on release.
int rpmdbSetHdrChk (rpmdbMatchIterator mi, rpmts ts, rpmRC(*hdrchk)(rpmts ts, const void *uh, size_t uc, const char **msg))
 Modify iterator to verify retrieved header blobs.
rpmdbMatchIterator rpmdbInitIterator (rpmdb db, rpmTag rpmtag, const void *keyp, size_t keylen)
 Return database iterator.
Header rpmdbNextIterator (rpmdbMatchIterator mi)
 Return next package header from iteration.
int rpmdbCheckSignals (void)
 Check for and exit on termination signals.
int rpmdbCheckTerminate (int terminate)
 Check rpmdb signal handler for trapped signal and/or requested exit, clean up any open iterators and databases on termination condition.
rpmdbMatchIterator rpmdbFreeIterator (rpmdbMatchIterator mi)
 Destroy rpm database iterator.
int rpmdbAdd (rpmdb db, int iid, Header h, rpmts ts, rpmRC(*hdrchk)(rpmts ts, const void *uh, size_t uc, const char **msg))
 Add package header to rpm database and indices.
int rpmdbRemove (rpmdb db, int rid, unsigned int hdrNum, rpmts ts, rpmRC(*hdrchk)(rpmts ts, const void *uh, size_t uc, const char **msg))
 Remove package header from rpm database and indices.
int rpmdbRebuild (const char *prefix, rpmts ts, rpmRC(*hdrchk)(rpmts ts, const void *uh, size_t uc, const char **msg))
 Rebuild database indices from package headers.

Variables

int * dbiTags
 Tags for which rpmdb indices will be built.

Typedef Documentation

typedef struct _dbiIndexSet* dbiIndexSet

A single element (i.e.

inverted list from tag values) of a database.

Definition at line 47 of file rpmdb.h.

typedef struct rpmdb_s* rpmdb

Database of headers and tag value indices.

Definition at line 108 of file rpmlib.h.

typedef struct _rpmdbMatchIterator* rpmdbMatchIterator

Database iterator.

Definition at line 113 of file rpmlib.h.


Enumeration Type Documentation

enum rpmdbFlags

Enumerator:
RPMDB_FLAG_JUSTCHECK 
RPMDB_FLAG_MINIMAL 
RPMDB_FLAG_CHROOT 

Definition at line 442 of file rpmdb.h.


Function Documentation

int rpmdbAdd ( rpmdb  db,
int  iid,
Header  h,
rpmts  ts,
rpmRC(*)(rpmts ts, const void *uh, size_t uc, const char **msg)  hdrchk 
)

Add package header to rpm database and indices.

Parameters:
db rpm database
iid install transaction id (iid = 0 or -1 to skip)
h header
ts (unused) transaction set (or NULL)
(*hdrchk) (unused) headerCheck() vector (or NULL)
Returns:
0 on success

Definition at line 2926 of file rpmdb.c.

Referenced by ftsCacheUpdate(), and rpmcliImportPubkey().

int rpmdbAppendIterator ( rpmdbMatchIterator  mi,
const int *  hdrNums,
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)

Definition at line 2466 of file rpmdb.c.

References dbiPruneSet(), and _rpmdbMatchIterator::mi_set.

Referenced by markReplacedFiles().

int rpmdbCheckSignals ( void   ) 

Check for and exit on termination signals.

Definition at line 738 of file rpmdb.c.

Referenced by checkSignals(), rpmInstall(), rpmQueryVerify(), and rpmtsRun().

int rpmdbCheckTerminate ( int  terminate  ) 

Check rpmdb signal handler for trapped signal and/or requested exit, clean up any open iterators and databases on termination condition.

On non-zero exit any open references to rpmdb are invalid and cannot be accessed anymore, calling process should terminate immediately.

Parameters:
terminate 0 to only check for signals, 1 to terminate anyway
Returns:
0 to continue, 1 if termination cleanup was done.

Definition at line 694 of file rpmdb.c.

Referenced by rpm_exithook().

int rpmdbClose ( rpmdb  db  ) 

Close all database indices and free rpmdb.

Parameters:
db rpm database
Returns:
0 on success

Definition at line 860 of file rpmdb.c.

Referenced by main(), rpmdb_dealloc(), rpmtsCloseDB(), and rpmtsCloseSDB().

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

Definition at line 1345 of file rpmdb.c.

References dbiFreeIndexSet().

int rpmdbFindFpList ( rpmdb  db,
fingerPrint fpList,
dbiIndexSet matchList,
int  numItems 
)

Find fingerprint matches in database.

Parameters:
db rpm database
fpList fingerprint array
Return values:
matchList returned fingerprint matches
Parameters:
numItems number of fingerprint items
Returns:
0 always

Definition at line 3399 of file rpmdb.c.

Referenced by rpmtsRun().

rpmdbMatchIterator rpmdbFreeIterator ( rpmdbMatchIterator  mi  ) 

Destroy rpm database iterator.

Parameters:
mi rpm database iterator
Returns:
NULL always

Definition at line 1668 of file rpmdb.c.

Referenced by ftsCacheUpdate(), handleInstInstalledFiles(), handleRmvdInstalledFiles(), IDTXload(), main(), markReplacedFiles(), rpmcliShowMatches(), rpmdb_length(), rpmdb_subscript(), rpmErase(), rpmgiFree(), rpmgiInitFilter(), rpmgiNext(), rpmInstall(), rpmmi_dealloc(), rpmmi_iternext(), rpmQueryVerify(), rpmts_AddErase(), rpmtsAddInstallElement(), rpmtsFindPubkey(), rpmtsRun(), rpmtsSolve(), and unsatisfiedDepend().

int rpmdbGetIteratorCount ( rpmdbMatchIterator  mi  ) 

Return number of elements in rpm database iterator.

Parameters:
mi rpm database iterator
Returns:
number of elements

Definition at line 1730 of file rpmdb.c.

References _rpmdbMatchIterator::mi_offset.

Referenced by ftsCacheUpdate(), rpmInstall(), rpmmi_Count(), and rpmts_AddErase().

unsigned int rpmdbGetIteratorFileNum ( rpmdbMatchIterator  mi  ) 

Definition at line 1726 of file rpmdb.c.

Referenced by rpmtsFindPubkey().

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

Definition at line 1722 of file rpmdb.c.

Referenced by IDTXload(), markReplacedFiles(), rpmErase(), rpmgiNext(), rpmmi_Instance(), rpmts_AddErase(), rpmtsAddInstallElement(), and rpmtsFindPubkey().

int rpmdbInit ( const char *  prefix,
int  perms 
)

Initialize database.

Parameters:
prefix path to top of install tree
perms database permissions
Returns:
0 on success

Definition at line 1133 of file rpmdb.c.

References openDatabase(), and rpmExpandNumeric().

Referenced by rpmtsInitDB().

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

Return database iterator.

Parameters:
db rpm database
rpmtag rpm tag
keyp key data (NULL for sequential access)
keylen key data length (0 will use strlen(keyp))
Returns:
NULL on failure

Definition at line 2477 of file rpmdb.c.

Referenced by main(), rpmdb_length(), rpmdb_Match(), rpmdb_subscript(), rpmtsInitIterator(), and rpmtsSolve().

rpmdb rpmdbLink ( rpmdb  db,
const char *  msg 
)

Reference a database instance.

Parameters:
db rpm database
msg 
Returns:
new rpm database reference

Header rpmdbNextIterator ( rpmdbMatchIterator  mi  ) 

Return next package header from iteration.

Parameters:
mi rpm database iterator
Returns:
NULL on end of iteration.

Definition at line 2157 of file rpmdb.c.

Referenced by handleInstInstalledFiles(), handleRmvdInstalledFiles(), IDTXload(), main(), markReplacedFiles(), rpmcliShowMatches(), rpmdb_length(), rpmdb_subscript(), rpmErase(), rpmgiNext(), rpmInstall(), rpmmi_iternext(), rpmQueryVerify(), rpmts_AddErase(), rpmtsAddInstallElement(), rpmtsFindPubkey(), rpmtsRun(), rpmtsSolve(), and unsatisfiedDepend().

int rpmdbOpen ( const char *  prefix,
rpmdb dbp,
int  mode,
int  perms 
)

Open rpm database.

Parameters:
prefix path to top of install tree
Return values:
dbp address of rpm database
Parameters:
mode open(2) flags: O_RDWR or O_RDONLY (O_CREAT also)
perms database permissions
Returns:
0 on success

Definition at line 1125 of file rpmdb.c.

Referenced by main(), rpmtsOpenDB(), and rpmtsOpenSDB().

int rpmdbOpenAll ( rpmdb  db  ) 

Open all database indices.

Parameters:
db rpm database
Returns:
0 on success

Definition at line 813 of file rpmdb.c.

Referenced by rpmtsRun().

int rpmdbPruneIterator ( rpmdbMatchIterator  mi,
int *  hdrNums,
int  nHdrNums,
int  sorted 
)

Remove items from set of package instances to iterate.

Note:
Sorted hdrNums are always passed in rpmlib.
Parameters:
mi rpm database iterator
hdrNums array of package instances
nHdrNums number of elements in array
sorted is the array sorted? (array will be sorted on return)
Returns:
0 on success, 1 on failure (bad args)

Definition at line 2455 of file rpmdb.c.

Referenced by rpmtsAddInstallElement(), and unsatisfiedDepend().

int rpmdbRebuild ( const char *  prefix,
rpmts  ts,
rpmRC(*)(rpmts ts, const void *uh, size_t uc, const char **msg)  hdrchk 
)

Rebuild database indices from package headers.

Parameters:
prefix path to top of install tree
ts transaction set (or NULL)
(*hdrchk) headerCheck() vector (or NULL)
Returns:
0 on success

Definition at line 3733 of file rpmdb.c.

References _, RPMMESS_DEBUG, and rpmMessage.

Referenced by rpmtsRebuildDB().

int rpmdbRemove ( rpmdb  db,
int  rid,
unsigned int  hdrNum,
rpmts  ts,
rpmRC(*)(rpmts ts, const void *uh, size_t uc, const char **msg)  hdrchk 
)

Remove package header from rpm database and indices.

Parameters:
db rpm database
rid (unused) remove transaction id (rid = 0 or -1 to skip)
hdrNum package instance number in database
ts (unused) transaction set (or NULL)
(*hdrchk) (unused) headerCheck() vector (or NULL)
Returns:
0 on success

Definition at line 2619 of file rpmdb.c.

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

Modify iterator to verify retrieved header blobs.

Parameters:
mi rpm database iterator
ts transaction set
(*hdrchk) headerCheck() vector
Returns:
0 always

Definition at line 2142 of file rpmdb.c.

References _rpmdbMatchIterator::mi_modified.

Referenced by rpmtsInitIterator().

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

Definition at line 2132 of file rpmdb.c.

Referenced by markReplacedFiles().

int rpmdbSetIteratorRE ( rpmdbMatchIterator  mi,
rpmTag  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

Definition at line 1889 of file rpmdb.c.

Referenced by IDTXload(), rpmgiInitFilter(), rpmmi_Pattern(), rpmtsInitIterator(), and rpmtsRun().

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

Definition at line 2119 of file rpmdb.c.

Referenced by markReplacedFiles().

int rpmdbSync ( rpmdb  db  ) 

Sync all database indices.

Parameters:
db rpm database
Returns:
0 on success

Definition at line 917 of file rpmdb.c.

Referenced by rpmtsRun().

rpmdb rpmdbUnlink ( rpmdb  db,
const char *  msg 
)

Unreference a database instance.

Parameters:
db rpm database
msg 
Returns:
NULL always

int rpmdbVerify ( const char *  prefix  ) 

Verify database components.

Parameters:
prefix path to top of install tree
Returns:
0 on success

Definition at line 1154 of file rpmdb.c.

Referenced by rpmtsVerifyDB().


Variable Documentation

int* dbiTags

Tags for which rpmdb indices will be built.

Definition at line 61 of file rpmdb.c.

Referenced by main().


Generated on Sun Jun 1 21:56:25 2008 for rpm by  doxygen 1.5.4