summaryrefslogtreecommitdiff
path: root/src/docs
diff options
context:
space:
mode:
authorDavid Hows <david.hows@mongodb.com>2017-01-06 12:12:50 +1100
committerDavid Hows <david.hows@mongodb.com>2017-01-06 12:12:50 +1100
commitd48181f6f4db08761ed7b80b0332908b272ad0d0 (patch)
tree38929fdcc5415ee7b001b6f1a406bd5bd777b737 /src/docs
parent040e3d6f764c0fb626cb47fede54469f57d0c6e0 (diff)
parent8d2324943364286056ae399043f70b8a937de312 (diff)
Merge branch 'mongodb-3.6' into mongodb-3.2mongodb-3.2.12
Diffstat (limited to 'src/docs')
-rwxr-xr-xsrc/docs/build-pydoc.sh2
-rw-r--r--src/docs/command-line.dox33
-rw-r--r--src/docs/testing.dox2
-rw-r--r--src/docs/top/main.dox8
-rw-r--r--src/docs/upgrading.dox47
5 files changed, 79 insertions, 13 deletions
diff --git a/src/docs/build-pydoc.sh b/src/docs/build-pydoc.sh
index 5e6e3635be5..aef88fd4c97 100755
--- a/src/docs/build-pydoc.sh
+++ b/src/docs/build-pydoc.sh
@@ -3,4 +3,4 @@ TOP=$DOCS/..
. $TOP/config.sh
cd python
-PYTHONPATH=../../lang/python/src:$THRIFT_HOME/lib/python2.6/site-packages pydoc -w wiredtiger
+PYTHONPATH=../../lang/python/src:$THRIFT_HOME/lib/python2.7/site-packages pydoc -w wiredtiger
diff --git a/src/docs/command-line.dox b/src/docs/command-line.dox
index 0f5c56d25ce..5726a1d19a1 100644
--- a/src/docs/command-line.dox
+++ b/src/docs/command-line.dox
@@ -37,6 +37,39 @@ In general, commands that modify the database or tables will run recovery
by default and commands that only read data will not run recovery.
<hr>
+@section util_alter wt alter
+Alter a table.
+
+@subsection util_alter_synopsis Synopsis
+<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] alter uri configuration ...</code>
+
+The \c uri and \c configuration pairs may be specified to the
+\c alter command. These configuration pairs can be used to modify the
+configuration values from those passed to the WT_SESSION::create
+call.
+
+The \c uri part of the configuration pair should match only one of the
+objects being altered, but may be a prefix of the object being matched.
+For example, the following two sets of configuration pairs are
+equivalent in the case of altering a single table named \c xxx.
+
+@code
+table access_pattern_hint=sequential
+table:xxx access_pattern_hint=sequential
+@endcode
+
+It's an error, however, to specify a matching prefix that matches more
+than a single object being altered.
+
+Multiple \c configuration arguments may be specified. For example, the
+following two sets of configuration pairs are equivalent:
+
+@code
+table:xxx access_pattern_hint=random,cache_resident=false
+table:xxx access_pattern_hint=random table:xxx cache_resident=false
+@endcode
+
+<hr>
@section util_backup wt backup
Perform a backup of a database or set of data sources.
diff --git a/src/docs/testing.dox b/src/docs/testing.dox
index 7d454d54212..cf280e8f3ff 100644
--- a/src/docs/testing.dox
+++ b/src/docs/testing.dox
@@ -27,7 +27,7 @@ The WiredTiger unit test suite includes tests that cover:
The WiredTiger Python test suite is built using the WiredTiger Python
API and the Python unittest functionality (the test suite requires at
-least Python version 2.6).
+least Python version 2.7).
The WiredTiger test suite automatically runs as part of every commit
into the WiredTiger GitHub source tree.
diff --git a/src/docs/top/main.dox b/src/docs/top/main.dox
index 08f7536d540..01acc849d50 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.8.0</b> (current),
+@row{<b>WiredTiger 2.9.0</b> (current),
+ <a href="releases/wiredtiger-2.9.0.tar.bz2"><b>[Release package]</b></a>,
+ <a href="2.9.0/index.html"><b>[Documentation]</b></a>}
+@row{<b>WiredTiger 2.8.0</b> (previous),
<a href="releases/wiredtiger-2.8.0.tar.bz2"><b>[Release package]</b></a>,
<a href="2.8.0/index.html"><b>[Documentation]</b></a>}
-@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>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/upgrading.dox b/src/docs/upgrading.dox
index caa6b036892..1e0e2eaf99a 100644
--- a/src/docs/upgrading.dox
+++ b/src/docs/upgrading.dox
@@ -1,7 +1,31 @@
/*! @page upgrading Upgrading WiredTiger applications
+@section version_291 Upgrading to Version 2.9.1
+<dl>
+<dt>WiredTiger now requires Python 2.7 at minimum</dt>
+<dd>
+The minimum version of Python supported by WiredTiger is now 2.7 up from the
+previous version of 2.6. This is due to extra unit tests added in this release
+that depend on 2.7. This is not due to a change in the Python API.
+</dd>
+
+<dt>Changes to hazard pointer configuration</dt>
+<dd>
+The \c hazard_max parameter to ::wiredtiger_open is now ignored. Memory is
+allocated for hazard pointers as required by each session.
+</dd>
+</dl><hr>
-@section version_281 Upgrading to Version 2.8.1
+@section version_290 Upgrading to Version 2.9.0
<dl>
+<dt>Changes to cursor behavior after WT_CURSOR::insert</dt>
+<dd>
+After a successful call to WT_CURSOR::insert, unless a cursor has record
+number keys and was configured with "append=true", the cursor's key is
+cleared and a subsequent call to the WT_CURSOR::get_key method will fail.
+In all cursors, the value is cleared and a subsequent call to
+WT_CURSOR::get_value will fail.
+</dd>
+
<dt>Cache management defaults</dt>
<dd>
The default values for the \c eviction_dirty_target and \c
@@ -17,6 +41,15 @@ how much work is done at the beginning of a checkpoint to make the critical
section of checkpoints complete more quickly.
</dd>
+<dt>Change to default fadvise setting for data files</dt>
+<dd>
+The default behavior for data files was to advise the file system to optimize
+for random access on POSIX and Windows platforms. The default is now to not
+advise about access patterns. There is a new \c access_pattern_hint
+configuration string available to WT_SESSION::create that can be used
+to configure the old default behavior.
+</dd>
+
<dt>Checkpoint server created checkpoint names</dt>
<dd>
The ::wiredtiger_open checkpoint configuration no longer supports the
@@ -34,13 +67,13 @@ of the path may no longer be specified. Applications depending on the
ability to set statistics log file names will require modification.
</dd>
-<dt>Deprecated statistics field</dt>
+<dt>Removed and renamed statistics fields</dt>
<dd>
-The connection statistic \c WT_STAT_CONN_CACHE_BYTES_OVERFLOW has been
-removed. Overflow information is now available in the
-\c WT_STAT_CONN_CACHE_BYTES_OVERFLOW and \c WT_STAT_CONN_CACHE_OVERFLOW_VALUE.
-Applications specifically looking for that statistic will require
-modification.
+WT_STAT_JOIN_ACTUAL_COUNT is renamed to WT_STAT_JOIN_ITERATED
+
+WT_STAT_CONN_CACHE_BYTES_OVERFLOW removed since overflow pages are not cached
+
+WT_STAT_CONN_CACHE_EVICTION_SERVER_NOT_EVICTING removed since all eviction threads can now be the server
</dd>
</dl><hr>