Tree - source-git/rpm - CentOS Git server

source-git / rpm

Blame doc/librpm/html/group__rpmdb.html

Blob History Raw

<html xmlns="http://www.w3.org/1999/xhtml">

2ff057

<head>

2ff057

<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

2ff057

<meta http-equiv="X-UA-Compatible" content="IE=9"/>

2ff057

<meta name="generator" content="Doxygen 1.8.14"/>

2ff057

<meta name="viewport" content="width=device-width, initial-scale=1"/>

2ff057

<title>rpm: Database API.</title>

2ff057

<link href="tabs.css" rel="stylesheet" type="text/css"/>

2ff057

<script type="text/javascript" src="jquery.js"></script>

2ff057

<script type="text/javascript" src="dynsections.js"></script>

2ff057

<link href="doxygen.css" rel="stylesheet" type="text/css" />

2ff057

</head>

2ff057

<body>

2ff057

rpm

2ff057

    4.14.2

2ff057

<script type="text/javascript" src="menudata.js"></script>

2ff057

<script type="text/javascript" src="menu.js"></script>

2ff057

<script type="text/javascript">

2ff057

/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */

2ff057

$(function() {

2ff057

  initMenu('',false,false,'search.php','Search');

2ff057

});

2ff057

/* @license-end */</script>

2ff057

Files |

2ff057

Functions

2ff057

Database API.I/O

2ff057

Opening & accessing the RPM indices using Berkeley DB (the so called rpmdb)

2ff057

More...

2ff057

Collaboration diagram for Database API.:

2ff057

<center>

2ff057

<map name="group____rpmdb" id="group____rpmdb">

2ff057

<area shape="rect" id="node1" href="group__header.html" title="How to manipulate package headers (which carries all information about a package). " alt="" coords="336,5,435,32"/>

2ff057

<area shape="rect" id="node2" href="group__rpmcli.html" title="Parsing RPM command line arguments. " alt="" coords="311,56,460,83"/>

2ff057

<area shape="rect" id="node4" href="group__signature.html" title="List of signature tags. " alt="" coords="312,107,459,133"/>

2ff057

<area shape="rect" id="node5" href="group__rpmrc.html" title="Reading config files and getting some important configuration values. " alt="" coords="350,157,421,184"/>

2ff057

<area shape="rect" id="node6" href="group__io.html" title="I/O" alt="" coords="5,81,45,108"/>

2ff057

</map>

2ff057

</center>

2ff057

Files

2ff057

file  rpmdb.h

2ff057

 RPM database API.

2ff057

file  rpmlib.h

2ff057

In Memoriam: Steve Taylor stayl.nosp@m.or@r.nosp@m.edhat.nosp@m..com was here, now he's not.

2ff057

Functions

2ff057

rpmop rpmdbOp (rpmdb db, rpmdbOpX opx)

2ff057

 Retrieve operation timestamp from rpm database.  More...

2ff057

int rpmdbOpenAll (rpmdb db)

2ff057

 Open all database indices.  More...

2ff057

int rpmdbCountPackages (rpmdb db, const char *name)

2ff057

 Return number of instances of package in rpm database.  More...

2ff057

unsigned int rpmdbGetIteratorOffset (rpmdbMatchIterator mi)

2ff057

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

2ff057

int rpmdbGetIteratorCount (rpmdbMatchIterator mi)

2ff057

 Return number of elements in rpm database iterator.  More...

2ff057

unsigned int rpmdbGetIteratorFileNum (rpmdbMatchIterator mi)

2ff057

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

2ff057

 Append items to set of package instances to iterate.  More...

2ff057

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

2ff057

 Add pattern to iterator selector.  More...

2ff057

int rpmdbSetIteratorRewrite (rpmdbMatchIterator mi, int rewrite)

2ff057

 Prepare iterator for lazy writes.  More...

2ff057

int rpmdbSetIteratorModified (rpmdbMatchIterator mi, int modified)

2ff057

 Modify iterator to mark header for lazy write on release.  More...

2ff057

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

2ff057

 Modify iterator to verify retrieved header blobs.  More...

