# MongoDB C Driver History

## 0.8.1
2013-9-26

This point relese includes the following.

** API CHANGE **

1. mongo_create_index now has a ttl parameter

    int mongo_create_index( mongo *conn, const char *ns, const bson *key, const char *name, int options, int ttl, bson *out );

- bson_has_data that was missing from release 0.8
- mongo_create_index returns a bson object in case of errors
- mongo_cursor_next returns MONGO_CURSOR_EXHAUSTED if there is no result rather than MONGO_CURSOR_INVALID
- _get_host_port allocates memory for thread safety
- dylib name fix for Mac OSX
- various compiler warning fixes

## 0.8
2013-8-12

This release features uniform init/destroy pairing, improved support for 64-bit architectures and Windows, and enhanced GridFS.

** API CHANGE **

1. Uniformly, an _init_ call to initialize an object and must be matched with a _destroy_ call to destroy the object.
2. BSON data is tracked internally to enable the above uniform _init_/_destroy_ pairing, with additions to the API.
3. Underlying allocation functions are now uniformly named with _alloc_ and _dealloc_ instead of _create_ and _dispose_.
4. Size type _size_t_ is now used appropriately instead of _int_ for both function arguments and return values.

Please see the API docs for full details.

The following functions have been replaced or modified, other than just for _size_t_.

Old Function/Signature | New Function/Signature
- bson* __bson_create__( void ) | bson* __bson_alloc__( void )
- void __bson_dispose__(bson* b) | void __bson_dealloc__( bson* b )
- bson* __bson_empty__( bson *obj ) | const bson* __bson_shared_empty__( void )
- void __bson_init__( bson *b ) | int __bson_init__( bson *b )
- void __bson_iterator_code_scope__( const bson_iterator *i, bson *scope ) | void __bson_iterator_code_scope_init__( const bson_iterator *i, bson *scope, bson_bool_t copyData )
- bson_iterator* __bson_iterator_create__( void ) | bson_iterator* __bson_iterator_alloc__( void )
- void __bson_iterator_dispose__(bson_iterator*) | void __bson_iterator_dealloc__(bson_iterator*)
- void __bson_iterator_subobject__( const bson_iterator *i, bson *sub ) | void __bson_iterator_subobject_init__( const bson_iterator *i, bson *sub, bson_bool_t copyData )
- mongo* __mongo_create__( void ) | mongo* __mongo_alloc__( void )
- mongo_cursor* __mongo_cursor_create__( void ) | mongo_cursor* __mongo_cursor_alloc__( void )
- void __mongo_cursor_dispose__(mongo_cursor* cursor) | void __mongo_cursor_dealloc__(mongo_cursor* cursor)
- void __mongo_dispose__(mongo* conn) | void __mongo_dealloc__(mongo* conn)

The following functions are new.

- __bson_init_empty__
- __bson_init_zero__
- __bson_append_maxkey__
- __bson_append_minkey__
- __bson_has_data__
- __bson_init_finished_data__
- __bson_init_finished_data_with_copy__
- __mongo_write_concern_*__

Fixes

* Many fixes in pull requests back to January 8, 2013 with special thanks to all of the contributors and reviewers
* Please see https://github.com/mongodb/mongo-c-driver/commits/v0.8

## 0.7.1
2013-1-7

Fixes

* collections with one character name
* set socket option NOSIGPIPE for Mac OS X
* reorganize env packaging to ease build for the R driver
* add bcon to library build for Scons
* package build support with DESTDIR and PREFIX

## 0.7
2012-11-19
** API CHANGE **

In version 0.7, mongo_client and mongo_replica_set_client are the connection functions,
replacing the deprecated functions mongo_connect and mongo_replset_connect, respectively.
The mongo_client and mongo_replica_set_client functions now have a default write concern
specifying the acknowledgement of writes.
Please see the Write Concern document for explicit details.
The term "replica_set" replaces "replset" consistently,
and the functions containing "replset" are deprecated.

BCON (BSON C Object Notation) provides JSON-like (or BSON-like) initializers in C
and readable, and maintainable data-driven definition of BSON documents.

