treedb_list_snaps()

treedb_list_snaps()#

treedb_list_snaps() returns a list of snapshots associated with a given TreeDB.

Prototype

json_t *treedb_list_snaps(
    json_t       *tranger,
    const char   *treedb_name,
    json_t       *filter
);

Parameters

Key

Type

Description

tranger

json_t *

A reference to the tranger database instance.

treedb_name

const char *

The name of the TreeDB whose snapshots are to be listed.

filter

json_t *

A JSON object containing filtering criteria for the snapshots. Owned by the caller.


Return Value

A JSON array containing the list of snapshots. The caller must decrement the reference count when done.

Notes

The returned JSON array must be properly decremented using json_decref() to avoid memory leaks.

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples