Docs Menu

Docs HomeRealm

Realm Files - Flutter SDK

On this page

  • Realm Files

A realm is the core data structure used to organize data in Realm Database. A realm is a collection of the objects that you use in your application, called Realm objects, as well as additional metadata that describe the objects. To learn how to define a Realm object, see Define a Realm Object Schema.

When you open a realm, you can include configuration that specifies additional details about how to configure the realm file. This includes things like:

  • Pass a file path or in-memory identifier to customize how the realm is stored on device

  • Provide a logged-in user and Sync details to use Sync with the realm

  • Specify the realm use only a subset of your app's classes

  • Whether and when to compact a realm to reduce its file size

  • Pass an encryption key to encrypt a realm

  • Provide a schema version or migration block when making schema changes

Realm Database stores a binary encoded version of every object and type in a realm in a single .realm file. The file is located at a specific path that you can define when you open the realm. You can open, view, and edit the contents of these files with Realm Studio.

Realm Database also creates additional files for each realm. To learn more about these files, see Realm Database Internals. Deleting these files has important implications. For more information about deleting .realm or auxiliary files, refer to Delete a Realm.

←  Freeze Data - Flutter SDKDelete a Realm File - Flutter SDK →

On this page

Share Feedback
© 2023 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2023 MongoDB, Inc.