KDB

General methods to access the Key database. More...

Macros
#define	KDB_VERSION   "x.y.z"
	The version information in x.y.z format as string. More...
#define	KDB_VERSION_MAJOR   x
	The version information of the major version as number. More...
#define	KDB_VERSION_MINOR   y
	The version information of the minor version as number. More...
#define	KDB_VERSION_PATCH   z
	The version information of the patch version as number. More...

Functions
KeySet *	ksRenameKeys (KeySet *config, const char *name)
	Takes the first key and cuts off this common part for all other keys, instead name will be prepended. More...
int	elektraOpenBootstrap (KDB *handle, KeySet *keys, Key *errorKey)
	Bootstrap, first phase with fallback.
KDB *	kdbOpen (const KeySet *contract, Key *errorKey)
	Opens the session with the Key database. More...
int	kdbClose (KDB *handle, Key *errorKey)
	Closes the session with the Key database. More...
int	kdbGet (KDB *handle, KeySet *ks, Key *parentKey)
	Retrieve Keys from a Key database in an atomic and universal way. More...
int	kdbSet (KDB *handle, KeySet *ks, Key *parentKey)
	Set Keys to a Key database in an atomic and universal way. More...

Detailed Description

General methods to access the Key database.

To use them:

#include <kdb.h>

The kdb*() methods are used to access the storage, to get and set KeySets.

Parameters common for all these functions are:

• handle, as returned by kdbOpen(), need to be passed to every call
• parentKey is used for every call to add warnings and set an error. For kdbGet() / kdbSet() it is used to specify which keys should be retrieved/stored.

Note

The parentKey is an obligation for you, but only an hint for KDB. KDB does not remember anything about the configuration. You need to pass the same configuration back to kdbSet(), otherwise parts of the configuration get lost. Only keys below the parentKey are subject for change, the rest must be left untouched.

KDB uses different backend implementations that know the details about how to access the storage. One backend consists of multiple plugins. See writing a new plugin for information about how to write a plugin. Backends are state-less regarding the configuration (because of that you must pass back the whole configuration for every backend), but have a state for:

• a two phase-commit
• a conflict detection (error C02000) and
• optimizations that avoid redoing already done operations.

State

As we see in the figure, kdbOpen() can be called arbitrarily often in any number of threads.

For every handle you got from kdbOpen(), for every parentKey with a different name, only the shown state transitions are valid. From a freshly opened KDB, only kdbGet() and kdbClose() are allowed, because otherwise conflicts (error C02000) would not be detected.

Once kdbGet() was called (for a specific handle+parentKey), any number of kdbGet() and kdbSet() can be used with this handle respective parentKey, unless kdbSet() had a conflict (error C02000) with another application. Every affair with KDB needs to be finished with kdbClose().

The name of the parentKey in kdbOpen() and kdbClose() does not matter.

In the usual case we just have one parentKey and one handle. In these cases we just have to remember to use kdbGet() before kdbSet():

 
#include <kdb.h>
#include <stddef.h>
 
int main (void)
{
        KeySet * myConfig = ksNew (0, KS_END);
        Key * parentKey = keyNew ("/sw/MyApp", KEY_END);
        KDB * handle = kdbOpen (NULL, parentKey);
 
        kdbGet (handle, myConfig, parentKey); // kdbGet() must be first
        // now any number of any kdbGet()/kdbSet() calls are allowed, e.g.:
        kdbSet (handle, myConfig, parentKey);
 
        ksDel (myConfig); // delete the in-memory configuration
 
        kdbClose (handle, parentKey); // no more affairs with the key database.
        keyDel (parentKey);           // working with key/ks does not need kdb
}

To output warnings, you can use following code:

        Key * cutpoint = keyNew ("meta:/warnings", KEY_END);
        KeySet * warnings = ksCut (keyMeta (warningKey), cutpoint);
 
        if (!warningKey || ksGetSize (warnings) == 0)
        {
                ksDel (warnings);
                keyDel (cutpoint);
                return 1;
        }
 
        printf ("There are %zu warnings\n", ksGetSize (warnings));
        elektraCursor i = 1;
        while (i < ksGetSize (warnings))
        {
                ++i;
                Key * cur = ksAtCursor (warnings, i);
                while (!keyIsDirectlyBelow (cutpoint, cur))
                {
                        printf ("%s: %s\n", keyName (cur) + keyGetNameSize (cutpoint), keyString (cur));
                        ++i;
                        cur = ksAtCursor (warnings, i);
                }
                printf ("\n");
        }
        ksDel (warnings);
        keyDel (cutpoint);

