Skip to content

Commit adbebca

Browse files
committed
Updated package, history and installation guide
1 parent 537a5c4 commit adbebca

File tree

3 files changed

+24
-11
lines changed

3 files changed

+24
-11
lines changed

HISTORY.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1+
2.2.13 2016-12-05
2+
-----------------
3+
* Updated mongodb-core to 2.1.0.
4+
* NODE-889 Fixed issue where legacy killcursor wire protocol messages would not be sent when APM is enabled.
5+
* Expose parserType as property on topology objects.
6+
17
2.2.12 2016-11-29
28
-----------------
3-
* Updated mongodb-core to 2.0.14.
9+
* Updated mongodb-core to 2.0.14.
410
* Updated bson library to 0.5.7.
511
* Dont leak connection.workItems elments when killCursor is called (Issue #150, https://github.com/mdlavin).
612
* Remove unnecessary errors formatting (Issue #149, https://github.com/akryvomaz).

docs/reference/content/installation-guide/index.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,27 @@ The MongoDB driver depends on several other packages, including:
2828
* mongodb-core
2929
* bson
3030
* kerberos
31+
* bson-ext
3132
* node-gyp
3233

33-
The only native extension is the `kerberos` extension. This is a `peer dependency` for the `mongodb` module. This means that if you need to use `kerberos` you will need to add the `kerberos` module to your module's dependencies.
34+
The `kerberos` and `bson-ext` extensions are native C++ extension. These are optional extensions and are not required for the driver to function.
3435

35-
If you have **NPM 2.0** or earlier NPM will attempt to download and build the `kerberos` module if you do not have it defined as a dependency in your module. However, from **NPM 3.0** onwards NPM will not attempt to build the `kerberos` module but instead print a warning in your install log that looks something like the following.
36+
## bson-ext Module
37+
38+
The `bson-ext` module is an alternative **BSON** parser that is written in C++. It delivers better deserialization performance and similar or somewhat better serialization performance to the pure javascript parser.
39+
40+
If you wish to use the `bson-ext` module you will need to add the `bson-ext` module to your module's dependencies.
3641

3742
```
38-
npm WARN EPEERINVALID [email protected] requires a peer of kerberos@~0.0 but none was installed.
43+
npm install bson-ext --save
3944
```
4045

41-
This tells you that the driver could not resolve its `peer dependency`. However, don't worry. You only need the `kerberos` module if you intend to use `kerberos`, in which case you can add it to your package.json by doing the following:
46+
## kerberos Module
47+
48+
If you need to use `kerberos` module you will need to add the `kerberos` module to your module's dependencies.
4249

4350
```
44-
npm install kerberos@0.0.x
51+
npm install kerberos --save
4552
```
4653

4754
The `kerberos` package is a C++ extension that requires a build environment to be installed on your system. You must be able to build Node.js itself to be able to compile and install the `kerberos` module. Furthermore the `kerberos` module requires the MIT Kerberos package to correctly compile on UNIX operating systems. Consult your UNIX operating system package manager for what libraries to install.
@@ -109,8 +116,8 @@ This should rebuild the driver successfully if you have everything set up correc
109116

110117
### Other possible issues
111118

112-
If Python is installed incorrectly, it can cause problems for `gyp`. It's a good idea to test your
113-
deployment environment first by trying to build Node.js itself on the server in question, as this should unearth
119+
If Python is installed incorrectly, it can cause problems for `gyp`. It's a good idea to test your
120+
deployment environment first by trying to build Node.js itself on the server in question, as this should unearth
114121
any issues with broken packages (and there are a lot of broken packages out there).
115122

116123
Another thing is to ensure your user has write permission to wherever the Node.js modules are being installed.

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mongodb",
3-
"version": "2.2.12",
3+
"version": "2.2.13",
44
"description": "The official MongoDB driver for Node.js",
55
"main": "index.js",
66
"repository": {
@@ -14,14 +14,14 @@
1414
],
1515
"dependencies": {
1616
"es6-promise": "3.2.1",
17-
"mongodb-core": "christkv/mongodb-core#1.0-bson-port",
17+
"mongodb-core": "2.1.0",
1818
"readable-stream": "2.1.5"
1919
},
2020
"devDependencies": {
2121
"JSONStream": "^1.0.7",
2222
"betterbenchmarks": "^0.1.0",
2323
"bluebird": "3.4.6",
24-
"bson": "mongodb/js-bson#1.0-branch",
24+
"bson": "1.0.0",
2525
"cli-table": "^0.3.1",
2626
"co": "4.6.0",
2727
"colors": "^1.1.2",

0 commit comments

Comments
 (0)