summaryrefslogtreecommitdiff
path: root/src/third_party/wiredtiger/src/docs/examples.dox
diff options
context:
space:
mode:
Diffstat (limited to 'src/third_party/wiredtiger/src/docs/examples.dox')
-rw-r--r--src/third_party/wiredtiger/src/docs/examples.dox58
1 files changed, 58 insertions, 0 deletions
diff --git a/src/third_party/wiredtiger/src/docs/examples.dox b/src/third_party/wiredtiger/src/docs/examples.dox
new file mode 100644
index 00000000000..3ed7357b52c
--- /dev/null
+++ b/src/third_party/wiredtiger/src/docs/examples.dox
@@ -0,0 +1,58 @@
+/*!
+@example ex_access.c
+Create, insert and access a simple table.
+
+@example ex_async.c
+Show how to configure and use asynchronous operations.
+
+@example ex_call_center.c
+A more complex schema based on a call center example, showing how to map
+some SQL constructs onto the WiredTiger API.
+
+@example ex_config.c
+Shows how to configure some properties of the database and tables.
+
+@example ex_cursor.c
+Shows some common cursor types and operations.
+
+@example ex_encrypt.c
+Shows how to extend WiredTiger with a simple encryption algorithm.
+
+@example nop_encrypt.c
+Shows the basic framework for building an encryptor as a plug in library.
+
+@example rotn_encrypt.c
+Shows a simple encryptor as a plug in library.
+
+@example ex_extending.c
+Shows how to extend WiredTiger with application-specific collations,
+extractors and cursor types.
+
+@example ex_extractor.c
+Shows how to extend WiredTiger with a more complex custom extractor.
+
+@example ex_hello.c
+This is an example of how to create and open a database.
+
+@example ex_pack.c
+Shows basic packing and unpacking of fields.
+
+@cond sharing
+@notyet{inter-process sharing}
+@example ex_process.c
+Shows how to connect to a database from multiple processes.
+@endcond
+
+@example ex_schema.c
+Shows how to create column-oriented data and access individual columns.
+
+@example ex_stat.c
+Shows how to access database and table statistics.
+
+@example ex_log.c
+Shows how to access the database log files.
+
+@example ex_thread.c
+Shows how to access a database with multiple threads.
+
+ */