Changelog¶
Changes in Version 3.6.1¶
Version 3.6.1 fixes bugs reported since the release of 3.6.0:
- Fix regression in PyMongo 3.5.0 that causes idle sockets to be closed almost
instantly when
maxIdleTimeMS
is set. Idle sockets are now closed aftermaxIdleTimeMS
milliseconds. pymongo.mongo_client.MongoClient.max_idle_time_ms
now returns milliseconds instead of seconds.- Properly import and use the monotonic library for monotonic time when it is installed.
aggregate()
now ignores thebatchSize
argument when running a pipeline with a$out
stage.- Always send handshake metadata for new connections.
Issues Resolved¶
See the PyMongo 3.6.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.6.0¶
Version 3.6 adds support for MongoDB 3.6, drops support for CPython 3.3 (PyPy3
is still supported), and drops support for MongoDB versions older than 2.6. If
connecting to a MongoDB 2.4 server or older, PyMongo now throws a
ConfigurationError
.
Highlights include:
- Support for change streams. See the
watch()
method for details. - Support for array_filters in
update_one()
,update_many()
,find_one_and_update()
,UpdateOne()
, andUpdateMany()
. - New Session API, see
start_session()
. - New methods
find_raw_batches()
andaggregate_raw_batches()
for use with external libraries that can parse raw batches of BSON data. - New methods
list_databases()
andlist_database_names()
. - New methods
list_collections()
andlist_collection_names()
. - Support for mongodb+srv:// URIs. See
MongoClient
for details. - Index management helpers
(
create_index()
,create_indexes()
,drop_index()
,drop_indexes()
,reindex()
) now support maxTimeMS. - Support for retryable writes and the
retryWrites
URI option. SeeMongoClient
for details.
Deprecations:
- The useCursor option for
aggregate()
is deprecated. The option was only necessary when upgrading from MongoDB 2.4 to MongoDB 2.6. MongoDB 2.4 is no longer supported. - The
add_user()
andremove_user()
methods are deprecated. See the method docstrings for alternatives.
Unavoidable breaking changes:
- Starting in MongoDB 3.6, the deprecated methods
authenticate()
andlogout()
now invalidate all cursors created prior. Instead of using these methods to change credentials, pass credentials for one user to theMongoClient
at construction time, and either grant access to several databases to one user account, or use a distinct client object for each user. - BSON binary subtype 4 is decoded using RFC-4122 byte order regardless
of the UUID representation. This is a change in behavior for applications
that use UUID representation
bson.binary.JAVA_LEGACY
orbson.binary.CSHARP_LEGACY
to decode BSON binary subtype 4. Other UUID representations,bson.binary.PYTHON_LEGACY
(the default) andbson.binary.STANDARD
, and the decoding of BSON binary subtype 3 are unchanged.
Issues Resolved¶
See the PyMongo 3.6 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.5.1¶
Version 3.5.1 fixes bugs reported since the release of 3.5.0:
- Work around socket.getsockopt issue with NetBSD.
pymongo.command_cursor.CommandCursor.close()
now closes the cursor synchronously instead of deferring to a background thread.- Fix documentation build warnings with Sphinx 1.6.x.
Issues Resolved¶
See the PyMongo 3.5.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.5¶
Version 3.5 implements a number of improvements and bug fixes:
Highlights include:
- Username and password can be passed to
MongoClient
as keyword arguments. Before, the only way to pass them was in the URI. - Increased the performance of using
RawBSONDocument
. - Increased the performance of
database_names()
by using the nameOnly option for listDatabases when available. - Increased the performance of
bulk_write()
by reducing the memory overhead ofInsertOne
,DeleteOne
, andDeleteMany
. - Added the collation option to
DeleteOne
,DeleteMany
,ReplaceOne
,UpdateOne
, andUpdateMany
. - Implemented the MongoDB Extended JSON specification.
Decimal128
now works when cdecimal is installed.- PyMongo is now tested against a wider array of operating systems and CPU architectures (including s390x, ARM64, and POWER8).
Changes and Deprecations:
find()
has new options return_key, show_record_id, snapshot, hint, max_time_ms, max_scan, min, max, and comment. Deprecated the option modifiers.- Deprecated
group()
. The group command was deprecated in MongoDB 3.4 and is expected to be removed in MongoDB 3.6. Applications should useaggregate()
with the $group pipeline stage instead. - Deprecated
authenticate()
. Authenticating multiple users conflicts with support for logical sessions in MongoDB 3.6. To authenticate as multiple users, create multiple instances ofMongoClient
. - Deprecated
eval()
. The eval command was deprecated in MongoDB 3.0 and will be removed in a future server version. - Deprecated
SystemJS
. - Deprecated
get_default_database()
. Applications should useget_database()
without the name parameter instead. - Deprecated the MongoClient option socketKeepAlive. It now defaults to true and disabling it is not recommended, see does TCP keepalive time affect MongoDB Deployments?
- Deprecated
initialize_ordered_bulk_op()
,initialize_unordered_bulk_op()
, andBulkOperationBuilder
. Usebulk_write()
instead. - Deprecated
STRICT_JSON_OPTIONS
. UseRELAXED_JSON_OPTIONS
orCANONICAL_JSON_OPTIONS
instead. - If a custom
CodecOptions
is passed toRawBSONDocument
, its document_class must beRawBSONDocument
. list_indexes()
no longer raises OperationFailure when the collection (or database) does not exist on MongoDB >= 3.0. Instead, it returns an emptyCommandCursor
to make the behavior consistent across all MongoDB versions.- In Python 3,
loads()
now automatically decodes JSON $binary with a subtype of 0 intobytes
instead ofBinary
. See the Python 3 FAQ for more details. loads()
now raisesTypeError
orValueError
when parsing JSON type wrappers with values of the wrong type or any extra keys.pymongo.cursor.Cursor.close()
andpymongo.mongo_client.MongoClient.close()
now kill cursors synchronously instead of deferring to a background thread.parse_uri()
now returns the original value of thereadPreference
MongoDB URI option instead of the validated read preference mode.
Issues Resolved¶
See the PyMongo 3.5 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.4¶
Version 3.4 implements the new server features introduced in MongoDB 3.4 and a whole lot more:
Highlights include:
- Complete support for MongoDB 3.4:
- Unicode aware string comparison using Collations.
- Support for the new
Decimal128
BSON type. - A new maxStalenessSeconds read preference option.
- A username is no longer required for the MONGODB-X509 authentication mechanism when connected to MongoDB >= 3.4.
parallel_scan()
supports maxTimeMS.WriteConcern
is automatically applied by all helpers for commands that write to the database when connected to MongoDB 3.4+. This change affects the following helpers:drop_database()
create_collection()
drop_collection()
aggregate()
(when using $out)create_indexes()
create_index()
drop_indexes()
drop_indexes()
drop_index()
map_reduce()
(when output is not “inline”)reindex()
rename()
- Improved support for logging server discovery and monitoring events. See
monitoring
for examples. - Support for matching iPAddress subjectAltName values for TLS certificate verification.
- TLS compression is now explicitly disabled when possible.
- The Server Name Indication (SNI) TLS extension is used when possible.
- Finer control over JSON encoding/decoding with
JSONOptions
. - Allow
Code
objects to have a scope ofNone
, signifying no scope. Also allow encoding Code objects with an empty scope (i.e.{}
).
Warning
Starting in PyMongo 3.4, bson.code.Code.scope
may return
None
, as the default scope is None
instead of {}
.
Note
PyMongo 3.4+ attempts to create sockets non-inheritable when possible (i.e. it sets the close-on-exec flag on socket file descriptors). Support is limited to a subset of POSIX operating systems (not including Windows) and the flag usually cannot be set in a single atomic operation. CPython 3.4+ implements PEP 446, creating all file descriptors non-inheritable by default. Users that require this behavior are encouraged to upgrade to CPython 3.4+.
Since 3.4rc0, the max staleness option has been renamed from maxStalenessMS
to maxStalenessSeconds
, its smallest value has changed from twice
heartbeatFrequencyMS
to 90 seconds, and its default value has changed from
None
or 0 to -1.
Issues Resolved¶
See the PyMongo 3.4 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.3.1¶
Version 3.3.1 fixes a memory leak when decoding elements inside of a
RawBSONDocument
.
Issues Resolved¶
See the PyMongo 3.3.1 release notes in Jira for the list of resolved issues in this release.
Changes in Version 3.3¶
Version 3.3 adds the following major new features:
- C extensions support on big endian systems.
- Kerberos authentication support on Windows using WinKerberos.
- A new
ssl_clrfile
option to support certificate revocation lists. - A new
ssl_pem_passphrase
option to support encrypted key files. - Support for publishing server discovery and monitoring events. See
monitoring
for details. - New connection pool options
minPoolSize
andmaxIdleTimeMS
. - New
heartbeatFrequencyMS
option controls the rate at which background monitoring threads re-check servers. Default is once every 10 seconds.
Warning
PyMongo 3.3 drops support for MongoDB versions older than 2.4. It also drops support for python 3.2 (pypy3 continues to be supported).
Issues Resolved¶
See the PyMongo 3.3 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.2.2¶
Version 3.2.2 fixes a few issues reported since the release of 3.2.1, including a fix for using the connect option in the MongoDB URI and support for setting the batch size for a query to 1 when using MongoDB 3.2+.
Issues Resolved¶
See the PyMongo 3.2.2 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.2.1¶
Version 3.2.1 fixes a few issues reported since the release of 3.2, including
running the mapreduce command twice when calling the
inline_map_reduce()
method and a
TypeError
being raised when calling
download_to_stream()
. This release also
improves error messaging around BSON decoding.
Issues Resolved¶
See the PyMongo 3.2.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.2¶
Version 3.2 implements the new server features introduced in MongoDB 3.2.
Highlights include:
- Full support for MongoDB 3.2 including:
- Support for
ReadConcern
WriteConcern
is now applied tofind_one_and_replace()
,find_one_and_update()
, andfind_one_and_delete()
.- Support for the new bypassDocumentValidation option in write helpers.
- Support for
- Support for reading and writing raw BSON with
RawBSONDocument
Note
Certain MongoClient
properties now
block until a connection is established or raise
ServerSelectionTimeoutError
if no server is available.
See MongoClient
for details.
Issues Resolved¶
See the PyMongo 3.2 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.1.1¶
Version 3.1.1 fixes a few issues reported since the release of 3.1, including a regression in error handling for oversize command documents and interrupt handling issues in the C extensions.
Issues Resolved¶
See the PyMongo 3.1.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.1¶
Version 3.1 implements a few new features and fixes bugs reported since the release of 3.0.3.
Highlights include:
- Command monitoring support. See
monitoring
for details. - Configurable error handling for
UnicodeDecodeError
. See the unicode_decode_error_handler option ofCodecOptions
. - Optional automatic timezone conversion when decoding BSON datetime. See the
tzinfo option of
CodecOptions
. - An implementation of
GridFSBucket
from the new GridFS spec. - Compliance with the new Connection String spec.
- Reduced idle CPU usage in Python 2.
Changes in internal classes¶
The private PeriodicExecutor
class no longer takes a condition_class
option, and the private thread_util.Event
class is removed.
Issues Resolved¶
See the PyMongo 3.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.0.3¶
Version 3.0.3 fixes issues reported since the release of 3.0.2, including a feature breaking bug in the GSSAPI implementation.
Issues Resolved¶
See the PyMongo 3.0.3 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.0.2¶
Version 3.0.2 fixes issues reported since the release of 3.0.1, most
importantly a bug that could route operations to replica set members
that are not in primary or secondary state when using
PrimaryPreferred
or
Nearest
. It is a recommended upgrade for
all users of PyMongo 3.0.x.
Issues Resolved¶
See the PyMongo 3.0.2 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.0.1¶
Version 3.0.1 fixes issues reported since the release of 3.0, most importantly a bug in GridFS.delete that could prevent file chunks from actually being deleted.
Issues Resolved¶
See the PyMongo 3.0.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 3.0¶
PyMongo 3.0 is a partial rewrite of PyMongo bringing a large number of improvements:
- A unified client class. MongoClient is the one and only client class for connecting to a standalone mongod, replica set, or sharded cluster. Migrating from a standalone, to a replica set, to a sharded cluster can be accomplished with only a simple URI change.
- MongoClient is much more responsive to configuration changes in your MongoDB deployment. All connected servers are monitored in a non-blocking manner. Slow to respond or down servers no longer block server discovery, reducing application startup time and time to respond to new or reconfigured servers and replica set failovers.
- A unified CRUD API. All official MongoDB drivers now implement a standard CRUD API allowing polyglot developers to move from language to language with ease.
- Single source support for Python 2.x and 3.x. PyMongo no longer relies on 2to3 to support Python 3.
- A rewritten pure Python BSON implementation, improving performance with pypy and cpython deployments without support for C extensions.
- Better support for greenlet based async frameworks including eventlet.
- Immutable client, database, and collection classes, avoiding a host of thread safety issues in client applications.
PyMongo 3.0 brings a large number of API changes. Be sure to read the changes listed below before upgrading from PyMongo 2.x.
Warning
PyMongo no longer supports Python 2.4, 2.5, or 3.1. If you must use PyMongo with these versions of Python the 2.x branch of PyMongo will be minimally supported for some time.
SONManipulator changes¶
The SONManipulator
API has limitations as a
technique for transforming your data. Instead, it is more flexible and
straightforward to transform outgoing documents in your own code before passing
them to PyMongo, and transform incoming documents after receiving them from
PyMongo.
Thus the add_son_manipulator()
method is
deprecated. PyMongo 3’s new CRUD API does not apply SON manipulators to
documents passed to bulk_write()
,
insert_one()
,
insert_many()
,
update_one()
, or
update_many()
. SON manipulators are not
applied to documents returned by the new methods
find_one_and_delete()
,
find_one_and_replace()
, and
find_one_and_update()
.
SSL/TLS changes¶
When ssl is True
the ssl_cert_reqs option now defaults to
ssl.CERT_REQUIRED
if not provided. PyMongo will attempt to load OS
provided CA certificates to verify the server, raising
ConfigurationError
if it cannot.
Gevent Support¶
In previous versions, PyMongo supported Gevent in two modes: you could call
gevent.monkey.patch_socket()
and pass use_greenlets=True
to
MongoClient
, or you could simply call
gevent.monkey.patch_all()
and omit the use_greenlets
argument.
In PyMongo 3.0, the use_greenlets
option is gone. To use PyMongo with
Gevent simply call gevent.monkey.patch_all()
.
For more information, see PyMongo’s Gevent documentation.
MongoClient
changes¶
MongoClient
is now the one and only
client class for a standalone server, mongos, or replica set.
It includes the functionality that had been split into
MongoReplicaSetClient
: it can connect to a replica set, discover all its
members, and monitor the set for stepdowns, elections, and reconfigs.
MongoClient
now also supports the full
ReadPreference
API.
The obsolete classes MasterSlaveConnection
, Connection
, and
ReplicaSetConnection
are removed.
The MongoClient
constructor no
longer blocks while connecting to the server or servers, and it no
longer raises ConnectionFailure
if they
are unavailable, nor ConfigurationError
if the user’s credentials are wrong. Instead, the constructor
returns immediately and launches the connection process on
background threads. The connect
option is added to control whether
these threads are started immediately, or when the client is first used.
Therefore the alive
method is removed since it no longer provides meaningful
information; even if the client is disconnected, it may discover a server in
time to fulfill the next operation.
In PyMongo 2.x, MongoClient
accepted a list of
standalone MongoDB servers and used the first it could connect to:
MongoClient(['host1.com:27017', 'host2.com:27017'])
A list of multiple standalones is no longer supported; if multiple servers are listed they must be members of the same replica set, or mongoses in the same sharded cluster.
The behavior for a list of mongoses is changed from “high availability” to “load balancing”. Before, the client connected to the lowest-latency mongos in the list, and used it until a network error prompted it to re-evaluate all mongoses’ latencies and reconnect to one of them. In PyMongo 3, the client monitors its network latency to all the mongoses continuously, and distributes operations evenly among those with the lowest latency. See mongos Load Balancing for more information.
The client methods start_request
, in_request
, and end_request
are removed, and so is the auto_start_request
option. Requests were
designed to make read-your-writes consistency more likely with the w=0
write concern. Additionally, a thread in a request used the same member for
all secondary reads in a replica set. To ensure read-your-writes consistency
in PyMongo 3.0, do not override the default write concern with w=0
, and
do not override the default read preference of
PRIMARY.
Support for the slaveOk
(or slave_okay
), safe
, and
network_timeout
options has been removed. Use
SECONDARY_PREFERRED
instead of
slave_okay. Accept the default write concern, acknowledged writes, instead of
setting safe=True. Use socketTimeoutMS in place of network_timeout (note that
network_timeout was in seconds, where as socketTimeoutMS is milliseconds).
The max_pool_size
option has been removed. It is replaced by the
maxPoolSize
MongoDB URI option. maxPoolSize
is now a supported URI
option in PyMongo and can be passed as a keyword argument.
The copy_database
method is removed, see the
copy_database examples for alternatives.
The disconnect
method is removed. Use
close()
instead.
The get_document_class
method is removed. Use
codec_options
instead.
The get_lasterror_options
, set_lasterror_options
, and
unset_lasterror_options
methods are removed. Write concern options
can be passed to MongoClient
as keyword
arguments or MongoDB URI options.
The get_database()
method is added for
getting a Database instance with its options configured differently than the
MongoClient’s.
The following read-only attributes have been added:
The following attributes are now read-only:
The following attributes have been removed:
document_class
(usecodec_options
instead)host
(useaddress
instead)min_wire_version
max_wire_version
port
(useaddress
instead)safe
(usewrite_concern
instead)slave_okay
(useread_preference
instead)tag_sets
(useread_preference
instead)tz_aware
(usecodec_options
instead)
The following attributes have been renamed:
secondary_acceptable_latency_ms
is nowlocal_threshold_ms
and is now read-only.
Cursor management changes¶
CursorManager
and
set_cursor_manager()
are no longer
deprecated. If you subclass CursorManager
your implementation of close()
must now take a second parameter, address. The BatchCursorManager
class
is removed.
The second parameter to close_cursor()
is renamed from _conn_id
to address
.
kill_cursors()
now accepts an address
parameter.
Database
changes¶
The connection
property is renamed to
client
.
The following read-only attributes have been added:
The following attributes are now read-only:
Use get_database()
for getting a
Database instance with its options configured differently than the
MongoClient’s.
The following attributes have been removed:
safe
secondary_acceptable_latency_ms
slave_okay
tag_sets
The following methods have been added:
The following methods have been changed:
command()
. Support for as_class, uuid_subtype, tag_sets, and secondary_acceptable_latency_ms have been removed. You can instead pass an instance ofCodecOptions
as codec_options and an instance of a read preference class fromread_preferences
as read_preference. The fields and compile_re options are also removed. The fields options was undocumented and never really worked. Regular expressions are always decoded toRegex
.
The following methods have been deprecated:
The following methods have been removed:
The get_lasterror_options
, set_lasterror_options
, and
unset_lasterror_options
methods have been removed. Use
WriteConcern
with
get_database()
instead.
Collection
changes¶
The following read-only attributes have been added:
The following attributes are now read-only:
Use get_collection()
or
with_options()
for getting a Collection
instance with its options configured differently than the Database’s.
The following attributes have been removed:
safe
secondary_acceptable_latency_ms
slave_okay
tag_sets
The following methods have been added:
bulk_write()
insert_one()
insert_many()
update_one()
update_many()
replace_one()
delete_one()
delete_many()
find_one_and_delete()
find_one_and_replace()
find_one_and_update()
with_options()
create_indexes()
list_indexes()
The following methods have changed:
aggregate()
now always returns an instance ofCommandCursor
. See the documentation for all options.count()
now optionally takes a filter argument, as well as other options supported by the count command.distinct()
now optionally takes a filter argument.create_index()
no longer caches indexes, therefore the cache_for parameter has been removed. It also no longer supports the bucket_size and drop_dups aliases for bucketSize and dropDups.
The following methods are deprecated:
The following methods have been removed:
The get_lasterror_options
, set_lasterror_options
, and
unset_lasterror_options
methods have been removed. Use
WriteConcern
with
with_options()
instead.
Changes to find()
and find_one()
¶
The following find/find_one options have been renamed:
These renames only affect your code if you passed these as keyword arguments, like find(fields=[‘fieldname’]). If you passed only positional parameters these changes are not significant for your application.
- spec -> filter
- fields -> projection
- partial -> allow_partial_results
The following find/find_one options have been added:
- cursor_type (see
CursorType
for values) - oplog_replay
- modifiers
The following find/find_one options have been removed:
- network_timeout (use
max_time_ms()
instead) - slave_okay (use one of the read preference classes from
read_preferences
andwith_options()
instead) - read_preference (use
with_options()
instead) - tag_sets (use one of the read preference classes from
read_preferences
andwith_options()
instead) - secondary_acceptable_latency_ms (use the localThresholdMS URI option instead)
- max_scan (use the new modifiers option instead)
- snapshot (use the new modifiers option instead)
- tailable (use the new cursor_type option instead)
- await_data (use the new cursor_type option instead)
- exhaust (use the new cursor_type option instead)
- as_class (use
with_options()
withCodecOptions
instead) - compile_re (BSON regular expressions are always decoded to
Regex
)
The following find/find_one options are deprecated:
- manipulate
The following renames need special handling.
- timeout -> no_cursor_timeout - The default for timeout was True. The default for no_cursor_timeout is False. If you were previously passing False for timeout you must pass True for no_cursor_timeout to keep the previous behavior.
gridfs
changes¶
Since PyMongo 1.6, methods open
and close
of GridFS
raised an UnsupportedAPI
exception, as did the entire GridFile
class.
The unsupported methods, the class, and the exception are all deleted.
bson
changes¶
The compile_re option is removed from all methods
that accepted it in bson
and json_util
. Additionally, it
is removed from find()
,
find_one()
,
aggregate()
,
command()
, and so on.
PyMongo now always represents BSON regular expressions as
Regex
objects. This prevents errors for incompatible
patterns, see PYTHON-500. Use try_compile()
to
attempt to convert from a BSON regular expression to a Python regular
expression object.
PyMongo now decodes the int64 BSON type to Int64
, a
trivial wrapper around long (in python 2.x) or int (in python 3.x). This
allows BSON int64 to be round tripped without losing type information in
python 3. Note that if you store a python long (or a python int larger than
4 bytes) it will be returned from PyMongo as Int64
.
The as_class, tz_aware, and uuid_subtype options are removed from all
BSON encoding and decoding methods. Use
CodecOptions
to configure these options. The
APIs affected are:
This is a breaking change for any application that uses the BSON API directly and changes any of the named parameter defaults. No changes are required for applications that use the default values for these options. The behavior remains the same.
Issues Resolved¶
See the PyMongo 3.0 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.9.5¶
Version 2.9.5 works around ssl module deprecations in Python 3.6, and expected future ssl module deprecations. It also fixes bugs found since the release of 2.9.4.
- Use ssl.SSLContext and ssl.PROTOCOL_TLS_CLIENT when available.
- Fixed a C extensions build issue when the interpreter was built with -std=c99
- Fixed various build issues with MinGW32.
- Fixed a write concern bug in
add_user()
andremove_user()
when connected to MongoDB 3.2+ - Fixed various test failures related to changes in gevent, MongoDB, and our CI test environment.
Issues Resolved¶
See the PyMongo 2.9.5 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.9.4¶
Version 2.9.4 fixes issues reported since the release of 2.9.3.
- Fixed __repr__ for closed instances of
MongoClient
. - Fixed
MongoReplicaSetClient
handling of uuidRepresentation. - Fixed building and testing the documentation with python 3.x.
- New documentation for TLS/SSL and PyMongo and Using PyMongo with MongoDB Atlas.
Issues Resolved¶
See the PyMongo 2.9.4 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.9.3¶
Version 2.9.3 fixes a few issues reported since the release of 2.9.2 including
thread safety issues in ensure_index()
,
drop_index()
, and
drop_indexes()
.
Issues Resolved¶
See the PyMongo 2.9.3 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.9.2¶
Version 2.9.2 restores Python 3.1 support, which was broken in PyMongo 2.8. It
improves an error message when decoding BSON as well as fixes a couple other
issues including aggregate()
ignoring
codec_options
and
command()
raising a superfluous
DeprecationWarning.
Issues Resolved¶
See the PyMongo 2.9.2 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.9.1¶
Version 2.9.1 fixes two interrupt handling issues in the C extensions and adapts a test case for a behavior change in MongoDB 3.2.
Issues Resolved¶
See the PyMongo 2.9.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.9¶
Version 2.9 provides an upgrade path to PyMongo 3.x. Most of the API changes from PyMongo 3.0 have been backported in a backward compatible way, allowing applications to be written against PyMongo >= 2.9, rather then PyMongo 2.x or PyMongo 3.x. See the PyMongo 3 Migration Guide for detailed examples.
Note
There are a number of new deprecations in this release for features that were removed in PyMongo 3.0.
MongoClient
:host
port
use_greenlets
document_class
tz_aware
secondary_acceptable_latency_ms
tag_sets
uuid_subtype
disconnect()
alive()
MongoReplicaSetClient
:use_greenlets
document_class
tz_aware
secondary_acceptable_latency_ms
tag_sets
uuid_subtype
alive()
Database
:secondary_acceptable_latency_ms
tag_sets
uuid_subtype
Collection
:secondary_acceptable_latency_ms
tag_sets
uuid_subtype
Warning
In previous versions of PyMongo, changing the value of
document_class
changed
the behavior of all existing instances of
Collection
:
>>> coll = client.test.test
>>> coll.find_one()
{u'_id': ObjectId('5579dc7cfba5220cc14d9a18')}
>>> from bson.son import SON
>>> client.document_class = SON
>>> coll.find_one()
SON([(u'_id', ObjectId('5579dc7cfba5220cc14d9a18'))])
The document_class setting is now configurable at the client,
database, collection, and per-operation level. This required breaking
the existing behavior. To change the document class per operation in a
forward compatible way use
with_options()
:
>>> coll.find_one()
{u'_id': ObjectId('5579dc7cfba5220cc14d9a18')}
>>> from bson.codec_options import CodecOptions
>>> coll.with_options(CodecOptions(SON)).find_one()
SON([(u'_id', ObjectId('5579dc7cfba5220cc14d9a18'))])
Issues Resolved¶
See the PyMongo 2.9 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.8.1¶
Version 2.8.1 fixes a number of issues reported since the release of PyMongo 2.8. It is a recommended upgrade for all users of PyMongo 2.x.
Issues Resolved¶
See the PyMongo 2.8.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.8¶
Version 2.8 is a major release that provides full support for MongoDB 3.0 and fixes a number of bugs.
Special thanks to Don Mitchell, Ximing, Can Zhang, Sergey Azovskov, and Heewa Barfchin for their contributions to this release.
Highlights include:
- Support for the SCRAM-SHA-1 authentication mechanism (new in MongoDB 3.0).
- JSON decoder support for the new $numberLong and $undefined types.
- JSON decoder support for the $date type as an ISO-8601 string.
- Support passing an index name to
hint()
. - The
count()
method will use a hint if one has been provided throughhint()
. - A new socketKeepAlive option for the connection pool.
- New generator based BSON decode functions,
decode_iter()
anddecode_file_iter()
. - Internal changes to support alternative storage engines like wiredtiger.
Note
There are a number of deprecations in this release for features that will be removed in PyMongo 3.0. These include:
start_request()
in_request()
end_request()
copy_database()
error()
last_status()
previous_error()
reset_error_history()
MasterSlaveConnection
The JSON format for Timestamp
has changed from
‘{“t”: <int>, “i”: <int>}’ to ‘{“$timestamp”: {“t”: <int>, “i”: <int>}}’.
This new format will be decoded to an instance of
Timestamp
. The old format will continue to be
decoded to a python dict as before. Encoding to the old format is no
longer supported as it was never correct and loses type information.
Issues Resolved¶
See the PyMongo 2.8 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.7.2¶
Version 2.7.2 includes fixes for upsert reporting in the bulk API for MongoDB
versions previous to 2.6, a regression in how son manipulators are applied in
insert()
, a few obscure connection pool
semaphore leaks, and a few other minor issues. See the list of issues resolved
for full details.
Issues Resolved¶
See the PyMongo 2.7.2 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.7.1¶
Version 2.7.1 fixes a number of issues reported since the release of 2.7, most importantly a fix for creating indexes and manipulating users through mongos versions older than 2.4.0.
Issues Resolved¶
See the PyMongo 2.7.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.7¶
PyMongo 2.7 is a major release with a large number of new features and bug fixes. Highlights include:
- Full support for MongoDB 2.6.
- A new bulk write operations API.
- Support for server side query timeouts using
max_time_ms()
. - Support for writing
aggregate()
output to a collection. - A new
parallel_scan()
helper. OperationFailure
and its subclasses now include adetails
attribute with complete error details from the server.- A new GridFS
find()
method that returns aGridOutCursor
. - Greatly improved support for mod_wsgi when using PyMongo’s C extensions. Read Jesse’s blog post for details.
- Improved C extension support for ARM little endian.
Breaking changes¶
Version 2.7 drops support for replica sets running MongoDB versions older than 1.6.2.
Issues Resolved¶
See the PyMongo 2.7 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.6.3¶
Version 2.6.3 fixes issues reported since the release of 2.6.2, most importantly a semaphore leak when a connection to the server fails.
Issues Resolved¶
See the PyMongo 2.6.3 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.6.2¶
Version 2.6.2 fixes a TypeError
problem when max_pool_size=None
is used in Python 3.
Issues Resolved¶
See the PyMongo 2.6.2 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.6.1¶
Version 2.6.1 fixes a reference leak in
the insert()
method.
Issues Resolved¶
See the PyMongo 2.6.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.6¶
Version 2.6 includes some frequently requested improvements and adds support for some early MongoDB 2.6 features.
Special thanks go to Justin Patrin for his work on the connection pool in this release.
Important new features:
- The
max_pool_size
option forMongoClient
andMongoReplicaSetClient
now actually caps the number of sockets the pool will open concurrently. Once the pool has reachedmax_pool_size
operations will block waiting for a socket to become available. IfwaitQueueTimeoutMS
is set, an operation that blocks waiting for a socket will raiseConnectionFailure
after the timeout. By defaultwaitQueueTimeoutMS
is not set. See How does connection pooling work in PyMongo? for more information. - The
insert()
method automatically splits large batches of documents into multiple insert messages based onmax_message_size
- Support for the exhaust cursor flag.
See
find()
for details and caveats. - Support for the PLAIN and MONGODB-X509 authentication mechanisms. See the authentication docs for more information.
- Support aggregation output as a
Cursor
. Seeaggregate()
for details.
Warning
SIGNIFICANT BEHAVIOR CHANGE in 2.6. Previously, max_pool_size
would limit only the idle sockets the pool would hold onto, not the
number of open sockets. The default has also changed, from 10 to 100.
If you pass a value for max_pool_size
make sure it is large enough for
the expected load. (Sockets are only opened when needed, so there is no cost
to having a max_pool_size
larger than necessary. Err towards a larger
value.) If your application accepts the default, continue to do so.
See How does connection pooling work in PyMongo? for more information.
Issues Resolved¶
See the PyMongo 2.6 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.5.2¶
Version 2.5.2 fixes a NULL pointer dereference issue when decoding
an invalid DBRef
.
Issues Resolved¶
See the PyMongo 2.5.2 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.5.1¶
Version 2.5.1 is a minor release that fixes issues discovered after the release of 2.5. Most importantly, this release addresses some race conditions in replica set monitoring.
Issues Resolved¶
See the PyMongo 2.5.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.5¶
Version 2.5 includes changes to support new features in MongoDB 2.4.
Important new features:
- Support for GSSAPI (Kerberos) authentication.
- Support for SSL certificate validation with hostname matching.
- Support for delegated and role based authentication.
- New GEOSPHERE (2dsphere) and HASHED index constants.
Note
authenticate()
now raises a
subclass of PyMongoError
if authentication
fails due to invalid credentials or configuration issues.
Issues Resolved¶
See the PyMongo 2.5 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.4.2¶
Version 2.4.2 is a minor release that fixes issues discovered after the release of 2.4.1. Most importantly, PyMongo will no longer select a replica set member for read operations that is not in primary or secondary state.
Issues Resolved¶
See the PyMongo 2.4.2 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.4.1¶
Version 2.4.1 is a minor release that fixes issues discovered after the
release of 2.4. Most importantly, this release fixes a regression using
aggregate()
, and possibly other commands,
with mongos.
Issues Resolved¶
See the PyMongo 2.4.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.4¶
Version 2.4 includes a few important new features and a large number of bug fixes.
Important new features:
- New
MongoClient
andMongoReplicaSetClient
classes - these connection classes do acknowledged write operations (previously referred to as ‘safe’ writes) by default.Connection
andReplicaSetConnection
are deprecated but still support the old default fire-and-forget behavior. - A new write concern API implemented as a
write_concern
attribute on the connection,Database
, orCollection
classes. MongoClient
(andConnection
) now support Unix Domain Sockets.Cursor
can be copied with functions from thecopy
module.- The
set_profiling_level()
method now supports a slow_ms option. - The replica set monitor task (used by
MongoReplicaSetClient
andReplicaSetConnection
) is a daemon thread once again, meaning you won’t have to callclose()
before exiting the python interactive shell.
Warning
The constructors for MongoClient
,
MongoReplicaSetClient
,
Connection
, and
ReplicaSetConnection
now raise
ConnectionFailure
instead of its subclass
AutoReconnect
if the server is unavailable. Applications
that expect to catch AutoReconnect
should now catch
ConnectionFailure
while creating a new connection.
Issues Resolved¶
See the PyMongo 2.4 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.3¶
Version 2.3 adds support for new features and behavior changes in MongoDB 2.2.
Important New Features:
- Support for expanded read preferences including directing reads to tagged servers - See Secondary Reads for more information.
- Support for mongos failover.
- A new
aggregate()
method to support MongoDB’s new aggregation framework. - Support for legacy Java and C# byte order when encoding and decoding UUIDs.
- Support for connecting directly to an arbiter.
Warning
Starting with MongoDB 2.2 the getLastError command requires authentication when the server’s authentication features are enabled. Changes to PyMongo were required to support this behavior change. Users of authentication must upgrade to PyMongo 2.3 (or newer) for “safe” write operations to function correctly.
Issues Resolved¶
See the PyMongo 2.3 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.2.1¶
Version 2.2.1 is a minor release that fixes issues discovered after the release of 2.2. Most importantly, this release fixes an incompatibility with mod_wsgi 2.x that could cause connections to leak. Users of mod_wsgi 2.x are strongly encouraged to upgrade from PyMongo 2.2.
Issues Resolved¶
See the PyMongo 2.2.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.2¶
Version 2.2 adds a few more frequently requested features and fixes a number of bugs.
Special thanks go to Alex Grönholm for his contributions to Python 3 support and maintaining the original pymongo3 port. Christoph Simon, Wouter Bolsterlee, Mike O’Brien, and Chris Tompkinson also contributed to this release.
Important New Features:
- Support for Python 3 - See the Python 3 FAQ for more information.
- Support for Gevent - See Gevent for more information.
- Improved connection pooling. See PYTHON-287.
Warning
A number of methods and method parameters that were deprecated in PyMongo 1.9 or older versions have been removed in this release. The full list of changes can be found in the following JIRA ticket:
https://jira.mongodb.org/browse/PYTHON-305
BSON module aliases from the pymongo package that were deprecated in PyMongo 1.9 have also been removed in this release. See the following JIRA ticket for details:
https://jira.mongodb.org/browse/PYTHON-304
As a result of this cleanup some minor code changes may be required to use this release.
Issues Resolved¶
See the PyMongo 2.2 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.1.1¶
Version 2.1.1 is a minor release that fixes a few issues
discovered after the release of 2.1. You can now use
ReplicaSetConnection
to run inline map reduce commands on secondaries. See
inline_map_reduce()
for details.
Special thanks go to Samuel Clay and Ross Lawley for their contributions to this release.
Issues Resolved¶
See the PyMongo 2.1.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.1¶
Version 2.1 adds a few frequently requested features and includes the usual round of bug fixes and improvements.
Special thanks go to Alexey Borzenkov, Dan Crosta, Kostya Rybnikov, Flavio Percoco Premoli, Jonas Haag, and Jesse Davis for their contributions to this release.
Important New Features:
- ReplicaSetConnection -
ReplicaSetConnection
can be used to distribute reads to secondaries in a replica set. It supports automatic failover handling and periodically checks the state of the replica set to handle issues like primary stepdown or secondaries being removed for backup operations. Read preferences are defined throughReadPreference
. - PyMongo supports the new BSON binary subtype 4 for UUIDs. The default
subtype to use can be set through
uuid_subtype
The current default remainsOLD_UUID_SUBTYPE
but will be changed toUUID_SUBTYPE
in a future release. - The getLastError option ‘w’ can be set to a string, allowing for options like “majority” available in newer version of MongoDB.
- Added support for the MongoDB URI options socketTimeoutMS and connectTimeoutMS.
- Added support for the ContinueOnError insert flag.
- Added basic SSL support.
- Added basic support for Jython.
- Secondaries can be used for
count()
,distinct()
,group()
, and queryingGridFS
. - Added document_class and tz_aware options to
MasterSlaveConnection
Issues Resolved¶
See the PyMongo 2.1 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 2.0.1¶
Version 2.0.1 fixes a regression in GridIn
when
writing pre-chunked strings. Thanks go to Alexey Borzenkov for reporting the
issue and submitting a patch.
Issues Resolved¶
- PYTHON-271: Regression in GridFS leads to serious loss of data.
Changes in Version 2.0¶
Version 2.0 adds a large number of features and fixes a number of issues.
Special thanks go to James Murty, Abhay Vardhan, David Pisoni, Ryan Smith-Roberts, Andrew Pendleton, Mher Movsisyan, Reed O’Brien, Michael Schurter, Josip Delic and Jonas Haag for their contributions to this release.
Important New Features:
- PyMongo now performs automatic per-socket database authentication. You no
longer have to re-authenticate for each new thread or after a replica set
failover. Authentication credentials are cached by the driver until the
application calls
logout()
. - slave_okay can be set independently at the connection, database, collection or query level. Each level will inherit the slave_okay setting from the previous level and each level can override the previous level’s setting.
- safe and getLastError options (e.g. w, wtimeout, etc.) can be set independently at the connection, database, collection or query level. Each level will inherit settings from the previous level and each level can override the previous level’s setting.
- PyMongo now supports the await_data and partial cursor flags. If the await_data flag is set on a tailable cursor the server will block for some extra time waiting for more data to return. The partial flag tells a mongos to return partial data for a query if not all shards are available.
map_reduce()
will accept a dict or instance ofSON
as the out parameter.- The URI parser has been moved into its own module and can be used directly by application code.
- AutoReconnect exception now provides information about the error that actually occured instead of a generic failure message.
- A number of new helper methods have been added with options for setting and unsetting cursor flags, re-indexing a collection, fsync and locking a server, and getting the server’s current operations.
API changes:
- If only one host:port pair is specified
Connection
will make a direct connection to only that host. Please note that slave_okay must be True in order to query from a secondary. - If more than one host:port pair is specified or the replicaset option is used PyMongo will treat the specified host:port pair(s) as a seed list and connect using replica set behavior.
Warning
The default subtype for Binary
has changed
from OLD_BINARY_SUBTYPE
(2) to
BINARY_SUBTYPE
(0).
Issues Resolved¶
See the PyMongo 2.0 release notes in JIRA for the list of resolved issues in this release.
Changes in Version 1.11¶
Version 1.11 adds a few new features and fixes a few more bugs.
New Features:
- Basic IPv6 support: pymongo prefers IPv4 but will try IPv6. You can also specify an IPv6 address literal in the host parameter or a MongoDB URI provided it is enclosed in ‘[‘ and ‘]’.
- max_pool_size option: previously pymongo had a hard coded pool size
of 10 connections. With this change you can specify a different pool
size as a parameter to
Connection
(max_pool_size=<integer>) or in the MongoDB URI (maxPoolSize=<integer>). - Find by metadata in GridFS: You can know specify query fields as
keyword parameters for
get_version()
andget_last_version()
. - Per-query slave_okay option: slave_okay=True is now a valid keyword
argument for
find()
andfind_one()
.
API changes:
validate_collection()
now returns a dict instead of a string. This change was required to deal with an API change on the server. This method also now takes the optional scandata and full parameters. See the documentation for more details.
Warning
The pool_size, auto_start_request, and timeout parameters
for Connection
have been completely
removed in this release. They were deprecated in pymongo-1.4 and
have had no effect since then. Please make sure that your code
doesn’t currently pass these parameters when creating a
Connection instance.
Issues resolved¶
- PYTHON-241: Support setting slaveok at the cursor level.
- PYTHON-240: Queries can sometimes permanently fail after a replica set fail over.
- PYTHON-238: error after few million requests
- PYTHON-237: Basic IPv6 support.
- PYTHON-236: Restore option to specify pool size in Connection.
- PYTHON-212: pymongo does not recover after stale config
- PYTHON-138: Find method for GridFS
Changes in Version 1.10.1¶
Version 1.10.1 is primarily a bugfix release. It fixes a regression in version 1.10 that broke pickling of ObjectIds. A number of other bugs have been fixed as well.
There are two behavior changes to be aware of:
- If a read slave raises
AutoReconnect
MasterSlaveConnection
will now retry the query on each slave until it is successful or all slaves have raisedAutoReconnect
. Any other exception will immediately be raised. The order that the slaves are tried is random. Previously the read would be sent to one randomly chosen slave andAutoReconnect
was immediately raised in case of a connection failure. - A Python long is now always BSON encoded as an int64. Previously the encoding was based only on the value of the field and a long with a value less than 2147483648 or greater than -2147483649 would always be BSON encoded as an int32.
Issues resolved¶
- PYTHON-234: Fix setup.py to raise exception if any when building extensions
- PYTHON-233: Add information to build and test with extensions on windows
- PYTHON-232: Traceback when hashing a DBRef instance
- PYTHON-231: Traceback when pickling a DBRef instance
- PYTHON-230: Pickled ObjectIds are not compatible between pymongo 1.9 and 1.10
- PYTHON-228: Cannot pickle bson.ObjectId
- PYTHON-227: Traceback when calling find() on system.js
- PYTHON-216: MasterSlaveConnection is missing disconnect() method
- PYTHON-186: When storing integers, type is selected according to value instead of type
- PYTHON-173: as_class option is not propogated by Cursor.clone
- PYTHON-113: Redunducy in MasterSlaveConnection
Changes in Version 1.10¶
Version 1.10 includes changes to support new features in MongoDB 1.8.x. Highlights include a modified map/reduce API including an inline map/reduce helper method, a new find_and_modify helper, and the ability to query the server for the maximum BSON document size it supports.
- added
find_and_modify()
. - added
inline_map_reduce()
. - changed
map_reduce()
.
Warning
MongoDB versions greater than 1.7.4 no longer generate temporary
collections for map/reduce results. An output collection name must be
provided and the output will replace any existing output collection with
the same name. map_reduce()
now
requires the out parameter.
Issues resolved¶
- PYTHON-225:
ObjectId
class definition should use __slots__. - PYTHON-223: Documentation fix.
- PYTHON-220: Documentation fix.
- PYTHON-219: KeyError in
find_and_modify()
- PYTHON-213: Query server for maximum BSON document size.
- PYTHON-208: Fix
Connection
__repr__. - PYTHON-207: Changes to Map/Reduce API.
- PYTHON-205: Accept slaveOk in the URI to match the URI docs.
- PYTHON-203: When slave_okay=True and we only specify one host don’t autodetect other set members.
- PYTHON-194: Show size when whining about a document being too large.
- PYTHON-184: Raise
DuplicateKeyError
for duplicate keys in capped collections. - PYTHON-178: Don’t segfault when trying to encode a recursive data structure.
- PYTHON-177: Don’t segfault when decoding dicts with broken iterators.
- PYTHON-172: Fix a typo.
- PYTHON-170: Add
find_and_modify()
. - PYTHON-169: Support deepcopy of DBRef.
- PYTHON-167: Duplicate of PYTHON-166.
- PYTHON-166: Fixes a concurrency issue.
- PYTHON-158: Add code and err string to db assertion messages.
Changes in Version 1.9¶
Version 1.9 adds a new package to the PyMongo distribution,
bson
. bson
contains all of the BSON encoding and decoding logic, and the BSON
types that were formerly in the pymongo
package. The following
modules have been renamed:
pymongo.bson
->bson
pymongo._cbson
->bson._cbson
andpymongo._cmessage
pymongo.binary
->bson.binary
pymongo.code
->bson.code
pymongo.dbref
->bson.dbref
pymongo.json_util
->bson.json_util
pymongo.max_key
->bson.max_key
pymongo.min_key
->bson.min_key
pymongo.objectid
->bson.objectid
pymongo.son
->bson.son
pymongo.timestamp
->bson.timestamp
pymongo.tz_util
->bson.tz_util
In addition, the following exception classes have been renamed:
pymongo.errors.InvalidBSON
->bson.errors.InvalidBSON
pymongo.errors.InvalidStringData
->bson.errors.InvalidStringData
pymongo.errors.InvalidDocument
->bson.errors.InvalidDocument
pymongo.errors.InvalidId
->bson.errors.InvalidId
The above exceptions now inherit from bson.errors.BSONError
rather than pymongo.errors.PyMongoError
.
Note
All of the renamed modules and exceptions above have aliases created with the old names, so these changes should not break existing code. The old names will eventually be deprecated and then removed, so users should begin migrating towards the new names now.
Warning
The change to the exception hierarchy mentioned above is
possibly breaking. If your code is catching
PyMongoError
, then the exceptions raised
by bson
will not be caught, even though they would have been
caught previously. Before upgrading, it is recommended that users
check for any cases like this.
- the C extension now shares buffer.c/h with the Ruby driver
bson
no longer raisesInvalidName
, all occurrences have been replaced withInvalidDocument
.- renamed
bson._to_dicts()
todecode_all()
. - renamed
from_dict()
toencode()
andto_dict()
todecode()
. - added
batch_size()
. - allow updating (some) file metadata after a
GridIn
instance has been closed. - performance improvements for reading from GridFS.
- special cased slice with the same start and stop to return an empty cursor.
- allow writing
unicode
to GridFS if anencoding
attribute has been specified for the file. - added
gridfs.GridFS.get_version()
. - scope variables for
Code
can now be specified as keyword arguments. - added
readline()
toGridOut
. - make a best effort to transparently auto-reconnect if a
Connection
has been idle for a while. - added
list()
toSystemJS
. - added file_document argument to
GridOut()
to allow initializing from an existing file document. - raise
TimeoutError
even if thegetLastError
command was run manually and not through “safe” mode. - added
uuid
support tojson_util
.
Changes in Version 1.8.1¶
- fixed a typo in the C extension that could cause safe-mode
operations to report a failure (
SystemError
) even when none occurred. - added a
__ne__()
implementation to any class where we define__eq__()
.
Changes in Version 1.8¶
Version 1.8 adds support for connecting to replica sets, specifying per-operation values for w and wtimeout, and decoding to timezone-aware datetimes.
- fixed a reference leak in the C extension when decoding a
DBRef
. - added support for w, wtimeout, and fsync (and any other options for getLastError) to “safe mode” operations.
- added
nodes
property. - added a maximum pool size of 10 sockets.
- added support for replica sets.
- DEPRECATED
from_uri()
andpaired()
, both are supplanted by extended functionality inConnection()
. - added tz aware support for datetimes in
ObjectId
,Timestamp
andjson_util
methods. - added
drop()
helper. - reuse the socket used for finding the master when a
Connection
is first created. - added support for
MinKey
,MaxKey
andTimestamp
tojson_util
. - added support for decoding datetimes as aware (UTC) - it is highly
recommended to enable this by setting the tz_aware parameter to
Connection()
toTrue
. - added network_timeout option for individual calls to
find()
andfind_one()
. - added
exists()
to check if a file exists in GridFS. - added support for additional keys in
DBRef
instances. - added
code
attribute toOperationFailure
exceptions. - fixed serialization of int and float subclasses in the C extension.
Changes in Version 1.7¶
Version 1.7 is a recommended upgrade for all PyMongo users. The full release notes are below, and some more in depth discussion of the highlights is here.
- no longer attempt to build the C extension on big-endian systems.
- added
MinKey
andMaxKey
. - use unsigned for
Timestamp
in BSON encoder/decoder. - support
True
as"ok"
in command responses, in addition to1.0
- necessary for server versions >= 1.5.X - BREAKING change to
index_information()
to add support for querying unique status and other index information. - added
document_class
, to specify class for returned documents. - added as_class argument for
find()
, and in the BSON decoder. - added support for creating
Timestamp
instances using adatetime
. - allow dropTarget argument for
rename
. - handle aware
datetime
instances, by converting to UTC. - added support for
max_scan
. - raise
FileExists
exception when creating a duplicate GridFS file. - use y2038 for time handling in the C extension - eliminates 2038 problems when extension is installed.
- added sort parameter to
find()
- finalized deprecation of changes from versions <= 1.4
- take any non-
dict
as an"_id"
query forfind_one()
orremove()
- added ability to pass a
dict
for fields argument tofind()
(supports"$slice"
and field negation) - simplified code to find master, since paired setups don’t always have a remote
- fixed bug in C encoder for certain invalid types (like
Collection
instances). - don’t transparently map
"filename"
key toname
attribute for GridFS.
Changes in Version 1.6¶
The biggest change in version 1.6 is a complete re-implementation of
gridfs
with a lot of improvements over the old
implementation. There are many details and examples of using the new
API in this blog post. The
old API has been removed in this version, so existing code will need
to be modified before upgrading to 1.6.
- fixed issue where connection pool was being shared across
Connection
instances. - more improvements to Python code caching in C extension - should improve behavior on mod_wsgi.
- added
from_datetime()
. - complete rewrite of
gridfs
support. - improvements to the
command()
API. - fixed
drop_indexes()
behavior on non-existent collections. - disallow empty bulk inserts.
Changes in Version 1.5.2¶
- fixed response handling to ignore unknown response flags in queries.
- handle server versions containing ‘-pre-‘.
Changes in Version 1.5.1¶
- added
_id
property forGridFile
instances. - fix for making a
Connection
(with slave_okay set) directly to a slave in a replica pair. - accept kwargs for
create_index()
andensure_index()
to support all indexing options. - add
pymongo.GEO2D
and support for geo indexing. - improvements to Python code caching in C extension - should improve behavior on mod_wsgi.
Changes in Version 1.5¶
- added subtype constants to
binary
module. - DEPRECATED options argument to
Collection()
andcreate_collection()
in favor of kwargs. - added
has_c()
to check for C extension. - added
copy_database()
. - added
alive
to tell when a cursor might have more data to return (useful for tailable cursors). - added
Timestamp
to better support dealing with internal MongoDB timestamps. - added name argument for
create_index()
andensure_index()
. - fixed connection pooling w/ fork
paired()
takes all kwargs that are allowed forConnection()
.insert()
returns list for bulk inserts of size one.- fixed handling of
datetime.datetime
instances injson_util
. - added
from_uri()
to support MongoDB connection uri scheme. - fixed chunk number calculation when unaligned in
gridfs
. command()
takes a string for simple commands.- added
system_js
helper for dealing with server-side JS. - don’t wrap queries containing
"$query"
(support manual use of"$min"
, etc.). - added
GridFSError
as base class forgridfs
exceptions.
Changes in Version 1.4¶
Perhaps the most important change in version 1.4 is that we have decided to no longer support Python 2.3. The most immediate reason for this is to allow some improvements to connection pooling. This will also allow us to use some new (as in Python 2.4 ;) idioms and will help begin the path towards supporting Python 3.0. If you need to use Python 2.3 you should consider using version 1.3 of this driver, although that will no longer be actively supported.
Other changes:
- move
"_id"
to front only for top-level documents (fixes some corner cases). update()
andremove()
return the entire response to the lastError command when safe isTrue
.- completed removal of things that were deprecated in version 1.2 or earlier.
- enforce that collection names do not contain the NULL byte.
- fix to allow using UTF-8 collection names with the C extension.
- added
PyMongoError
as base exception class for allerrors
. this changes the exception hierarchy somewhat, and is a BREAKING change if you depend onConnectionFailure
being aIOError
orInvalidBSON
being aValueError
, for example. - added
DuplicateKeyError
for calls toinsert()
orupdate()
with safe set toTrue
. - removed
thread_util
. - added
add_user()
andremove_user()
helpers. - fix for
authenticate()
when using non-UTF-8 names or passwords. - minor fixes for
MasterSlaveConnection
. - clean up all cases where
ConnectionFailure
is raised. - simplification of connection pooling - makes driver ~2x faster for simple benchmarks. see How does connection pooling work in PyMongo? for more information.
- DEPRECATED pool_size, auto_start_request and timeout
parameters to
Connection
. DEPRECATEDstart_request()
. - use
socket.sendall()
. - removed
from_xml()
as it was only being used for some internal testing - also eliminates dependency onelementtree
. - implementation of
update()
in C. - deprecate
_command()
in favor ofcommand()
. - send all commands without wrapping as
{"query": ...}
. - support string as key argument to
group()
(keyf) and run all groups as commands. - support for equality testing for
Code
instances. - allow the NULL byte in strings and disallow it in key names or regex patterns
Changes in Version 1.3¶
- DEPRECATED running
group()
aseval()
, also changed default forgroup()
to running as a command - remove
pymongo.cursor.Cursor.__len__()
, which was deprecated in 1.1.1 - needed to do this aggressively due to it’s presence breaking Django template for loops - DEPRECATED
host()
,port()
,connection()
,name()
,database()
,name()
andfull_name()
in favor ofhost
,port
,connection
,name
,database
,name
andfull_name
, respectively. The deprecation schedule for this change will probably be faster than usual, as it carries some performance implications. - added
disconnect()
Changes in Version 1.2.1¶
- added Changelog to docs
- added
setup.py doc --test
to run doctests for tutorial, examples - moved most examples to Sphinx docs (and remove from examples/ directory)
- raise
InvalidId
instead ofTypeError
when passing a 24 character string toObjectId
that contains non-hexadecimal characters - allow
unicode
instances forObjectId
init
Changes in Version 1.2¶
- spec parameter for
remove()
is now optional to allow for deleting all documents in aCollection
- always wrap queries with
{query: ...}
even when no special options - get around some issues with queries on fields namedquery
- enforce 4MB document limit on the client side
- added
map_reduce()
helper - see example - added
distinct()
method onCursor
instances to allow distinct with queries - fix for
__getitem__()
afterskip()
- allow any UTF-8 string in
BSON
encoder, not just ASCII subset - added
generation_time
- removed support for legacy
ObjectId
format - pretty sure this was never used, and is just confusing - DEPRECATED
url_encode()
andurl_decode()
in favor ofstr()
andObjectId()
, respectively - allow oplog.$main as a valid collection name
- some minor fixes for installation process
- added support for datetime and regex in
json_util
Changes in Version 1.1.2¶
- improvements to
insert()
speed (using C for insert message creation) - use random number for request_id
- fix some race conditions with
AutoReconnect
Changes in Version 1.1.1¶
- added multi parameter for
update()
- fix unicode regex patterns with C extension
- added
distinct()
- added database support for
DBRef
- added
json_util
with helpers for encoding / decoding special types to JSON - DEPRECATED
pymongo.cursor.Cursor.__len__()
in favor ofcount()
with with_limit_and_skip set toTrue
due to performance regression - switch documentation to Sphinx
Changes in Version 1.1¶
- added
__hash__()
forDBRef
andObjectId
- bulk
insert()
works with any iterable - fix
ObjectId
generation when usingmultiprocessing
- added
collection
- added network_timeout parameter for
Connection()
- DEPRECATED slave_okay parameter for individual queries
- fix for safe mode when multi-threaded
- added safe parameter for
remove()
- added tailable parameter for
find()
Changes in Version 1.0¶
- fixes for
MasterSlaveConnection
- added finalize parameter for
group()
- improvements to
insert()
speed - improvements to
gridfs
speed - added
__getitem__()
and__len__()
forCursor
instances
Changes in Version 0.16¶
- support for encoding/decoding
uuid.UUID
instances - fix for
explain()
with limits
Changes in Version 0.15.2¶
- documentation changes only
Changes in Version 0.15.1¶
- various performance improvements
- API CHANGE no longer need to specify direction for
create_index()
andensure_index()
when indexing a single key - support for encoding
tuple
instances aslist
instances
Changes in Version 0.15¶
Changes in Version 0.14.2¶
- minor bugfixes
Changes in Version 0.14.1¶
seek()
andtell()
for (read mode)GridFile
instances
Changes in Version 0.14¶
Changes in Version 0.13¶
Changes in Version 0.12¶
- improved
ObjectId
generation - added
AutoReconnect
exception for when reconnection is possible - make
gridfs
thread-safe - fix for
gridfs
with nonObjectId
_id
Changes in Version 0.11.3¶
- don’t allow NULL bytes in string encoder
- fixes for Python 2.3
Changes in Version 0.11.1¶
- fix for connection pooling under Python 2.5
Changes in Version 0.11¶
- better build failure detection
- driver support for selecting fields in sub-documents
- disallow insertion of invalid key names
- added timeout parameter for
Connection()
Changes in Version 0.10.3¶
- fix bug with large
limit()
- better exception when modules get reloaded out from underneath the C extension
- better exception messages when calling a
Collection
orDatabase
instance
Changes in Version 0.10.2¶
- support subclasses of
dict
in C encoder
Changes in Version 0.10.1¶
- alias
Connection
aspymongo.Connection
- raise an exception rather than silently overflowing in encoder
Changes in Version 0.10¶
- added
ensure_index()
Changes in Version 0.9.7¶
- allow sub-collections of $cmd as valid
Collection
names - add version as
pymongo.version
- add
--no_ext
command line option to setup.py