Other features and fixes include:

* support for Unix domain sockets
* three memory leak fixes in library code
* proper cursor termination at the end of a set of large documents
* mongo_get_primary initialization to avoid memory overrun
* Mac dynamic library linking
* example.c compilation
* various other minor fixes since 2012-6-28

## 0.6
2012-6-3
** API CHANGE **

Version 0.6 supports write concern. This involves a backward-breaking
API change, as the write functions now take an optional write_concern
object.

The driver now also supports the MONGO_CONTINUE_ON_ERROR flag for
batch inserts.

The new function prototypes are as follows:

* int mongo_insert( mongo *conn, const char *ns, const bson *data,
      mongo_write_concern *custom_write_concern );

* int mongo_insert_batch( mongo *conn, const char *ns,
    const bson **data, int num, mongo_write_concern *custom_write_concern );

* int mongo_update( mongo *conn, const char *ns, const bson *cond,
    const bson *op, int flags, mongo_write_concern *custom_write_concern,
    int flags );

* int mongo_remove( mongo *conn, const char *ns, const bson *cond,
    mongo_write_concern *custom_write_concern );

* Allow DBRefs (i.e., allows keys $ref, $id, and $db)
* Added mongo_create_capped_collection().
* Fixed some bugs in the SCons and Makefile build scripts.
* Fixes for SCons and Makefile shared library install targets.
* Other minor bug fixes.

## 0.5.2
2012-5-4

* Validate collection and database names on insert.
* Validate insert limits using max BSON size.
* Support getaddrinfo and SO_RCVTIMEO and SO_SNDTIMEO on Windows.
* Store errno/WSAGetLastError() on errors.
* Various bug fixes and refactorings.
* Update error reporting docs.

## 0.5.1

* Env for POSIX, WIN32, and standard C.
* Various bug fixes.

## 0.5
2012-3-31

* Separate cursor-specific errors into their own enum: mongo_cursor_error_t.
* Catch $err return on bad queries and store the result in conn->getlasterrorcode
  and conn->getlasterrstr.
* On queries that return $err, set cursor->err to MONGO_CURSOR_QUERY_FAIL.
* When passing bad BSON to a cursor object, set cursor->err to MONGO_CURSOR_BSON_ERROR,
  and store the specific BSON error on the conn->err field.
* Remove bson_copy_basic().
* bson_copy() will copy finished bson objects only.
* bson_copy() returns BSON_OK on success and BSON_ERROR on failure.
* Added a Makefile for easy compile and install on Linux and OS X.
* Replica set connect fixes.

## 0.4

THIS RELEASE INCLUDES NUMEROUS BACKWARD-BREAKING CHANGES.
These changes have been made for extensibility, consistency,
and ease of use. Please read the following release notes
carefully, and study the updated tutorial.

API Principles:

1. Present a consistent interface for all objects: connections,
   cursors, bson objects, and bson iterators.
2. Require no knowledge of an object's implementation to use the API.
3. Allow users to allocate objects on the stack or on the heap.
4. Integrate API with new error reporting strategy.
5. Be concise, except where it impairs clarity.

Changes:

* mongo_replset_init_conn has been renamed to mongo_replset_init.
* bson_buffer has been removed. All functions for building bson
  objects now take objects of type bson. The new pattern looks like this:

  Example:

    bson b[1];
    bson_init( b );
    bson_append_int( b, "foo", 1 );
    bson_finish( b );
    /* The object is ready to use.
       When finished, destroy it. */
    bson_destroy( b );

* mongo_connection has been renamed to mongo.

  Example:

    mongo conn[1];
    mongo_connect( conn, '127.0.0.1', 27017 );
    /* Connection is ready. Destroy when down. */
    mongo_destroy( conn );

