https://github.com/marklogic/node-client-api
The MarkLogic Node.js Client API
https://github.com/marklogic/node-client-api
Last synced: 3 months ago
JSON representation
The MarkLogic Node.js Client API
- Host: GitHub
- URL: https://github.com/marklogic/node-client-api
- Owner: marklogic
- License: apache-2.0
- Created: 2014-04-30T01:12:46.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T01:14:50.000Z (about 1 year ago)
- Last Synced: 2024-04-14T13:08:22.918Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://docs.marklogic.com/jsdoc/index.html
- Size: 10.1 MB
- Stars: 53
- Watchers: 29
- Forks: 48
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# MarkLogic Node.js Client API
The MarkLogic Node.js Client API provides access to the MarkLogic database
from Node.js applications.
## Features
* Writing, reading, patching, and deleting documents in JSON, XML, text, or binary formats
* Querying over documents including parsing string queries, extracting properties, and calculating facets
* Projecting tuples (like table rows) out of documents
* Single transactions and multi-statement transactions for database changes
* Writing, reading, and deleting graphs and executing SPARQL queries over graphs
* Extending the built-in services or evaluating or invoking your own JavaScript or XQuery on the server
* Basic, digest, certificate, Kerberos, and SAML authentication
* Import libraries as JavaScript mjs modules
* Data Services First - MarkLogic's support for microservices
* Optic query DSL, document matching, relevance, multiple groups
* Generate query based views, redaction on rows
* Data Movement SDK - move large amounts of data into, out of, or within a MarkLogic cluster
## Getting Started
You can install the marklogic package as a dependency for your Node.js project
using [npm](https://www.npmjs.com/package/marklogic):
```
npm install marklogic --save
```
For Windows OS please use the below for Node Client 2.9.1:
```
npm install marklogic --save --ignore-scripts
```
With the marklogic package installed, the following inserts two documents in a
collection into the Documents database using MarkLogic's built-in REST server
at port 8000:
```javascript
const marklogic = require('marklogic');
const db = marklogic.createDatabaseClient({
host: 'localhost',
port: '8000',
database: 'Documents',
user: 'admin',
password: 'admin',
authType: 'DIGEST',
// enableGzippedResponses is optional and can be set to true in order to request MarkLogic to compress the response for better performance,
// the client will automatically decompress the response before it returns a value.
enableGzippedResponses: true
});
// For MarkLogic Cloud
const db = marklogic.createDatabaseClient({
apiKey: 'changeme',
host: 'example.beta.marklogic.com',
authType: 'cloud',
// basePath is optional.
basePath: '/marklogic/test',
// accessTokenDuration (in seconds) is optional and can be used to customize the expiration of the access token.
accessTokenDuration: 10,
// enableGzippedResponses is optional and can be set to true in order to request MarkLogic to compress the response for better performance,
// the client will automatically decompress the response before it returns a value.
enableGzippedResponses: true
});
// For OAUTH
const db = marklogic.createDatabaseClient({
host: 'localhost',
port: '8000',
authType: 'oauth',
oauthToken: ''
});
db.createCollection(
'/books',
{author: 'Beryl Markham', ...},
{author: 'WG Sebald', ...}
)
.result(function(response) {
console.log(JSON.stringify(response, null, 2));
}, function (error) {
console.log(JSON.stringify(error, null, 2));
});
```
### Resources
* [Node.js Client API Documentation](https://docs.marklogic.com/jsdoc/index.html)
* [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/)
### Code Examples
The Node.js Client API ships with code examples to supplement the examples
in the online resources. To run the examples, follow the instructions here:
examples/1readme.txt
### 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:
npm run doc
The documentation is generated in a doc subdirectory. The documentation can also be
accessed online [here](https://docs.marklogic.com/jsdoc/index.html).
## Support
The MarkLogic Node.js Client API is maintained by MarkLogic Engineering.
It is designed for use in production applications with MarkLogic Server.
Everyone is encouraged to file bug reports, feature requests, and pull
requests through GitHub. This input is critical and will be carefully
considered, but we can’t promise a specific resolution or timeframe for
any request. In addition, MarkLogic provides technical support
for [release tags](https://github.com/marklogic/node-client-api/releases)
of the Node.js Client API to licensed customers under the terms outlined
in the [Support Handbook](http://www.marklogic.com/files/Mark_Logic_Support_Handbook.pdf).
For more information or to sign up for support,
visit [help.marklogic.com](http://help.marklogic.com).