From ecc904145e219d088b04f40cee5ea7fc4971e1fc Mon Sep 17 00:00:00 2001 From: MayankBhatnagar89 Date: Mon, 10 Apr 2017 11:42:34 +0530 Subject: [PATCH 1/9] Updating timelimit to avoid intermittent issue --- test-complete/nodejs-documents-transaction-timelimit.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test-complete/nodejs-documents-transaction-timelimit.js b/test-complete/nodejs-documents-transaction-timelimit.js index 37559d49..c4ca390e 100644 --- a/test-complete/nodejs-documents-transaction-timelimit.js +++ b/test-complete/nodejs-documents-transaction-timelimit.js @@ -52,7 +52,7 @@ describe('Document transaction test', function() { */ var tid = 0; it('should commit the write document', function(done) { - db.transactions.open({transactionName: "nodeTransaction", timeLimit: 1}) + db.transactions.open({transactionName: "nodeTransaction", timeLimit: 2}) .result(function(response) { tid = response.txid; return db.documents.write({ @@ -70,7 +70,7 @@ it('should commit the write document', function(done) { .then(function(response) { //console.log(JSON.stringify(response, null, 2)); response['transaction-status']['transaction-name'].should.equal('nodeTransaction'); - response['transaction-status']['time-limit'].should.equal('1'); + response['transaction-status']['time-limit'].should.equal('2'); done(); }, done); /*.catch(function(error) { From a3c56b640a5832b3ef7bee2aac45fff3ccbed43b Mon Sep 17 00:00:00 2001 From: Mike Wooldridge Date: Fri, 21 Apr 2017 16:05:35 -0700 Subject: [PATCH 2/9] Move status and new feature info to release page --- README.md | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/README.md b/README.md index fd247cf8..b2153da7 100644 --- a/README.md +++ b/README.md @@ -13,23 +13,6 @@ from Node.js applications. * Extending the built-in services or evaluating or invoking your own JavaScript or XQuery on the server * Basic, digest, certificate, and Kerberos authentication -## Status - -Release 2.0.1 of the MarkLogic Node.js Client API, tested to work with MarkLogic -versions 8.0-6.3 and 9.0-1. To use the new features available in release 2.0.1, -you will need to run MarkLogic version 9. - -## New Features in Release 2.0.1 - -- Certificate authentication -- Kerberos authentication -- Geospatial region search -- Double precision values for geospatial queries -- Temporal operations, including protect and wipe -- Metadata values -- Specifying a minimum distance for near queries -- Bug fixes and documentation enhancements - ## Getting Started You can install the marklogic package as a dependency for your Node.js project From ad97ad18dc1a4962adf60ecbd94b150cf224397a Mon Sep 17 00:00:00 2001 From: Mike Wooldridge Date: Fri, 21 Apr 2017 16:17:52 -0700 Subject: [PATCH 3/9] Add gulp link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b2153da7..9856c1a0 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ in the online resources. To run the examples, follow the instructions here: ### Generating Documentation -After installing the project dependencies (including the gulp build system), +After installing the project dependencies (including the [gulp](http://gulpjs.com/) build system), you can build the reference documentation locally from the root directory of the marklogic package: From a187824c4fb6947c94fc6c1a175fc7048abd6749 Mon Sep 17 00:00:00 2001 From: Mike Wooldridge Date: Fri, 21 Apr 2017 16:38:45 -0700 Subject: [PATCH 4/9] Minor updates to KERBEROS.md --- KERBEROS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/KERBEROS.md b/KERBEROS.md index e9cc0232..50187988 100644 --- a/KERBEROS.md +++ b/KERBEROS.md @@ -1,6 +1,6 @@ # Kerberos Authentication -In addition to basic, digest, and certificate authentication, the Node.js Client API supports [Kerberos authentication](https://docs.marklogic.com/guide/security/external-auth) for MarkLogic servers that have been so configured. +In addition to basic, digest, and certificate authentication, the Node.js Client API supports [Kerberos authentication](https://docs.marklogic.com/guide/security/external-auth) on MarkLogic servers. The Node.js Client API uses the [kerberos](https://www.npmjs.com/package/kerberos) module to support Kerberos authentication and requires (on Linux): @@ -11,6 +11,6 @@ The Node.js Client API uses the [kerberos](https://www.npmjs.com/package/kerbero Windows requires additional libraries. See the [kerberos documentation](https://www.npmjs.com/package/kerberos) for details. -The [kerberos](https://www.npmjs.com/package/kerberos) module is listed as an optional dependency in the Node Client API package.json. To skip installing optional modules during [npm install](https://docs.npmjs.com/cli/install), use the --no-optional flag: +The [kerberos](https://www.npmjs.com/package/kerberos) module is listed as an optional dependency in the Node.js Client API package.json. To skip installing optional modules during [npm install](https://docs.npmjs.com/cli/install), use the --no-optional flag: npm install --no-optional From f1da6497202d77cd4c5ae00257e7de6b8cf79f01 Mon Sep 17 00:00:00 2001 From: Mike Wooldridge Date: Fri, 21 Apr 2017 17:35:05 -0700 Subject: [PATCH 5/9] Add resource links to the README --- README.md | 27 ++++++++++----------------- 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 9856c1a0..b072ae16 100644 --- a/README.md +++ b/README.md @@ -50,21 +50,14 @@ db.createCollection( }); ``` -Other calls can create additional documents for the same collection. - ### Resources -Here are some online resources that walk you through working with MarkLogic -using the Node.js Client API: - -* [MarkLogic Node.js Client API](http://developer.marklogic.com/features/node-client-api) -* [Introduction to the Node.js Client API - Getting Started](http://docs.marklogic.com/guide/node-dev/intro#id_68052) - -The instructions describe: - -* installing the MarkLogic database and setting up an admin user -* installing the Node.js Client API using npm -* working through some initial examples to get familiar with the API +* [Node.js Client API Documentation](https://docs.marklogic.com/jsdoc/index.html) +* [Feature Overview of the Node.js Client API](http://developer.marklogic.com/features/node-client-api) +* [The Node.js Client API in 5 Minutes](https://developer.marklogic.com/learn/node-in-5-minutes) +* [Node.js Application Developer's Guide](http://docs.marklogic.com/guide/node-dev) +* [MarkLogic Training for the Node.js Client API](http://www.marklogic.com/training-courses/developing-marklogic-applications-i-node-js/) +* [MarkLogic On-Demand Courses for Node.js](https://mlu.marklogic.com/ondemand/index.xqy?q=Series%3A%22Node.js%22) ### Code Examples @@ -73,11 +66,11 @@ in the online resources. To run the examples, follow the instructions here: examples/1readme.txt -### Generating Documentation +### Generating Documentation Locally -After installing the project dependencies (including the [gulp](http://gulpjs.com/) build system), -you can build the reference documentation locally from the root directory of the -marklogic package: +After installing the project dependencies (including the [gulp](http://gulpjs.com/) +build system), you can build the reference documentation locally from the root +directory of the marklogic package: gulp doc From 94adcd47b25b97e9bcc8af76e45092bd9bbc1643 Mon Sep 17 00:00:00 2001 From: Mike Wooldridge Date: Fri, 21 Apr 2017 18:35:42 -0700 Subject: [PATCH 6/9] Add another link to the online docs to the README --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b072ae16..f3256ff0 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,8 @@ directory of the marklogic package: gulp doc -The documentation is generated in a doc subdirectory. +The documentation is generated in a doc subdirectory. The documentation can also be +accessed online [here](https://docs.marklogic.com/jsdoc/index.html). ### Running Tests From e701f80e5ffe027196d26653c872e37fc1826bfc Mon Sep 17 00:00:00 2001 From: Mike Wooldridge Date: Mon, 24 Apr 2017 15:11:57 -0700 Subject: [PATCH 7/9] Fix links to static methods in marklogic namespace --- lib/patch-builder.js | 2 +- lib/query-builder.js | 4 ++-- lib/values-builder.js | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/patch-builder.js b/lib/patch-builder.js index e5492e60..ec0c7130 100644 --- a/lib/patch-builder.js +++ b/lib/patch-builder.js @@ -22,7 +22,7 @@ var qb = require('./query-builder.js'); /** * A helper for building the definition of a document patch. The helper is - * created by the {@link module:marklogic.patchBuilder} function. + * created by the {@link marklogic.patchBuilder} function. * @namespace patchBuilder */ diff --git a/lib/query-builder.js b/lib/query-builder.js index b473e768..006ea00d 100644 --- a/lib/query-builder.js +++ b/lib/query-builder.js @@ -72,7 +72,7 @@ function addIndex(query, index, isContainer) { /** * A helper for building the definition of a document query. The helper is - * created by the {@link module:marklogic.queryBuilder} function. + * created by the {@link marklogic.queryBuilder} function. * @namespace queryBuilder */ @@ -3871,7 +3871,7 @@ util.inherits(TrueQueryDef, QueryDef); * and the number of documents in the slice. (A slice is also sometimes * called a page of search results.) * By default, the slice uses array slice mode, but you can switch - * to legacy slice mode with {@link module:marklogic.setSliceMode}. Legacy + * to legacy slice mode with {@link marklogic.setSliceMode}. Legacy * slice mode is deprecated and will be removed in the next major release. * @method * @since 1.0 diff --git a/lib/values-builder.js b/lib/values-builder.js index 513a0427..55cda264 100644 --- a/lib/values-builder.js +++ b/lib/values-builder.js @@ -40,7 +40,7 @@ var qb = require('./query-builder.js').builder; /** * A helper for building the definition of a values query, which projects * tuples (aka rows) of values out of documents. The helper is created by - * the {@link module:marklogic.valuesBuilder} function. You must call + * the {@link marklogic.valuesBuilder} function. You must call * the {@link valuesBuilder#fromIndexes} function to supply the required * clause of the values query before calling the * {@link valuesBuilder.BuiltQuery#where}, From bdf6f15fc28c7f7eec40d76f96f947e9f015afaf Mon Sep 17 00:00:00 2001 From: Mike Wooldridge Date: Mon, 1 May 2017 17:36:45 -0700 Subject: [PATCH 8/9] Up package.json version property for 2.0.1 release --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 9b73a60f..febdaf16 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "name": "marklogic", "description": "The official MarkLogic Node.js client API.", "homepage": "http://github.com/marklogic/node-client-api", - "version": "2.0.0-ea4", + "version": "2.0.1", "license": "Apache-2.0", "main": "./lib/marklogic.js", "keywords": [ From 8da905c077b2ec3b7243e00865163307e16e2e0f Mon Sep 17 00:00:00 2001 From: kkanthet Date: Tue, 2 May 2017 11:36:12 -0700 Subject: [PATCH 9/9] Updated Copyright --- test-basic/data/echoModule.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test-basic/data/echoModule.js b/test-basic/data/echoModule.js index b7af720e..aeb4724c 100644 --- a/test-basic/data/echoModule.js +++ b/test-basic/data/echoModule.js @@ -1,5 +1,5 @@ /* - * Copyright 2014-2016 MarkLogic Corporation + * Copyright 2014-2017 MarkLogic Corporation * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.