* New cursor builder API for clearer code:

  Example:

    mongo_cursor cursor[1];
    mongo_cursor_init( cursor, conn, "test.foo" );

    bson query[1];

    bson_init( query );
    bson_append_int( query, "bar", 1 );
    bson_finish( query );

    bson fields[1];

    bson_init( fields );
    bson_append_int( fields, "baz", 1 );
    bson_finish( fields );

    mongo_cursor_set_query( cursor, query );
    mongo_cursor_set_fields( cursor, fields );
    mongo_cursor_set_limit( cursor, 10 );
    mongo_cursor_set_skip( cursor, 10 );

    while( mongo_cursor_next( cursor ) == MONGO_OK )
        bson_print( mongo_cursor_bson( cursor ) );

* bson_iterator_init now takes a (bson*) instead of a (const char*). This is consistent
  with bson_find, which also takes a (bson*). If you want to initiate a bson iterator
  with a buffer, use the new function bson_iterator_from_buffer.
* With the addition of the mongo_cursor_bson function, it's now no
  longer necessary to know how bson and mongo_cursor objects are implemented.

  Example:

    bson b[1];
    bson_iterator i[1];

    bson_iterator_init( i, b );

    /* With a cursor */
    bson_iterator_init( i, mongo_cursor_bson( cursor ) );

* Added mongo_cursor_data and bson_data functions, which return the
  raw bson buffer as a (const char *).
* All constants that were once lower case are now
  upper case. These include: MONGO_OP_MSG, MONGO_OP_UPDATE, MONGO_OP_INSERT,
  MONGO_OP_QUERY, MONGO_OP_GET_MORE, MONGO_OP_DELETE, MONGO_OP_KILL_CURSORS
  BSON_EOO, BSON_DOUBLE, BSON_STRING, BSON_OBJECT, BSON_ARRAY, BSON_BINDATA,
  BSON_UNDEFINED, BSON_OID, BSON_BOOL, BSON_DATE, BSON_NULL, BSON_REGEX, BSON_DBREF,
  BSON_CODE, BSON_SYMBOL, BSON_CODEWSCOPE, BSON_INT, BSON_TIMESTAMP, BSON_LONG,
  MONGO_CONN_SUCCESS, MONGO_CONN_BAD_ARG, MONGO_CONN_NO_SOCKET, MONGO_CONN_FAIL,
  MONGO_CONN_NOT_MASTER, MONGO_CONN_BAD_SET_NAME, MONGO_CONN_CANNOT_FIND_PRIMARY 
  If your programs use any of these constants, you must convert them to their
  upper case forms, or you will see compile errors.
* The error handling strategy has been changed. Exceptions are not longer being used.
* Functions taking a mongo_connection object now return either MONGO_OK or MONGO_ERROR.
  In case of an error, an error code of type mongo_error_t will be indicated on the
  mongo_connection->err field.
* Functions taking a bson object now return either BSON_OK or BSON_ERROR.
  In case of an error, an error code of type bson_validity_t will be indicated on the
  bson->err or bson_buffer->err field.
* Calls to mongo_cmd_get_last_error store the error status on the
  mongo->lasterrcode and mongo->lasterrstr fields.
* bson_print now prints all types.
* Users may now set custom malloc, realloc, free, printf, sprintf, and fprintf fields.
* Groundwork for modules for supporting platform-specific features (e.g., socket timeouts).
* Added mongo_set_op_timeout for setting socket timeout. To take advantage of this, you must
  compile with --use-platform=LINUX. The compiles with platform/linux/net.h instead of the
  top-level net.h.
* Fixed tailable cursors.
* GridFS API is now in-line with the new driver API. In particular, all of the
  following functions now return MONGO_OK or MONGO_ERROR: gridfs_init,
  gridfile_init, gridfile_writer_done, gridfs_store_buffer, gridfs_store_file,
  and gridfs_find_query.
* Fixed a few memory leaks.

## 0.3
2011-4-14

* Support replica sets.
* Better standard connection API.
* GridFS write buffers iteratively.
* Fixes for working with large GridFS files (> 3GB)
* bson_append_string_n and family (Gergely Nagy)

## 0.2
2011-2-11

* GridFS support (Chris Triolo).
* BSON Timestamp type support.

## 0.1
2009-11-30

* Initial release.