2ff057

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

2ff057

 Return database iterator.  More...

2ff057

Header rpmdbNextIterator (rpmdbMatchIterator mi)

2ff057

 Return next package header from iteration.  More...

2ff057

rpmdbMatchIterator rpmdbFreeIterator (rpmdbMatchIterator mi)

2ff057

 Destroy rpm database iterator.  More...

2ff057

rpmdbIndexIterator rpmdbIndexIteratorInit (rpmdb db, rpmDbiTag rpmtag)

2ff057

 Get an iterator for an index.  More...

2ff057

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

2ff057

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

2ff057

int rpmdbIndexIteratorNextTd (rpmdbIndexIterator ii, rpmtd keytd)

2ff057

 Get the next key into a tag data container.  More...

2ff057

unsigned int rpmdbIndexIteratorNumPkgs (rpmdbIndexIterator ii)

2ff057

 Get number of entries for current key.  More...

2ff057

unsigned int rpmdbIndexIteratorPkgOffset (rpmdbIndexIterator ii, unsigned int nr)

2ff057

 Get package offset of entry.  More...

2ff057

unsigned int rpmdbIndexIteratorTagNum (rpmdbIndexIterator ii, unsigned int nr)

2ff057

 Get tag number of entry.  More...

2ff057

rpmdbIndexIterator rpmdbIndexIteratorFree (rpmdbIndexIterator ii)

2ff057

 Free index iterator.  More...

2ff057

int rpmdbCtrl (rpmdb db, rpmdbCtrlOp ctrl)

2ff057

 manipulate the rpm database  More...

2ff057

Detailed Description

2ff057

Opening & accessing the RPM indices using Berkeley DB (the so called rpmdb)

2ff057

Function Documentation

2ff057

◆ rpmdbAppendIterator()

2ff057

          int rpmdbAppendIterator

2ff057

          rpmdbMatchIterator

2ff057

mi,

2ff057

          const unsigned int *

2ff057

          hdrNums,

2ff057

          unsigned int

2ff057

          nHdrNums

2ff057

Append items to set of package instances to iterate.

2ff057

Parameters

2ff057

    mirpm database iterator

2ff057

    hdrNumsarray of package instances

2ff057

    nHdrNumsnumber of elements in array

2ff057

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

2ff057

◆ rpmdbCountPackages()

2ff057

          int rpmdbCountPackages

2ff057

          rpmdb

2ff057

db,

2ff057

          const char *

2ff057

          name

2ff057

Return number of instances of package in rpm database.

2ff057

Parameters

2ff057

    dbrpm database

2ff057

    namerpm package name

2ff057

Returns
number of instances

2ff057

◆ rpmdbCtrl()

2ff057

          int rpmdbCtrl

2ff057

          rpmdb

2ff057

db,

2ff057

          rpmdbCtrlOp

2ff057

          ctrl

2ff057

manipulate the rpm database

2ff057

Parameters

2ff057

    dbrpm database

2ff057

    ctrloperation

2ff057

Returns
0 on success; != 0 on error

2ff057

◆ rpmdbFreeIterator()

2ff057

          rpmdbMatchIterator rpmdbFreeIterator

2ff057

          rpmdbMatchIterator

2ff057

mi)

2ff057

Destroy rpm database iterator.

2ff057

Parameters

2ff057

    mirpm database iterator

2ff057

Returns
NULL always

2ff057

◆ rpmdbGetIteratorCount()

2ff057

          int rpmdbGetIteratorCount

2ff057

          rpmdbMatchIterator

2ff057

mi)

2ff057

Return number of elements in rpm database iterator.

2ff057

Parameters

2ff057

    mirpm database iterator

2ff057

Returns
number of elements

2ff057

◆ rpmdbGetIteratorFileNum()

2ff057

          unsigned int rpmdbGetIteratorFileNum

2ff057

          rpmdbMatchIterator

2ff057

mi)

2ff057

◆ rpmdbGetIteratorOffset()

2ff057

          unsigned int rpmdbGetIteratorOffset

2ff057

          rpmdbMatchIterator

