Atlas Device SDK for Node.js

Realm is now Atlas Device SDK – Learn More

Use the Atlas Device SDK for Node.js to build for server applications, desktop applications, CLIs, IoT programs, and more in JavaScript or TypeScript.

The Node.js SDK does not support applications written for web browsers. For Web apps, use the Web SDK. For React Native development, use the React Native SDK.

To get started with the Node.js SDK, see Quick Start.

What You Can Do

Develop Apps with the SDK

Use the SDK's open-source database - Realm - as an object store on the device. Use Device Sync to keep data in sync with your MongoDB Atlas cluster and other clients.

Install the Node.js SDK

To get started, install the Node.js SDK.

Define an Object Schema

Use JavaScript to idiomatically define an object schema.

Configure & Open a Database

You can configure your database to do things like populate initial data on load, use an encryption key to secure data, and more. To begin working with your data, configure and open a database.

Read and Write Data

You can create, read, update, and delete objects from the device database. Construct complex queries to filter data.

React to Changes

Live objects mean that your data is always up-to-date. Register a change listener to react to changes and perform logic like updating your UI.

Connect to an Atlas App Services App

Configure Device Sync in an App Services App. Define data access rules or use Development Mode to infer a schema from your client's data model. Then, connect to the backend App from your Node.js client.

Authenticate a User

App Services provides access to custom JWT authentication, our built-in email/password provider, anonymous authentication, and popular authentication providers like Apple, Google, and Facebook. Use these providers to authenticate a user in your client.

Open a Synced Database

To get started syncing data, open a synced database. To determine what data a synced database can read and write, subscribe to a query.

Read and Write Synced Data

The APIs for reading and writing data are the same for both synced and non-synced databases. Data that you read and write on the device is automatically kept in sync with your Atlas cluster and other clients. Apps keep working offline and sync changes when a network connection is available.

Use Atlas App Services in your Node.js application with the Realm SDK.

Call Serverless Functions

To invoke serverless backend logic from your Node.js client, call Atlas Functions.

Query MongoDB Atlas

Query data stored in MongoDB directly from your client application code with MongoDB Data Access.

Authenticate Users

Authenticate users with built-in and third-party authentication providers. Access App Services with authenticated users.

Essential Documentation

Example Projects

Explore engineering and expert-provided example projects to learn best practices and common development patterns using the Node.js SDK. Check out the Example Projects page for more Node.js sample apps.