diff options
Diffstat (limited to 'src/docs/introduction.dox')
| -rw-r--r-- | src/docs/introduction.dox | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/src/docs/introduction.dox b/src/docs/introduction.dox new file mode 100644 index 00000000000..055bf09c40d --- /dev/null +++ b/src/docs/introduction.dox @@ -0,0 +1,46 @@ +-/*! @mainpage Reference Guide + +WiredTiger is an high performance, scalable, production quality, NoSQL, +Open Source extensible platform for data management. + +WiredTiger supports both traditional row-oriented storage, where all +columns of a row are stored together, and column-oriented storage, where +one or more columns can be stored individually, allowing more efficient +access and storage. + +For more information on the WiredTiger architecture and why it might be +right for your project, see: + +- @subpage architecture. + +This documentation describes the programming interface to WiredTiger +used by developers to construct 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. + +WiredTiger distributions are tested on Linux, FreeBSD and Mac OS X. +WiredTiger should be portable to any system that supports the ANSI C99, +POSIX 1003.1 and POSIX 1003.1c (threads extension) standards. + +For more information about using WiredTiger, see: + +- @subpage install\n + +- @subpage using\n + +- @ref wt "WiredTiger API reference manual" + +- @subpage command_line\n + +To browse or download the WiredTiger source code, visit our + +- <a href="https://github.com/wiredtiger/wiredtiger"><b>Project page</b></a> + +To ask questions or discuss issues related to using WiredTiger, visit our + +- <a href="http://groups.google.com/group/wiredtiger-users"><b>User Group</b></a> + +*/ |