To output the error, you can use following code:

        const Key * metaError = keyGetMeta (errorKey, "error");
        if (!metaError) return 1; /* There is no current error */
 
        printf ("number: %s\n", keyString (keyGetMeta (errorKey, "error/number")));
        printf ("description: : %s\n", keyString (keyGetMeta (errorKey, "error/description")));
        printf ("module: : %s\n", keyString (keyGetMeta (errorKey, "error/module")));
        printf ("at: %s:%s\n", keyString (keyGetMeta (errorKey, "error/file")), keyString (keyGetMeta (errorKey, "error/line")));
        printf ("reason: : %s\n", keyString (keyGetMeta (errorKey, "error/reason")));
        printf ("mountpoint: : %s\n", keyString (keyGetMeta (errorKey, "error/mountpoint")));
        printf ("configfile: : %s\n", keyString (keyGetMeta (errorKey, "error/configfile")));

Macro Definition Documentation

KDB_VERSION

#define KDB_VERSION   "x.y.z"

The version information in x.y.z format as string.

To get the version at run-time, you can get the key system:/elektra/version/constants/KDB_VERSION

See also

VERSION.md.

KDB_VERSION_MAJOR

KDB_VERSION_MINOR

KDB_VERSION_PATCH

KDB_VERSION_MAJOR

#define KDB_VERSION_MAJOR   x

The version information of the major version as number.

To get the version at run-time, you can get the key system:/elektra/version/constants/KDB_VERSION_MAJOR

See also

VERSION.md.

KDB_VERSION

KDB_VERSION_MINOR

#define KDB_VERSION_MINOR   y

The version information of the minor version as number.

To get the version at run-time, you can get the key system:/elektra/version/constants/KDB_VERSION_MINOR

See also

VERSION.md.

KDB_VERSION

KDB_VERSION_PATCH

#define KDB_VERSION_PATCH   z

The version information of the patch version as number.

To get the version at run-time, you can get the key system:/elektra/version/constants/KDB_VERSION_PATCH

See also

VERSION.md.

KDB_VERSION

Function Documentation

kdbClose()

int kdbClose	(	KDB *	handle,
		Key *	errorKey
	)

Closes the session with the Key database.

Precondition

The handle must be a valid handle as returned from kdbOpen()

errorKey must be a valid key, e.g. created with keyNew()

This is the counterpart of kdbOpen().

You must call this method when you are finished working with the Key database. You can manipulate Key and KeySet objects also after kdbClose(), but you must not use any kdb*() call afterwards.

The handle parameter will be finalized and all resources associated to it will be freed. After a kdbClose(), the handle cannot be used anymore.

Parameters

handle	contains internal information of opened key database
errorKey	the key which holds error/warning information

Return values

0	on success
-1	on NULL pointer

Since

1.0.0

See also

kdbOpen() for opening a session with a Key database

kdbGet()

int kdbGet	(	KDB *	handle,
		KeySet *	ks,
		Key *	parentKey
	)

Retrieve Keys from a Key database in an atomic and universal way.

Precondition

The handle must be passed as returned from kdbOpen().

The returned KeySet must be a valid KeySet, e.g. constructed with ksNew().

The parentKey Key must be a valid Key, e.g. constructed with keyNew().

If you pass NULL on any parameter, kdbGet() will fail immediately without doing anything.

The returned KeySet ks may already contain some keys, e.g. from previous kdbGet() calls. The newly retrieved Keys will be appended using ksAppendKey().

If not done earlier, kdbGet() will fully retrieve all keys under the parentKey folder recursively (See Optimization below when it will not be done). Cascading Keys (starting with /) will retrieve the same path in all namespaces. / will retrieve all Keys in handle.

It is recommended to use the most specific parentKey possible. (e.g. using system:/ is rarely the most specific)

Note

kdbGet() might retrieve more Keys than requested which are not below parentKey or even in a different namespace. These keys, except of proc:/ keys, must be passed to calls of kdbSet(), otherwise they will be lost. This stems from the fact that the user has the only copy of the whole configuration and backends only write configuration that was passed to them. For example, if you kdbGet() "system:/mountpoint/interest" you will not only get all Keys below system:/mountpoint/interest, but also all Keys below system:/mountpoint (if system:/mountpoint is a mountpoint as the name suggests, but system:/mountpoint/interest is not a mountpoint). Make sure to not touch or remove Keys outside the Keys of interest, because others may need them!

Example:

This example demonstrates the typical usecase within an application (without error handling).

 
#include <kdb.h>
#include <stdio.h>
 