2ff057

mi)

2ff057

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

2ff057

Parameters

2ff057

    mirpm database iterator

2ff057

Returns
current header join key

2ff057

◆ rpmdbIndexIteratorFree()

2ff057

          rpmdbIndexIterator rpmdbIndexIteratorFree

2ff057

          rpmdbIndexIterator

2ff057

ii)

2ff057

Free index iterator.

2ff057

Parameters

2ff057

    iiindex iterator return NULL

2ff057

◆ rpmdbIndexIteratorInit()

2ff057

          rpmdbIndexIterator rpmdbIndexIteratorInit

2ff057

          rpmdb

2ff057

db,

2ff057

          rpmDbiTag

2ff057

          rpmtag

2ff057

Get an iterator for an index.

2ff057

Parameters

2ff057

    dbrpm database

2ff057

    rpmtagthe index to iterate over

2ff057

Returns
the index iterator

2ff057

◆ rpmdbIndexIteratorNext()

2ff057

          int rpmdbIndexIteratorNext

2ff057

          rpmdbIndexIterator

2ff057

ii,

2ff057

          const void **

2ff057

          key,

2ff057

          size_t *

2ff057

          keylen

2ff057

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

2ff057

Parameters

2ff057

    iiindex iterator

2ff057

    keyaddress to save the pointer to the key

2ff057

    keylenaddress to save the length of the key to

2ff057

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

2ff057

◆ rpmdbIndexIteratorNextTd()

2ff057

          int rpmdbIndexIteratorNextTd

2ff057

          rpmdbIndexIterator

2ff057

ii,

2ff057

          rpmtd

2ff057

          keytd

2ff057

Get the next key into a tag data container.

2ff057

Caller is responsible for calling rpmtdFreeData() to freeing the data returned in keytd once done with it. 
Parameters

2ff057

    iiindex iterator

2ff057

    keytdtag container to store the key in

2ff057

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

2ff057

◆ rpmdbIndexIteratorNumPkgs()

2ff057

          unsigned int rpmdbIndexIteratorNumPkgs

2ff057

          rpmdbIndexIterator

2ff057

ii)

2ff057

Get number of entries for current key.

2ff057

Parameters

2ff057

    iiindex iterator

2ff057

Returns
number of entries. 0 on error.

2ff057

◆ rpmdbIndexIteratorPkgOffset()

2ff057

          unsigned int rpmdbIndexIteratorPkgOffset

2ff057

          rpmdbIndexIterator

2ff057

ii,

2ff057

          unsigned int

2ff057

nr

2ff057

Get package offset of entry.

2ff057

Parameters

2ff057

    iiindex iterator

2ff057

    nrnumber of the entry

2ff057

Returns
db offset of pkg

2ff057

◆ rpmdbIndexIteratorTagNum()

2ff057

          unsigned int rpmdbIndexIteratorTagNum

2ff057

          rpmdbIndexIterator

2ff057

ii,

2ff057

          unsigned int

2ff057

nr

2ff057

Get tag number of entry.

2ff057

Parameters

2ff057

    iiindex iterator

2ff057

    nrnumber of the entry

2ff057

Returns
number of tag within the package

2ff057

◆ rpmdbInitIterator()

2ff057

          rpmdbMatchIterator rpmdbInitIterator

2ff057

          rpmdb

2ff057

db,

2ff057

          rpmDbiTagVal

2ff057

          rpmtag,

2ff057

          const void *

2ff057

          keyp,

2ff057

          size_t

2ff057

          keylen

2ff057

Return database iterator.

2ff057

Parameters

2ff057

    dbrpm database

2ff057

    rpmtagdatabase index tag

2ff057

    keypkey data (NULL for sequential access)

2ff057

    keylenkey data length (0 will use strlen(keyp))

2ff057

Returns
NULL on failure

2ff057

◆ rpmdbNextIterator()

2ff057

          Header rpmdbNextIterator

2ff057

          rpmdbMatchIterator

2ff057

mi)

2ff057

Return next package header from iteration.

2ff057

Parameters

2ff057

    mirpm database iterator

