Navigation
  • Realm >
  • React Native SDK

MongoDB Realm React Native SDK

The MongoDB Realm React Native SDK enables client applications using the React Native framework for iOS and Android to access data stored in local realms and interact with backend services like Functions, MongoDB Data Access, and authentication. React Native enables you to build cross-platform iOS and Android apps with a single codebase using the React framework. The React Native SDK supports both JavaScript and TypeScript applications.

Note

The React Native SDK does not support JavaScript or TypeScript applications written for web browsers. For that use case, you should consider the Web SDK. For development on Node.js without React, refer to the Node.js SDK documentation.

Installation

To learn how to add the MongoDB Realm React Native SDK library as a dependency to your application, see Install Realm for React Native.

Get Started

To get started quickly with some JavaScript or TypeScript code, see the Quick Start.

The Realm Data Model

You can store a wide variety of data within realms stored on your device. With Realm Sync, you can share updates to that data across client devices and MongoDB Atlas.

For information about the structure of data you can store in realms, see Realms, Objects, and Relationships.

To learn about the results returned from realm queries, see Collections.

Work with Realm Database

Once you have defined a data model for your application, you need to be able to write and read pieces of data to and from your realms.

To learn how to query for data in local realms, see Query Engine.

For information about how to react to changes in realm data, see Notifications.

Work with MongoDB Realm

The React native SDK also connects your Realm client application with your Realm app’s backend services, including Functions, Services, Webhooks, Realm Sync, and built-in third-party authentication.

To get connected to your MongoDB Realm app, see Initialize the RealmAppClient.

To learn how to connect to a MongoDB Realm app to call Functions, query data in an instance of MongoDB Atlas, and synchronize data in realms, see Call a Function.

To learn how to handle schema updates in your client application, see Migrations.