Using Node.js with Caché - InterSystems Documentation

Overview of cache.node Methods
{
}
"ErrorMessage": [error message text],
"ErrorCode": [error code],
"ok": [true|false]
For synchronous operation, you should check for the existence of these properties in the result object to determine whether
or not an error has occurred.
3.3 Overview of cache.node Methods
The individual cache.node methods are described in detail in the reference section. Here is a brief summary of the available
methods and their uses, with links to the reference section entries:
Opening and closing the database
See “Opening and Closing the Caché Database” for basic information on using these methods:
• open() — opens the specified Caché database.
• close() — closes a previously opened database.
Operations on individual nodes
• set() — sets the value of a global node.
• get() — retrieves a global node.
• kill() — deletes a global node.
• increment() — adds 1 to the value of an integer in a global node.
• merge() — copies all or part of a global to another global.
Iteration over global nodes
• data() — tests for the existence of a global node.
• next() and previous() — gets the next or previous global node subscript on the current level.
• next_node() and previous_node() — gets the next or previous global node in collation order regardless of
level.
• lock() and unlock() — locks global nodes for exclusive use, and unlocks nodes previously locked by your
program.
Advanced data access
These methods perform batch read and write operations that are frequently more efficient than access with the
basic NoSQL-style methods:
• retrieve() — recursively retrieves all global nodes defined beneath a specified level and returns them as a
single JSON object.
• update() — uses information in a JSON object to write a set of globals to the database.
See “Advanced Data Access with retrieve() and update()” for a detailed discussion of usage.
Using Node.js with Caché 9