1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
/*! @page data_sources Data Sources
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 WT_CURSOR
handles. See @subpage cursor_ops for a description of how to use
cursors.
@section data_builtin Builtin data sources
The following are the builtin cursor types:
<table>
@hrow{URI, Type, Notes}
@row{<tt>backup:</tt>,
hot backup cursor, See also: @ref hot_backup}
@row{<tt>colgroup:\<tablename\>.\<columnset\></tt>,
column group cursor,}
@row{<tt>config:[\<uri\>]</tt>,
object configuration cursor (key=config string\,
value=config value),}
@row{<tt>file:\<filename\></tt>,
file cursor (key=file key\, value=file value),}
@row{<tt>index:\<tablename\>.\<indexname\></tt>,
index cursor (key=index key\, value=table value),}
@row{<tt>join:\<cursor1\>\&\<cursor2\>[&\<cursor3\>...]</tt>,
join cursor, @notyet{join cursors}}
@row{<tt>lsm:\<name\></tt>,
LSM cursor (key=LSM key\, value=LSM value), See also: @ref lsm}
@row{<tt>statistics:[file</tt><tt>:\<filename\>]</tt>,
database or file statistics (key=(int)\,
value=(string)description\, (string)value\, (uint64_t)value),}
@row{<tt>table:\<tablename\></tt>,
table cursor (key=table key\, value=table value),}
</table>
@subsection data_files Raw Files
WiredTiger's schema layer can be bypassed by opening cursors with a \c
"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).
@subsection data_indices 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
WT_SESSION::create method.
A cursor opened on an index has the specified index columns as its key,
accessed by WT_CURSOR::set_key and WT_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 @ref cursor_projections),
which can access the table key columns or a subset of the value columns.
@subsection data_statistics 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 \c "statistics:"
URI; individual data source statistics are available by specifying
\c "statistics:<data source URI>".
The statistic key is an integer from the list of keys in @ref statistics_keys
"Statistics Keys". Statistics cursors return three values from the
WT_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 following is an example of printing run-time statistics about the
WiredTiger engine:
@snippet ex_stat.c statistics database function
The following is an example of printing statistics about a table:
@snippet ex_stat.c statistics table function
Both examples can use a common display routine that iterates through the
statistics until the cursor returns the end of the list.
@snippet ex_stat.c statistics display function
Individual statistics values can be retrieved by searching for the
corresponding key, as shown in the following example:
@snippet ex_stat.c statistics retrieve by key
See @ref tuning_statistics for more examples of how statistics can be used.
*/
|
