summaryrefslogtreecommitdiff
path: root/src/third_party/wiredtiger/src/docs/programming.dox
blob: 0e23ce2bf18d0392bcd782d5d1fb8ceaa4220df2 (plain)
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
/*! @page programming Writing WiredTiger applications

This section covers topics of interest for programmers writing
WiredTiger applications.

We follow SQL terminology: a database is set of tables managed together.
Tables consist of rows, where each row is a key and its associated
value.  Tables may optionally have an associated schema, splitting the
value into a set of columns.  Tables may also have associated indices,
each of which is ordered by one or more columns.

<h2>The WiredTiger API</h2>
- @subpage basic_api
- @subpage config_strings
- @subpage cursors
- @subpage schema
- @subpage error_handling

<h2>Transactions</h2>
- @subpage transactions
- @subpage transactions_api
- @subpage durability_overview
- @subpage durability_checkpoint
- @subpage durability_log
- @subpage timestamp_model
- @subpage timestamp_global_api
- @subpage timestamp_txn_api
- @subpage timestamp_prepare
- @subpage timestamp_prepare_roundup
- @subpage timestamp_misc
- @subpage explain_acid
- @subpage explain_isolation

<h2>Storage options</h2>
- @subpage lsm
- @subpage file_formats
- @subpage compression
- @subpage encryption

<h2>Programming notes</h2>
- @subpage message_handling
- @subpage verbose_messaging
- @subpage threads
- @subpage namespace
- @subpage readonly
- @subpage signals

<h2>Advanced topics</h2>
- @subpage backup
- @subpage compact
- @subpage in_memory
- @subpage eviction
- @subpage cursor_join
- @subpage cursor_log
- @subpage operation_tracking
- @subpage shared_cache
- @subpage statistics
- @subpage_single upgrade

<h2>Extending WiredTiger</h2>
- @subpage extensions
- @subpage custom_collators
- @subpage custom_extractors
- @subpage custom_data_sources
- @subpage custom_file_systems
- @subpage custom_storage_sources

<h2>Performance monitoring and tuning</h2>
- @subpage_single tune_statistics
- @subpage_single wtperf

<p>
- @subpage_single tune_build_options
- @subpage_single tune_bulk_load
- @subpage_single tune_cache
- @subpage_single tune_capacity
- @subpage_single tune_checksum
- @subpage_single tune_close
- @subpage_single tune_cursor_persist
- @subpage_single tune_durability
- @subpage_single tune_file_alloc
- @subpage_single tune_memory_allocator
- @subpage_single tune_mutex
- @subpage_single tune_page_size_and_comp
- @subpage_single tune_read_only
- @subpage_single tune_system_buffer_cache
- @subpage_single tune_transparent_huge_pages
- @subpage_single tune_zone_reclaim

 */