API Documentation

You use the domino-db module to perform bulk operations on documents in a server database. The domino-db module uses the Domino Query Langauge (DQL) to select target documents for most operations. The API section of this web site includes a complete set of documentation on both domino-db and DQL.

Before you can use the domino-db module:

• Confirm the Proton add-in is already installed on your Domino server.
• If Proton is configured for TLS/SSL, ask your administrator for your client credentials and your root certificate.
• Ask your administrator for the domino-db archive from the AppDev Pack. The archive file name is domino-domino-db-1.11.7.tgz.

NOTE: Eventually, you will install the domino-db module directly from the npm registry. However, this version is not available from npm. You need to extract the module directly from the domino-db archive.

To get started with domino-db, visit the Quick Start page.