int main (void)
{
        KeySet * myConfig = ksNew (0, KS_END);
 
        // for error handling see kdbget_error.c
 
        // clang-format off
Key * key = keyNew ("/sw/tests/myapp/#0/current/",  KEY_END);
KDB * handle = kdbOpen (NULL, key);
kdbGet (handle, myConfig, key);
Key * result = ksLookupByName (myConfig, "/sw/tests/myapp/#0/current/testkey1", 0);
        // clang-format on
 
        keyDel (key);
 
        const char * key_name = keyName (result);
        const char * key_value = keyString (result);
        const char * key_comment = keyString (keyGetMeta (result, "comment/#0"));
        printf ("key: %s value: %s comment: %s\n", key_name, key_value, key_comment);
 
        ksDel (myConfig); // delete the in-memory configuration
 
 
        // maybe you want kdbSet() myConfig here
 
        kdbClose (handle, 0); // no more affairs with the key database.
}

When a backend fails kdbGet() will return -1 with all error and warning information in the parentKey. The parameter returned will not be changed.

Optimization:

In the first run of kdbGet all requested (or more) Keys are retrieved. On subsequent calls only the Keys are retrieved where something was changed inside the Key database. The other Keys stay in the KeySet returned as passed.

It is your responsibility to save the original KeySet if you need it afterwards.

If you want to be sure to get a fresh KeySet again, you need to open a second handle to the Key database using kdbOpen().

Parameters

handle	contains internal information of opened key database
parentKey	Keys below parentKey will be retrieved from handle. It is also used to add warnings and set error information.
ks	the (pre-initialized) KeySet returned with all keys found will not be changed on error or if no update is required

Return values

1	if the Keys were retrieved successfully. There might be warnings attached to the parentKey! Depending on your use case, you might need to treat them as errors!
0	if there was no update - no changes are made to the KeySet then. There might be warnings attached to the parentKey! Depending on your use case, you might need to treat them as erorrs!
-1	on failure - no changes are made to the KeySet then

Since

1.0.0

See also

ksLookup(), ksLookupByName() for powerful lookups after the KeySet was retrieved

kdbOpen() which needs to be called before

kdbSet() to save the configuration afterwards

kdbClose() to finish affairs with the Key database.

kdbOpen()

KDB* kdbOpen	(	const KeySet *	contract,
		Key *	errorKey
	)

Opens the session with the Key database.

Precondition

errorKey must be a valid key, e.g. created with keyNew()

You must always call this method before retrieving or committing any keys to the database. At the end of a program, after using the Key database (KDB), you must not forget to call kdbClose() to free resources.

The method will bootstrap itself in the following way. The first step is to open the default backend. With it system:/elektra/mountpoints will be loaded and all needed libraries and mountpoints will be determined. Then the global plugins and global keyset data from the contract is processed. Finally, the libraries for backends will be loaded and with it the KDB data structure will be initialized.

The pointer to the KDB structure returned will be initialized like described above, and it must be passed along on any kdb*() method your application calls.

Get a KDB handle for every thread using elektra. Don't share the handle across threads, and also not the pointer accessing it:

void thread1 (void)
{
        Key * parent = keyNew ("/app/part1", KEY_END);
        KDB * h = kdbOpen (NULL, parent);
        // fetch keys and work with them
        kdbClose (h, parent);
}
void thread2 (void)
{
        Key * parent = keyNew ("/app/part2", KEY_END);
        KDB * h = kdbOpen (NULL, parent);
        // fetch keys and work with them
        kdbClose (h, parent);
}

You don't need kdbOpen() if you only want to manipulate plain in-memory Key or KeySet objects.

Precondition

errorKey must be a valid key, e.g. created with keyNew()

Parameters

contract	the contract that should be ensured before opening the KDB all data is copied and the KeySet can safely be used for e.g. kdbGet() later
errorKey	the key which holds errors and warnings which were issued

Returns

handle to the newly created KDB on success

Return values

NULL	on failure

Since

1.0.0

See also

kdbClose() to close the session of a Key database opened by kdbOpen()

kdbSet()

int kdbSet	(	KDB *	handle,
		KeySet *	ks,
		Key *	parentKey
	)

Set Keys to a Key database in an atomic and universal way.

Precondition

kdbGet() must be called before kdbSet():

• initially (after kdbOpen())
• after conflict errors in kdbSet().

The returned KeySet must be a valid KeySet, e.g. constructed with ksNew().

The parentKey Key must be a valid Key, e.g. constructed with keyNew(). It must not have read-only name, value or metadata.

