Docs Menu

Atlas Device SDK for C++

Use Atlas Device SDK for C++ to write applications that access data stored locally on devices and sync data with Atlas.

Learning Paths
Functions Icon

Quick Start

Minimal-explanation code examples of how to work with the C++ SDK, write to the device database, and sync with other devices.

See Code Examples

Atlas Device SDK Mobile Icon

Working Example App

Learn from a working terminal GUI client app that uses the C++ SDK.

Explore an Example App

Tutorial Icon

Guided Tutorial

Follow a guided tutorial to learn how to adapt the example app to create your own working app.

Follow the Tutorial

What You Can Do

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.

1

Use Swift Package Manager or Cmake to Install the C++ SDK in your project.

Include the header in the translation unit where you want to use it to get started.

2

Use C++ to idiomatically define an object type.

3

The SDK's database - Realm - stores objects in files on your device. Configure and open a database to get started reading and writing data.

4

Create, read, update, and delete objects from the database. Filter data using the SDK's query engine.

5

Live objects mean that your data is always up-to-date. You can register a notification handler to watch for changes and perform some logic, such as updating your UI.

Atlas Device SDK Mobile Illustration
1

Configure Device Sync in an App Services App. Define data access rules. Use Development Mode to infer your schema from your C++ data model.

Then, connect to the backend from your client.

2

Use one of our authentication providers to authenticate a user. App Services provides access to popular authentication providers, such as Apple, Google, or Facebook. Use our built-in email/password provider to manage users without a third-party, or use custom JWT authentication to integrate with other authentication providers. Anonymous authentication provides access without requiring a login or persisting user data.

3

Configure and open a synced database. Subscribe to a query to determine what data the synced database can read and write.

4

The APIs to read and write data are the same whether you're using a synced or non-synced database. Data that you read and write to the device is automatically kept in sync with your Atlas cluster and other clients. Apps keep working offline and deterministically sync changes whenever a network connection is available.

Device Sync Illustration

You can call serverless Functions from your client application that run in an App Services backend.

Authenticate users with built-in and third-party authentication providers. Use the authenticated user to access App Services.

App Services Illustration
Essential Documentation
Functions Icon

Quick Start

Minimal-explanation code examples of how to work with the SDK.

See Code Examples

SDK Icon

C++ API Reference

Explore generated Doxygen reference docs for the C++ APIs.

C++ SDK Reference