Smart Mastering API for Node.js

This library provides access to MarkLogic Smart Mastering from Node.js applications.

Smart Mastering allows you to improve the quality of your data by deduplicating information. You can use the API to:

• Determine documents that match based on similarity information specified in match options.
• Merge matching documents based on priority information specified in merge options.
• Match and merge documents with a single command.
• Review the matching and merging process by inspecting notifications and history information.
• Roll back merges when necessary without loss of data.

For more information, see the Smart Mastering documentation.

Getting Started

Requirements are the same as for Smart Mastering (MarkLogic 9.0-5+, Java 8+).

Set up the Smart Mastering project's minimal-project example to create and populate mastering databases in MarkLogic.

Initialize a new project with npm and install the smart-mastering-node library and its dependencies:

mkdir sm-project
cd sm-project
npm init
...
npm install wooldridge/smart-mastering-node

Create an index.js script in your project directory and save the following in it:

const sm = require('smart-mastering-node');
let client = sm.createClient({
  host: 'localhost',
  port: 8800,
  user: 'admin',
  password: 'admin'
})
client.readStats().then((result) => {
  console.log(result);
})

(Edit the authentication properties above for your environment.)

Run the script:

$ node index.js

Statistics about Smart Mastering are returned:

{ docCount: 0,
  mergeCount: 0,
  instanceCount: null,
  notificationCount: null }

Running Tests

Set up the Smart Mastering project's minimal-project example. The tests use the example's databases.

From the project root, run the following:

npm test

Generating Documentation

Install JSDoc:

npm install -g jsdoc

From the project root, run the following:

jsdoc -c ./jsdoc.json

Documentation is generated in a docs folder.