2ff057

Returns
NULL on end of iteration.

2ff057

◆ rpmdbOp()

2ff057

          rpmop rpmdbOp

2ff057

          rpmdb

2ff057

db,

2ff057

          rpmdbOpX

2ff057

opx

2ff057

Retrieve operation timestamp from rpm database.

2ff057

Parameters

2ff057

    dbrpm database

2ff057

    opxoperation timestamp index

2ff057

Returns
pointer to operation timestamp.

2ff057

◆ rpmdbOpenAll()

2ff057

          int rpmdbOpenAll

2ff057

          rpmdb

2ff057

db)

2ff057

Open all database indices.

2ff057

Parameters

2ff057

    dbrpm database

2ff057

Returns
0 on success

2ff057

◆ rpmdbSetHdrChk()

2ff057

          int rpmdbSetHdrChk

2ff057

          rpmdbMatchIterator

2ff057

mi,

2ff057

          rpmts

2ff057

ts,

2ff057

          rpmRC(*)(rpmts ts, const void *uh, size_t uc, char **msg)

2ff057

          hdrchk

2ff057

Modify iterator to verify retrieved header blobs.

2ff057

Parameters

2ff057

    mirpm database iterator

2ff057

    tstransaction set

2ff057

    (*hdrchk)headerCheck() vector

2ff057

Returns
0 always

2ff057

◆ rpmdbSetIteratorModified()

2ff057

          int rpmdbSetIteratorModified

2ff057

          rpmdbMatchIterator

2ff057

mi,

2ff057

int

2ff057

          modified

2ff057

Modify iterator to mark header for lazy write on release.

2ff057

Parameters

2ff057

    mirpm database iterator

2ff057

    modifiednew value of modified

2ff057

Returns
previous value

2ff057

◆ rpmdbSetIteratorRE()

2ff057

          int rpmdbSetIteratorRE

2ff057

          rpmdbMatchIterator

2ff057

mi,

2ff057

          rpmTagVal

2ff057

          tag,

2ff057

          rpmMireMode

2ff057

          mode,

2ff057

          const char *

2ff057

          pattern

2ff057

Add pattern to iterator selector.

2ff057

Parameters

2ff057

    mirpm database iterator

2ff057

    tagrpm tag

2ff057

    modetype of pattern match

2ff057

    patternpattern to match

2ff057

Returns
0 on success

2ff057

◆ rpmdbSetIteratorRewrite()

2ff057

          int rpmdbSetIteratorRewrite

2ff057

          rpmdbMatchIterator

2ff057

mi,

2ff057

int

2ff057

          rewrite

2ff057

Prepare iterator for lazy writes.

2ff057

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

2ff057

Parameters

2ff057

    mirpm database iterator

2ff057

    rewritenew value of rewrite

2ff057

Returns
previous value

2ff057


<address class="footer"><small>

2ff057

Generated by

2ff057

 1.8.14

2ff057

</small></address>

2ff057

</body>

2ff057

</html>

source-git / rpm

Source Code

Blame doc/librpm/html/group__rpmdb.html

Detailed Description

Function Documentation

◆ rpmdbAppendIterator()

◆ rpmdbCountPackages()

◆ rpmdbCtrl()

◆ rpmdbFreeIterator()

◆ rpmdbGetIteratorCount()

◆ rpmdbGetIteratorFileNum()

◆ rpmdbGetIteratorOffset()

◆ rpmdbIndexIteratorFree()

◆ rpmdbIndexIteratorInit()

◆ rpmdbIndexIteratorNext()

◆ rpmdbIndexIteratorNextTd()

◆ rpmdbIndexIteratorNumPkgs()

◆ rpmdbIndexIteratorPkgOffset()

◆ rpmdbIndexIteratorTagNum()

◆ rpmdbInitIterator()

◆ rpmdbNextIterator()

◆ rpmdbOp()

◆ rpmdbOpenAll()

◆ rpmdbSetHdrChk()

◆ rpmdbSetIteratorModified()

◆ rpmdbSetIteratorRE()

◆ rpmdbSetIteratorRewrite()