WiredTiger: Data Sources in Java

| Version 3.1.0

Fork me on GitHub Join my user group
Data Sources in Java

WiredTiger provides access to data from a variety of sources. At the lowest level, data may be stored in a file using a tree structure. A relational schema supporting tables, indices and column groups is layered on top of file. Additional sources include LSM trees and statistics, and applications can further extend the supported types by implementing the WT_DATA_SOURCE interface.

Common operations on all data sources are performed using Cursor handles. See Cursor operations in Java for a description of how to use cursors.

# Builtin data sources

The following are the builtin basic cursor types:

URI | Type | Notes
--- | --- | ---
`table:<table name>[<projection>]` | table cursor | table key, table value(s) with optional projection of columns
`colgroup:<table name>:<column group name>` | column group cursor | table key, column group value(s)
`index:<table name>:<index name>[<projection>]` | index cursor | key=index key, value=table value(s) with optional projection of columns
`join:table:<table name>[<projection>]` | join cursor | key=table key, value=table value(s) with optional projection of columns

Some administrative tasks can be accomplished using the following special cursor types that give access to data managed by WiredTiger:

URI | Type | Notes
--- | --- | ---
`backup:` | backup cursor | key=`string`, see Backups for details
`log:` | log cursor | key=`(long fileID, long offset, int seqno)`, value=`(uint64_t txnid, uint32_t rectype, uint32_t optype, uint32_t fileid, WT_ITEM key, WT_ITEM value)`, see Log cursors for details
`metadata:[create]` | metadata cursor (optionally only returning configuration strings for WT_SESSION::create if `create` is appended | key=`string`, value=`string`, see Reading WiredTiger Metadata for details
`statistics:[<data source URI>]` | database | data source or join statistics cursor | key=`int id`, value=`(string description, string value, uint64_t value)`, see Statistics Data for details

Advanced applications may also open the following low-level cursor types:

URI | Type | Notes
--- | --- | ---
`file:<file name>` | file cursor | file key, file value(s)
`lsm:<name>` | LSM cursor (key=LSM key, value=LSM value) | LSM key, LSM value, see Log-Structured Merge Trees

## Raw Files

WiredTiger's schema layer can be bypassed by opening cursors with a `"file:"` URI, using the name of the underlying file. This can be useful for seeing the contents of a column group or index without reading all of the columns from the table.

For example, if an index becomes inconsistent with its primary, a file cursor can read from the index without errors (even though some of the keys that are returned may not exist in the primary).

## Table Index data

When an index is created for a table, records are inserted into the index whenever the table is updated. These records use a different key to the primary table, as specified when the index is created with the Session.create method.

A cursor opened on an index has the specified index columns as its key, accessed by Cursor.set_key and Cursor.get_key. The value columns default to returning the value columns from the table, but this can be overridden by configuring a projection cursor (see Projections), which can access the table key columns or a subset of the value columns.

## Statistics Data

Statistics cursors can be used to retrieve run-time statistics about a WiredTiger database as well as statistics for individual data sources. The statistics are at two levels: per-database and per-individual data source. Database-wide statistics are retrieved with the `"statistics:"` URI; individual data source statistics are available by specifying `"statistics:<data source URI>"`. Additionally, statistics about a join cursor can be retrieved by specifying `"statistics:join"` and supplying the join cursor as an argument in the SESSION::open_cursor call.

The statistic key is an integer from the list of keys in Statistics Keys. Statistics cursors return three values from the Cursor.get_value call: a printable description of the statistic, a printable version of the entry's value, and the entry's unsigned 64-bit integral value, respectively.

The cursor's statistics values are loaded when the cursor is opened and remain unchanged for the life of the cursor, unless the cursor is reset by calling the Cursor.reset method, which reloads the values.

The following is an example of printing run-time statistics about the WiredTiger engine:

cursor = session.open_cursor("statistics:", null, null);
ret = print_cursor(cursor);
ret = cursor.close();

The following is an example of printing statistics about a table:

cursor = session.open_cursor("statistics:table:access", null, null);
ret = print_cursor(cursor);
ret = cursor.close();

The following is an example of printing statistics about a join cursor:

stat_cursor = session.open_cursor("statistics:join", join_cursor, null);
ret = print_cursor(stat_cursor);
ret = stat_cursor.close();

These three examples can use a common display routine that iterates through the statistics until the cursor returns the end of the list.

int
print_cursor(Cursor cursor)
throws WiredTigerException
{
String desc, pvalue;
long value;
int ret;
while ((ret = cursor.next()) == 0) {
desc = cursor.getValueString();
pvalue = cursor.getValueString();
value = cursor.getValueLong();
if (value != 0)
System.out.println(desc + "=" + pvalue);
}
return (ret == wiredtiger.WT_NOTFOUND ? 0 : ret);
}

Individual statistics values can be retrieved by searching for the corresponding key, as shown in the following example:

Cursor cursor;
String desc, pvalue;
long value;
int ret;
cursor = session.open_cursor("statistics:table:access", null, null);
cursor.putKeyInt(wiredtiger.WT_STAT_DSRC_BTREE_OVERFLOW);
ret = cursor.search();
desc = cursor.getValueString();
pvalue = cursor.getValueString();
value = cursor.getValueLong();
System.out.println(desc + "=" + pvalue);
ret = cursor.close();

See Performance monitoring with statistics for more examples of how statistics can be used.