|
1 | | -# MongoDB C++ Driver [](https://travis-ci.org/mongodb/mongo-cxx-driver) |
2 | | -Welcome to the MongoDB C++ Driver! |
3 | | - |
4 | | -Please see our [wiki page](https://github.com/mongodb/mongo-cxx-driver/wiki/Download-and-Compile-the-Legacy-Driver) for information about building, testing, and using the driver. |
5 | | - |
6 | | - Version [1.1.2](https://github.com/mongodb/mongo-cxx-driver/releases/tag/legacy-1.1.2) of the |
7 | | - C++ legacy driver has been released. Please report any bugs or issues in the C++ |
8 | | - [JIRA project](http://jira.mongodb.org/browse/CXX). |
9 | | - |
10 | | -You should only use the "legacy" branch if you had been previously using |
11 | | -the "26compat" branch (or the driver inside of the server source) and want to |
12 | | -benefit from incremental improvements while having the same overall |
13 | | -API. |
14 | | - |
15 | | -> **Note:** As of MongoDB 2.6.0-rc1, it is no longer possible to build the driver from the server sources: this repository is the only approved source for C++ driver builds. |
16 | | -
|
17 | | -## Repository Overview |
18 | | - |
19 | | -| Branch | Stability | Development | Purpose | |
20 | | -| -------- | ------------| ----------------- | ----------------------------------------------------- | |
21 | | -| master | Stable | Stable Evolution | Primary stable C++ driver release, requires C++11 | |
22 | | -| legacy | Stable | Maintenance Only | Former stable C++ driver release | |
23 | | -| 26compat | Stable | Maintenance Only | Drop in replacement for users of existing 2.6 era C++ driver | |
24 | | - |
25 | | -Please note that stable branches are only production quality at stable release tags. Other |
26 | | -commits or pre-release tags on a stable branch represent ongoing development work towards the |
27 | | -next stable release, and therefore may be unstable. |
28 | | - |
29 | | -## Components |
30 | | - |
31 | | - - `libmongoclient.[so|dylib|dll]` - The shared mongoclient library (but see notes) |
32 | | - - `libmongoclient.a` - The static mongoclient library |
33 | | - |
34 | | -## Building and Usage |
35 | | - |
36 | | - - [Download and Compile](https://github.com/mongodb/mongo-cxx-driver/wiki/Download%20and%20Compile) |
37 | | - - [Tutorial](https://github.com/mongodb/mongo-cxx-driver/wiki/Tutorial) |
38 | | - |
39 | | -## Bugs and Issues |
40 | | - |
41 | | - See http://jira.mongodb.org/browse/CXX |
42 | | - |
43 | | -## Notes |
44 | | - |
45 | | - Use of the shared library is experimental on windows and is currently |
46 | | - discouraged. This is primarily due to the complexity of ensuring a matching |
47 | | - implementation of STL types between library and consumer code. This problem |
48 | | - is unique to windows, as the consistent use of system libraries largely |
49 | | - mitigates this danger. |
50 | | - |
51 | | -## Documentation |
52 | | - |
53 | | - http://docs.mongodb.org/ecosystem/drivers/cpp/ |
54 | | - |
55 | | -## Mailing Lists and IRC |
56 | | - |
57 | | - http://dochub.mongodb.org/core/community |
58 | | - |
59 | | -## License |
60 | | - |
61 | | - The source files in this repository are made available under the terms of the |
62 | | - Apache License, version 2.0. |
| 1 | +# MongoDB C++ Driver [](https://travis-ci.org/mongodb/mongo-cxx-driver)[](https://ci.appveyor.com/project/markbenvenuto/mongo-cxx-driver) |
| 2 | + |
| 3 | +Welcome to the MongoDB C++ Driver! |
| 4 | + |
| 5 | +This branch contains the legacy C++ driver. We encourage everyone to use |
| 6 | +the actively maintained `mongocxx` driver in the master branch instead. |
| 7 | + |
| 8 | +## Resources |
| 9 | + |
| 10 | +* [MongoDB C++ Driver Quickstart](https://mongodb.github.io/mongo-cxx-driver/legacy-v1/tutorial/) |
| 11 | +* [MongoDB C++ Driver Manual](https://mongodb.github.io/mongo-cxx-driver/) |
| 12 | +* [MongoDB C++ Driver API Documentation](https://mongodb.github.io/mongo-cxx-driver/api/legacy-v1) |
| 13 | +* [MongoDB C++ Driver Contribution guidelines](https://mongodb.github.io/mongo-cxx-driver/contributing/) |
| 14 | +* [MongoDB Database Manual](http://docs.mongodb.com/manual/) |
| 15 | + |
| 16 | +## Driver status by family and version |
| 17 | + |
| 18 | +Stability indicates whether this driver is recommended for production use. |
| 19 | +Currently, no drivers guarantee API or ABI stability. |
| 20 | + |
| 21 | +| Family/version | Stability | Development | Purpose | |
| 22 | +| ---------------| ------------| ------------------- | ------------------------------------------------------------ | |
| 23 | +| mongocxx 3.1.x | Unstable | Active development | Unstable C++ driver development, requires C++11 | |
| 24 | +| mongocxx 3.0.x | Stable | Bug fixes only | Primary stable C++ driver release, requires C++11 | |
| 25 | +| legacy (all) | Stable | Critical fixes only | Former stable C++ driver release | |
| 26 | +| 26compat (all) | Deprecated | Critical fixes only | Drop in replacement for users of existing 2.6 era C++ driver | |
| 27 | + |
| 28 | +## MongoDB compatibility |
| 29 | + |
| 30 | +The following compatibility table specifies the driver version(s) |
| 31 | +recommended for different versions of MongoDB. The 3.0.x series |
| 32 | +is recommended for all new development. |
| 33 | + |
| 34 | +| Family/version | MongoDB 2.4 | MongoDB 2.6 | MongoDB 3.0 | MongoDB 3.2 | |
| 35 | +| ---------------| ------------| ------------| ------------| ------------| |
| 36 | +| mongocxx 3.0.x | ✓ | ✓ | ✓ | ✓ | |
| 37 | +| legacy 1.1.x | ✓ | ✓ | ✓ | ✓ | |
| 38 | +| legacy 1.0.x | ✓ | ✓ | ✓ | | |
| 39 | +| 26compat (all) | | ✓ | | | |
| 40 | + |
| 41 | +## Bugs and issues |
| 42 | + |
| 43 | +See our [JIRA project](http://jira.mongodb.org/browse/CXX). |
| 44 | + |
| 45 | +## License |
| 46 | + |
| 47 | +The source files in this repository are made available under the terms of |
| 48 | +the Apache License, version 2.0. |
0 commit comments