alpm_databases(3)

NAME
alpm_databases - Functions to query and manipulate the database of libalpm.

SYNOPSIS

  Functions
int alpm_db_update (int force, alpm_db_t *db)
Update a package database.
alpm_db_t * alpm_register_syncdb (alpm_handle_t *handle, const char *treename, alpm_siglevel_t level)
Register a sync database of packages.
void _alpm_db_unregister (alpm_db_t *db)
int alpm_unregister_all_syncdbs (alpm_handle_t *handle)
Unregister all package databases.
int alpm_db_unregister (alpm_db_t *db)
Unregister a package database.
alpm_list_t * alpm_db_get_servers (const alpm_db_t *db)
Get the serverlist of a database.
int alpm_db_set_servers (alpm_db_t *db, alpm_list_t *servers)
Set the serverlist of a database.
int alpm_db_add_server (alpm_db_t *db, const char *url)
Add a download server to a database.
int alpm_db_remove_server (alpm_db_t *db, const char *url)
Remove a download server from a database.
const char * alpm_db_get_name (const alpm_db_t *db)
Get the name of a package database.
alpm_siglevel_t alpm_db_get_siglevel (alpm_db_t *db)
Get the signature verification level for a database.
int alpm_db_get_valid (alpm_db_t *db)
Check the validity of a database.
alpm_pkg_t * alpm_db_get_pkg (alpm_db_t *db, const char *name)
Get a package entry from a package database.
alpm_list_t * alpm_db_get_pkgcache (alpm_db_t *db)
Get the package cache of a package database.
alpm_group_t * alpm_db_get_group (alpm_db_t *db, const char *name)
Get a group entry from a package database.
alpm_list_t * alpm_db_get_groupcache (alpm_db_t *db)
Get the group cache of a package database.
alpm_list_t * alpm_db_search (alpm_db_t *db, const alpm_list_t *needles)
Searches a database.
int alpm_db_set_usage (alpm_db_t *db, alpm_db_usage_t usage)
Sets the usage bitmask for a repo.
int alpm_db_get_usage (alpm_db_t *db, alpm_db_usage_t *usage)
Gets the usage bitmask for a repo.

Detailed Description

Functions to query and manipulate the database of libalpm.

Function Documentation

  int alpm_db_add_server (alpm_db_t * db, const char * url)

Add a download server to a database.

Parameters:
    db database pointer
    url url of the server

Returns:
    0 on success, -1 on error (pm_errno is set accordingly)

  alpm_group_t* alpm_db_get_group (alpm_db_t * db, const char * name)

Get a group entry from a package database.

Referenced by alpm_find_group_pkgs().

  alpm_list_t* alpm_db_get_groupcache (alpm_db_t * db)

Get the group cache of a package database.

  const char* alpm_db_get_name (const alpm_db_t * db)

Get the name of a package database.

  alpm_pkg_t* alpm_db_get_pkg (alpm_db_t * db, const char * name)

Get a package entry from a package database.

  alpm_list_t* alpm_db_get_pkgcache (alpm_db_t * db)

Get the package cache of a package database.

Referenced by alpm_dep_free().

  alpm_list_t* alpm_db_get_servers (const alpm_db_t * db)

Get the serverlist of a database.

  alpm_siglevel_t alpm_db_get_siglevel (alpm_db_t * db)

Get the signature verification level for a database.

  int alpm_db_get_usage (alpm_db_t * db, alpm_db_usage_t * usage)

Gets the usage bitmask for a repo. Gets the usage of a database.

  int alpm_db_get_valid (alpm_db_t * db)

Check the validity of a database.

  int alpm_db_remove_server (alpm_db_t * db, const char * url)

Remove a download server from a database.

Parameters:
    db database pointer
    url url of the server

Returns:
    0 on success, 1 on server not present, -1 on error (pm_errno is set accordingly)

  alpm_list_t* alpm_db_search (alpm_db_t * db, const alpm_list_t * needles)

Searches a database. Searches a database with regular expressions.

  int alpm_db_set_servers (alpm_db_t * db, alpm_list_t * servers)

Set the serverlist of a database.

  int alpm_db_set_usage (alpm_db_t * db, alpm_db_usage_t usage)

Sets the usage bitmask for a repo. Sets the usage of a database.

  int alpm_db_unregister (alpm_db_t * db)

Unregister a package database.

  int alpm_db_update (int force, alpm_db_t * db)

Update a package database. An update of the package database db will be attempted. Unless force is true, the update will only be performed if the remote database was modified since the last update.

This operation requires a database lock, and will return an applicable error if the lock could not be obtained.

Example:

alpm_list_t *syncs = alpm_get_syncdbs();
for(i = syncs; i; i = alpm_list_next(i)) {
    alpm_db_t *db = alpm_list_getdata(i);
    result = alpm_db_update(0, db);
    if(result < 0) {
        printf("Unable to update database: %s, alpm_strerrorlast());
    } else if(result == 1) {
        printf("Database already up to date);
    } else {
        printf("Database updated);
    }
}

Note:
    After a successful update, the package cache will be invalidated

Parameters:
    force if true, then forces the update, otherwise update only in case the database isn't up to date
    db pointer to the package database to update

Returns:
    0 on success, -1 on error (pm_errno is set accordingly), 1 if up to to date

  alpm_db_t* alpm_register_syncdb (alpm_handle_t * handle, const char * treename, alpm_siglevel_t level)

Register a sync database of packages.

  int alpm_unregister_all_syncdbs (alpm_handle_t * handle)

Unregister all package databases.

Referenced by alpm_release().

Author

Generated automatically by Doxygen for libalpm from the source code.