If you pass NULL on any parameter, kdbSet() will fail immediately without doing anything.

With parentKey you can specify which part of the given keyset is of interest for you. Then you promise to only modify or remove keys below this key. All others would be passed back as they were retrieved by kdbGet(). Cascading keys (starting with /) will set the path in all namespaces. / will commit all keys. This parameter is an optimization toonly save keys of mountpoints affected by the specified parentKey. This does not necessarily mean that only changes to keys below that parentKey are saved. Meta-names in parentKey will be rejected (error C01320). Empty/Invalid Keys will also be rejected (error C01320).

Errors

If parentKey == NULL or parentKey has read-only metadata, kdbSet() will immediately return the error code -1. In all other error cases the following happens:

• kdbSet() will leave the KeySet's * internal cursor on the key that generated the error.
• Error information will be written into the metadata of the parent key, if possible.
• None of the keys are actually committed in this situation, i.e. no configuration file will be modified.

In case of errors you should present the error message to the user and let the user decide what to do. Possible solutions are:

• remove the problematic key and use kdbSet() again (for validation or type errors)
• change the value of the problematic key and use kdbSet() again (for validation errors)
• do a kdbGet() (for conflicts, i.e. error C02000) and then
  • set the same keyset again (in favour of what was set by this user)
  • drop the old keyset (in favour of what was set from another application)
  • merge the original, your own and the other keyset
• export the configuration into a file (for unresolvable errors)
• repeat the same kdbSet might be of limited use if the user does not explicitly request it, because temporary errors are rare and its unlikely that they fix themselves (e.g. disc full, permission problems)

Optimization

Each key is checked with keyNeedSync() before being actually committed. If no key of a backend needs to be synced any affairs to backends are omitted and 0 is returned.

KeySet * myConfig = ksNew (0, KS_END);
Key * parentKey = keyNew ("system:/sw/MyApp", KEY_END);
KDB * handle = kdbOpen (NULL, parentKey);
 
kdbGet (handle, myConfig, parentKey); // kdbGet needs to be called first!
KeySet * base = ksDup (myConfig);     // save a copy of original keyset
 
// change the keys within myConfig
ksAppendKey (myConfig, keyNew ("system:/sw/MyApp/Test", KEY_VALUE, "5", KEY_END));
 
KeySet * ours = ksDup (myConfig); // save a copy of our keyset
KeySet * theirs;                  // needed for 3-way merging
int ret = kdbSet (handle, myConfig, parentKey);
while (ret == -1) // as long as we have an error
{
        int strategy = showElektraErrorDialog (parentKey);
        theirs = ksDup (ours);
        kdbGet (handle, theirs, parentKey); // refresh key database
        KeySet * result = elektraMerge(
                ksCut(ours, parentKey), parentKey,
                ksCut(theirs, parentKey), parentKey,
                ksCut(base, parentKey), parentKey,
                parentKey, strategy, parentKey);
        int numberOfConflicts = getConflicts (parentKey);
        ksDel (theirs);
        if (result != NULL) {
                ret = kdbSet (handle, result, parentKey);
        } else {
                // an error happened while merging
                if (numberOfConflicts > 0 && strategy == MERGE_STRATEGY_ABORT)
                {
                        // Error due to merge conflicts
                        ret = -1;
                }
                else
                {
                        // Internal errors, out of memory etc.
                        ret = -1;
                }
        }
}
 
 
ksDel (ours);
ksDel (base);
ksDel (myConfig); // delete the in-memory configuration
 
kdbClose (handle, parentKey); // no more affairs with the key database.
keyDel (parentKey);

showElektraErrorDialog() and doElektraMerge() need to be implemented by the user of Elektra. For doElektraMerge a 3-way merge algorithm exists in libelektra-tools.

Parameters

handle	contains internal information of opened key database
ks	a KeySet which should contain changed keys, otherwise nothing is done
parentKey	Keys below parentKey will be set to handle. It is also used to add warnings and set error information.

Return values

1	on success
0	if nothing had to be done, no changes in KDB
-1	on failure, no changes in KDB, an error will be set on parentKey if possible (see "Errors" above)

Since

1.0.0

See also

kdbOpen() for getting handle

kdbClose() that must be called afterwards

ksCurrent() contains the error Key

ksRenameKeys()

KeySet* ksRenameKeys	(	KeySet *	config,
		const char *	name
	)

Takes the first key and cuts off this common part for all other keys, instead name will be prepended.

Returns

a new allocated keyset with keys in user namespace.

The first key is removed in the resulting keyset.