summaryrefslogtreecommitdiff
path: root/src/docs/in-memory.dox
diff options
context:
space:
mode:
Diffstat (limited to 'src/docs/in-memory.dox')
-rw-r--r--src/docs/in-memory.dox12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/docs/in-memory.dox b/src/docs/in-memory.dox
new file mode 100644
index 00000000000..df221dc34d6
--- /dev/null
+++ b/src/docs/in-memory.dox
@@ -0,0 +1,12 @@
+/*! @m_page{{c,java},in_memory,In-memory databases}
+
+The ::wiredtiger_open \c in_memory configuration changes WiredTiger to
+run in cache without writing to a backing disk. Data is limited to the
+configured cache size.
+
+If \c in_memory is configured, WT_CURSOR::insert and WT_CURSOR::update
+methods may return an additional error, ::WT_CACHE_FULL, indicating the
+insert or update operation requires more than the configured cache size
+to complete. If a transaction is in progress, it should be rolled back.
+
+ */