Docs Menu

Flutter SDK (Alpha)

Warning
Alpha Release

This SDK is currently offered as an alpha release. We encourage you to try out the feature and give feedback. However, be aware that APIs and functionality are subject to change.

The MongoDB Realm Flutter SDK enables client applications written in Dart for the Flutter platform to access data stored in local realms.

Note
Local Realm Database Only

The Flutter SDK currently only supports local Realm Database. You cannot use the SDK to connect to MongoDB Realm backend apps.

The alpha version of the SDK supports the following realm features:

  • creating Realm objects
  • retrieving Realm objects
  • updating Realm objects
  • querying, sorting, and filtering Realm objects
  • implementing change notifications

Because this is an alpha version of the SDK, functionality is limited and there are specific configuration considerations:

  • The alpha version of the SDK requires a custom engine based on Flutter 2.0. For a diff of the changes and additional information, see the runtime diff readme page.
  • You cannot use the realm_dart alpha package with the Dart SDK 2.12 shipped with Flutter 2.0. Flutter downloads a custom version of the Dart SDK, and this custom version has known problems loading native binaries. Instead, use an official Dart SDK 2.12 installation and ensure it is in your PATH.
  • The alpha version of the SDK enables working with a local-only (on device) Realm database; Realm Sync functionality is not yet implemented.
  • Flutter Hot Reload is available when running on the Android x86 Emulator and iOS Simulator.
  • Running on a physical Android device always includes the libraries in release mode.
  • New projects for iOS can not be created with flutter create. As a workaround, use the Realm Flutter and Dart Samples and modify the sample project provider_shopper.

The Getting Started section of the Realm SDK package provides:

  • The steps necessary to import Realm into a Flutter project
  • Code snippets for writing to and reading from the realm.
Give Feedback
© 2021 MongoDB, Inc.

About

  • Careers
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.