diff options
Diffstat (limited to 'src/docs')
-rwxr-xr-x | src/docs/build-javadoc.sh | 2 | ||||
-rw-r--r-- | src/docs/command-line.dox | 41 | ||||
-rw-r--r-- | src/docs/license.dox | 21 | ||||
-rw-r--r-- | src/docs/programming.dox | 5 | ||||
-rw-r--r-- | src/docs/rebalance.dox | 14 | ||||
-rw-r--r-- | src/docs/schema.dox | 4 | ||||
-rw-r--r-- | src/docs/spell.ok | 3 | ||||
-rw-r--r-- | src/docs/style/footer.html | 4 | ||||
-rwxr-xr-x | src/docs/tools/doxfilter.py | 2 | ||||
-rwxr-xr-x | src/docs/tools/fixlinks.py | 2 | ||||
-rw-r--r-- | src/docs/top/main.dox | 8 | ||||
-rw-r--r-- | src/docs/tune-bulk-load.dox | 8 | ||||
-rw-r--r-- | src/docs/upgrading.dox | 28 | ||||
-rw-r--r-- | src/docs/wtperf.dox | 23 |
14 files changed, 120 insertions, 45 deletions
diff --git a/src/docs/build-javadoc.sh b/src/docs/build-javadoc.sh index 39c9d989b6c..be886937070 100755 --- a/src/docs/build-javadoc.sh +++ b/src/docs/build-javadoc.sh @@ -8,5 +8,5 @@ CLASSPATH=$THRIFT_HOME/libthrift.jar:$SLF4J_JAR javadoc -public -d $DOCS/java \ -stylesheetfile $DOCS/style/javadoc.css \ -use -link http://java.sun.com/j2se/1.5.0/docs/api/ \ -header '<b>WiredTiger API</b><br><font size="-1"> version '$WT_VERSION'</font>' \ - -windowtitle 'WiredTiger Java API' -bottom '<font size=1>Copyright (c) 2008-2015 MongoDB, Inc. All rights reserved.</font>' \ + -windowtitle 'WiredTiger Java API' -bottom '<font size=1>Copyright (c) 2008-2016 MongoDB, Inc. All rights reserved.</font>' \ com.wiredtiger com.wiredtiger.util diff --git a/src/docs/command-line.dox b/src/docs/command-line.dox index 745c5051be3..e2b376d5e3f 100644 --- a/src/docs/command-line.dox +++ b/src/docs/command-line.dox @@ -32,7 +32,7 @@ on success and non-zero on error. The \c wt tool supports several commands. If configured in the underlying database, some commands will run recovery when opening the database. If -the user wants to force recovery on any command, use the \c -r option. +the user wants to force recovery on any command, use the \c -R option. In general, commands that modify the database or tables will run recovery by default and commands that only read data will not run recovery. @@ -46,7 +46,7 @@ opened as a WiredTiger database. See @ref backup for more information, and @ref file_permissions for specifics on the copied file permissions. @subsection util_backup_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] backup [-t uri] directory</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] backup [-t uri] directory</code> @subsection util_backup_options Options The following are command-specific options for the \c backup command: @@ -64,7 +64,7 @@ The \c compact command attempts to rewrite the specified table or file to consume less disk space. @subsection util_compact_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] compact uri</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] compact uri</code> @subsection util_compact_options Options The \c compact command has no command-specific options. @@ -78,7 +78,7 @@ configuration. It is equivalent to a call to WT_SESSION::create with the specified string arguments. @subsection util_create_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] create [-c config] uri</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] create [-c config] uri</code> @subsection util_create_options Options The following are command-specific options for the \c create command: @@ -94,7 +94,7 @@ The \c drop command drops the specified \c uri. It is equivalent to a call to WT_SESSION::drop with the "force" configuration argument. @subsection util_drop_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] drop uri</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] drop uri</code> @subsection util_drop_options Options The \c drop command has no command-specific options. @@ -109,7 +109,7 @@ which can be re-loaded into a new table using the \c load command. See @subpage dump_formats for details of the dump file formats. @subsection util_dump_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] dump [-jrx] [-c checkpoint] [-f output] uri</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] dump [-jrx] [-c checkpoint] [-f output] uri</code> @subsection util_dump_options Options The following are command-specific options for the \c dump command: @@ -143,7 +143,7 @@ the database. If a URI is specified as an argument, only information about that data source is printed. @subsection util_list_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] list [-cv] [uri]</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] list [-cv] [uri]</code> @subsection util_list_options Options The following are command-specific options for the \c list command: @@ -170,7 +170,7 @@ table will be overwritten by the new data (use the \c -n option to make an attempt to overwrite existing data return an error). @subsection util_load_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] load [-ajn] [-f input] [-r name] [uri configuration ...]</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] load [-ajn] [-f input] [-r name] [uri configuration ...]</code> @subsection util_load_options Options The following are command-specific options for the \c load command: @@ -244,7 +244,7 @@ row-store table or file already exists, data in the table or file will be overwritten by the new data. @subsection util_loadtext_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] loadtext [-f input]</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] loadtext [-f input]</code> @subsection util_loadtext_options Options The following are command-specific options for the \c loadtext command: @@ -260,7 +260,7 @@ Display the database log. The \c printlog command outputs the database log. @subsection util_printlog_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] printlog [-p] [-f output]</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] printlog [-x] [-f output]</code> @subsection util_printlog_options Options The following are command-specific options for the \c printlog command: @@ -269,8 +269,9 @@ The following are command-specific options for the \c printlog command: By default, the \c printlog command output is written to the standard output; the \c -f option re-directs the output to the specified file. -@par <code>-p</code> -Display the log in a printable format. +@par <code>-x</code> +Keys and value items in the log are printed in hex format in addition +to the default string format. <hr> @section util_read wt read @@ -283,7 +284,7 @@ with string or record number keys and string values. The \c read command exits non-zero if a specified record is not found. @subsection util_read_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] read uri key ...</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] read uri key ...</code> @subsection util_read_options Options The \c read command has no command-specific options. @@ -295,7 +296,7 @@ Rename a table or file. The \c rename command renames the specified table or file. @subsection util_rename_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] rename uri name</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] rename uri name</code> @subsection util_rename_options Options The \c rename command has no command-specific options. @@ -309,7 +310,7 @@ data that cannot be recovered. Underlying files are re-written in place, overwriting the original file contents. @subsection util_salvage_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] salvage [-F force] uri</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] salvage [-F force] uri</code> @subsection util_salvage_options Options The following are command-specific options for the \c salvage command: @@ -327,7 +328,7 @@ The \c stat command outputs run-time statistics for the WiredTiger engine, or, if specified, for the URI on the command-line. @subsection util_stat_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] stat [-f] [uri]</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] stat [-f] [uri]</code> @subsection util_stat_options Options The following are command-specific options for the \c stat command: @@ -345,7 +346,7 @@ success if the data source is up-to-date, and failure if the data source cannot be upgraded. @subsection util_upgrade_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] upgrade uri</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] upgrade uri</code> @subsection util_upgrade_options Options The \c upgrade command has no command-specific options. @@ -359,7 +360,7 @@ success if the data source is correct, and failure if the data source is corrupted. @subsection util_verify_synopsis Synopsis -<code>wt [-rVv] [-C config] [-E secretkey ] [-h directory] verify uri</code> +<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] verify uri</code> @subsection util_verify_options Options The \c verify command has no command-specific options. @@ -381,9 +382,9 @@ Attempting to overwrite an already existing record will fail. @subsection util_write_synopsis Synopsis <code> -wt [-rVv] [-C config] [-E secretkey ] [-h directory] write -a uri value ... +wt [-RVv] [-C config] [-E secretkey ] [-h directory] write -a uri value ... <br> -wt [-rVv] [-C config] [-E secretkey ] [-h directory] write [-o] uri key value ... +wt [-RVv] [-C config] [-E secretkey ] [-h directory] write [-o] uri key value ... </code> @subsection util_write_options Options diff --git a/src/docs/license.dox b/src/docs/license.dox index f34ebad19a7..febced2c6af 100644 --- a/src/docs/license.dox +++ b/src/docs/license.dox @@ -13,6 +13,19 @@ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the <b>GNU General Public License</b></a> for details. +Additionally, portions of the WiredTiger distribution are distributed +under the terms of the +<a href="http://www.opensource.org/licenses/BSD-3-Clause"> +BSD-3-Clause License</a>. These files have +<a href="http://www.opensource.org/licenses/BSD-3-Clause"> +BSD-3-Clause License</a> +copyright notices, and may be freely used and redistributed under the +terms of that notice. + +Additionally, portions of the WiredTiger distribution are public domain +software. Public domain files have notices releasing the software into +the public domain and may be freely used and redistributed. + For a license to use the WiredTiger software under conditions other than those described above, or for technical support for this software, please contact MongoDB, Inc. at @@ -28,7 +41,7 @@ of the WiredTiger library should comply with these copyrights. @hrow{Distribution Files, Copyright Holder, License} @row{\c src/include/bitstring.i, University of California\, Berkeley, <a href="http://www.opensource.org/licenses/BSD-3-Clause">BSD-3-Clause License</a>} @row{\c src/include/queue.h, University of California\, Berkeley, <a href="http://www.opensource.org/licenses/BSD-3-Clause">BSD-3-Clause License</a>} -@row{\c src/os_posix/getopt.c, University of California\, Berkeley, <a href="http://www.opensource.org/licenses/BSD-3-Clause">BSD-3-Clause License</a>} +@row{\c src/os_posix/os_getopt.c, University of California\, Berkeley, <a href="http://www.opensource.org/licenses/BSD-3-Clause">BSD-3-Clause License</a>} @row{\c src/support/hash_city.c, Google\, Inc., <a href="http://www.opensource.org/licenses/MIT">The MIT License</a>} @row{\c src/support/hash_fnv.c, Authors, Public Domain} </table> @@ -63,10 +76,4 @@ selected portions of the WiredTiger sources, please review the copyright notices and LICENSE files included in the WiredTiger distribution for the terms and conditions of such redistribution. -@section license_public_domain Public domain software - -Many portions of the WiredTiger distribution are public domain software. -Public domain files have notices releasing the software into the public -domain and may be freely used and redistributed. - */ diff --git a/src/docs/programming.dox b/src/docs/programming.dox index f005f6d3e2d..5d79edd660b 100644 --- a/src/docs/programming.dox +++ b/src/docs/programming.dox @@ -40,11 +40,12 @@ each of which is ordered by one or more columns. - @subpage compact - @subpage checkpoint - @subpage durability +- @subpage cursor_join +- @subpage cursor_log - @ref transaction_named_snapshots +- @subpage rebalance - @subpage shared_cache - @subpage statistics -- @subpage cursor_join -- @subpage cursor_log - @subpage_single upgrade @m_if{c} diff --git a/src/docs/rebalance.dox b/src/docs/rebalance.dox new file mode 100644 index 00000000000..a6acfe07ef5 --- /dev/null +++ b/src/docs/rebalance.dox @@ -0,0 +1,14 @@ +/*! @m_page{{c,java},rebalance,Rebalance} + +The WT_SESSION::rebalance method can be used to rebalance data sources' +underlying btrees. If a tree has become unbalanced (that is, one part of +the tree is excessively deep), WT_SESSION::rebalance rewrites the tree +as a balanced tree. + +The data source must be quiescent. + +The WT_SESSION::rebalance method should never be needed, as WiredTiger +btrees are maintained as balanced trees. It is only provided as a tool +to handle the unexpected. + + */ diff --git a/src/docs/schema.dox b/src/docs/schema.dox index 66f8046965e..65ad7f6919c 100644 --- a/src/docs/schema.dox +++ b/src/docs/schema.dox @@ -89,6 +89,10 @@ struct module to describe the types of columns in a table: The \c 'r' type is used for record number keys in column stores. It is otherwise identical to the \c 'Q' type. +The \c 's' type is used for fixed-length strings. If it is preceded by +a size, that indicates the number of bytes to store; the default is a +length of 1 byte. + The \c 'S' type is encoded as a C language string terminated by a NUL character. @m_if{java} diff --git a/src/docs/spell.ok b/src/docs/spell.ok index 86af82d8fd2..80597302cbb 100644 --- a/src/docs/spell.ok +++ b/src/docs/spell.ok @@ -66,6 +66,7 @@ NoSQL OPTYPE PRELOAD README +Rebalance RedHat RepMgr Riak @@ -120,6 +121,7 @@ boolean booleans br btree +btrees bufs builtin builtins @@ -378,6 +380,7 @@ readlock realclean realloc realloc'd +rebalance recno recnoN recnum diff --git a/src/docs/style/footer.html b/src/docs/style/footer.html index 83f1254fa42..e5a7b30eef5 100644 --- a/src/docs/style/footer.html +++ b/src/docs/style/footer.html @@ -3,13 +3,13 @@ <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> $navpath - <li class="footer">Copyright (c) 2008-2015 MongoDB, Inc. All rights reserved. Contact <a href="mailto:info@wiredtiger.com">info@wiredtiger.com</a> for more information.</li> + <li class="footer">Copyright (c) 2008-2016 MongoDB, Inc. All rights reserved. Contact <a href="mailto:info@wiredtiger.com">info@wiredtiger.com</a> for more information.</li> </ul> </div> <!--END GENERATE_TREEVIEW--> <!--BEGIN !GENERATE_TREEVIEW--> <hr class="footer"/><address class="footer"><small> -Copyright (c) 2008-2015 MongoDB, Inc. All rights reserved. Contact <a href="mailto:info@wiredtiger.com">info@wiredtiger.com</a> for more information. +Copyright (c) 2008-2016 MongoDB, Inc. All rights reserved. Contact <a href="mailto:info@wiredtiger.com">info@wiredtiger.com</a> for more information. </small></address> <!--END !GENERATE_TREEVIEW--> </body> diff --git a/src/docs/tools/doxfilter.py b/src/docs/tools/doxfilter.py index 8ca68c0a1fe..b2d5f857df1 100755 --- a/src/docs/tools/doxfilter.py +++ b/src/docs/tools/doxfilter.py @@ -1,6 +1,6 @@ #!/usr/bin/env python # -# Public Domain 2014-2015 MongoDB, Inc. +# Public Domain 2014-2016 MongoDB, Inc. # Public Domain 2008-2014 WiredTiger, Inc. # # This is free and unencumbered software released into the public domain. diff --git a/src/docs/tools/fixlinks.py b/src/docs/tools/fixlinks.py index 84f56d219f8..7163246e3bd 100755 --- a/src/docs/tools/fixlinks.py +++ b/src/docs/tools/fixlinks.py @@ -1,6 +1,6 @@ #!/usr/bin/env python # -# Public Domain 2014-2015 MongoDB, Inc. +# Public Domain 2014-2016 MongoDB, Inc. # Public Domain 2008-2014 WiredTiger, Inc. # # This is free and unencumbered software released into the public domain. diff --git a/src/docs/top/main.dox b/src/docs/top/main.dox index ef2f5bf15a0..7e670541e7d 100644 --- a/src/docs/top/main.dox +++ b/src/docs/top/main.dox @@ -6,12 +6,12 @@ WiredTiger is an high performance, scalable, production quality, NoSQL, @section releases Releases <table> -@row{<b>WiredTiger 2.6.1</b> (current), +@row{<b>WiredTiger 2.7.0</b> (current), + <a href="releases/wiredtiger-2.7.0.tar.bz2"><b>[Release package]</b></a>, + <a href="2.7.0/index.html"><b>[Documentation]</b></a>} +@row{<b>WiredTiger 2.6.1</b> (previous), <a href="releases/wiredtiger-2.6.1.tar.bz2"><b>[Release package]</b></a>, <a href="2.6.1/index.html"><b>[Documentation]</b></a>} -@row{<b>WiredTiger 2.5.3</b> (previous), - <a href="releases/wiredtiger-2.5.3.tar.bz2"><b>[Release package]</b></a>, - <a href="2.5.3/index.html"><b>[Documentation]</b></a>} @row{<b>Development branch</b>, <a href="https://github.com/wiredtiger/wiredtiger"><b>[Source code]</b></a>, <a href="develop/index.html"><b>[Documentation]</b></a>} diff --git a/src/docs/tune-bulk-load.dox b/src/docs/tune-bulk-load.dox index 8ee1061c76c..f5d28436dca 100644 --- a/src/docs/tune-bulk-load.dox +++ b/src/docs/tune-bulk-load.dox @@ -15,8 +15,12 @@ WT_CURSOR::close methods. Bulk load inserts are non-transactional: they cannot be rolled back and ignore the transactional state of the WT_SESSION in which they are opened. -When bulk-loading row-store objects, keys must be loaded in sorted -order. +When doing a bulk-load insert, keys must be inserted in sorted order. +When doing a bulk-load insert into a column-store object, any skipped +records will be created as already-deleted rows. If a column-store +bulk-load cursor is configured with \c append, the cursor key will be +ignored and each inserted row will be assigned the next sequential +record number. When using the \c sort utility on a Linux or other POSIX-like system to pre-sort keys, the locale specified by the environment affects the sort diff --git a/src/docs/upgrading.dox b/src/docs/upgrading.dox index 34f391b27f1..e0239919f0b 100644 --- a/src/docs/upgrading.dox +++ b/src/docs/upgrading.dox @@ -1,5 +1,33 @@ /*! @page upgrading Upgrading WiredTiger applications +@section version_271 Upgrading to Version 2.7.1 +<dl> +<dt>Column-store bulk-load cursors</dt> +<dd> +Historically, bulk-load of a column-store object ignored any key set in +the cursor and automatically assigned each inserted row the next +sequential record number for its key. In the 2.7.1 release, column-store +objects match row-store behavior and require the cursor key be set +before an insert. (This also allows allows sparse tables to be created +in column-store objects, any skipped records are created as +already-deleted rows.) To match the previous behavior, specify the +\c append configuration string when opening the column-store bulk-load +cursor; this causes the cursor's key to be ignored and each inserted row +will be assigned the next record number. +</dd> + +<dt>Change to WT_SESSION::truncate with URI</dt> +<dd> +If using the WT_SESSION::truncate API with a file: URI for a full table +truncate, underlying algorithmic changes result in some visible differences. +This call can now return WT_ROLLBACK. Applications should be prepared to +handle this error. This method no longer requires exclusive access to the +table. Also the underlying disk space may not be immediately +reclaimed when the call returns. The performance of this API may differ +from earlier releases. +</dd> + +</dl><hr> @section version_270 Upgrading to Version 2.7.0 <dl> diff --git a/src/docs/wtperf.dox b/src/docs/wtperf.dox index fb46a91a62c..64e25978dd8 100644 --- a/src/docs/wtperf.dox +++ b/src/docs/wtperf.dox @@ -173,6 +173,10 @@ taken to do the drop. @par icount (unsigned int, default=5000) number of records to initially populate. If multiple tables are configured the count is spread evenly across all tables. +@par idle_table_cycle (unsigned int, default=0) +Enable regular create and drop of idle tables, value is the maximum +number of seconds a create or drop is allowed before flagging an +error. Default 0 which means disabled. @par index (boolean, default=false) Whether to create an index on the value field. @par insert_rmw (boolean, default=false) @@ -182,11 +186,17 @@ key size @par log_partial (boolean, default=false) perform partial logging on first table only. @par min_throughput (unsigned int, default=0) -abort if any throughput measured is less than this amount. Requires +notify if any throughput measured is less than this amount. Aborts or +prints warning based on min_throughput_fatal setting. Requires sample_interval to be configured +@par min_throughput_fatal (boolean, default=false) +print warning (false) or abort (true) of min_throughput failure. @par max_latency (unsigned int, default=0) -abort if any latency measured exceeds this number of -milliseconds.Requires sample_interval to be configured +notify if any latency measured exceeds this number of +milliseconds.Aborts or prints warning based on min_throughput_fatal +setting. Requires sample_interval to be configured +@par max_latency_fatal (boolean, default=false) +print warning (false) or abort (true) of max_latency failure. @par pareto (unsigned int, default=0) use pareto distribution for random numbers. Zero to disable, otherwise a percentage indicating how aggressive the distribution should be. @@ -200,6 +210,8 @@ if non zero choose a value from within this range as the key for insert operations @par random_value (boolean, default=false) generate random content for the value +@par read_range (unsigned int, default=0) +scan a range of keys after each search @par reopen_connection (boolean, default=true) close and reopen the connection between populate and workload phases @par report_interval (unsigned int, default=2) @@ -230,8 +242,9 @@ threads, and the 'insert', 'read' and 'update' entries are the ratios of insert, read and update operations done by each worker thread; If a throttle value is provided each thread will do a maximum of that number of operations per second; multiple workload configurations may -be specified; for example, a more complex threads configuration might -be 'threads=((count=2,reads=1)(count=8,reads=1,inserts=2,updates=1))' +be specified per threads configuration; for example, a more complex +threads configuration might be +'threads=((count=2,reads=1)(count=8,reads=1,inserts=2,updates=1))' which would create 2 threads doing nothing but reads and 8 threads each doing 50% inserts and 25% reads and updates. Allowed configuration values are 'count', 'throttle', 'reads', 'inserts', |