Repository files navigation

Realm is a mobile database that runs directly on phones, tablets or wearables.

This repository holds the source code for the .NET / C# versions of Realm. Currently, we support all major mobile and desktop operating systems, such as iOS, Android, UWP, macOS, Linux, and Windows. For a full list of supported platforms and their versions, check out thePlatform and Framework Compatibility section in the documentation.

• Mobile-first: Realm is the first database built from the ground up to run directly inside phones, tablets, and wearables.
• Simple: Data is directlyexposed as objects andqueryable by code, removing the need for ORM's riddled with performance & maintenance issues. Plus, we've worked hard tokeep our API down to just a few common classes: most of our users pick it up intuitively, getting simple apps up & running in minutes.
• Modern: Realm supports relationships, generics, vectorization and modern C# idioms.
• Fast: Realm is faster than even raw SQLite on common operations while maintaining an extremely rich feature set.
• MongoDB Atlas Device Sync: Makes it simple to keep data in sync across users, devices, and your backend in real-time. Get started for free witha template application andcreate the cloud backend.

Please see the detailed instructions in ourUser Guide to add Realm to your solution.

The documentation can be found atmongodb.com/docs/atlas/device-sdks/sdk/dotnet/.The API reference is located atmongodb.com/docs/realm-sdks/dotnet/latest/.

• Need help with your code?: Look for previous questions on the#realm tag — orask a new question. You can also check out ourCommunity Forum where general questions about how to do something can be discussed.
• Have a bug to report?Open an issue. If possible, include the version of Realm, a full log, the Realm file, and a project that shows the issue.
• Have a feature request?Open an issue. Tell us what the feature should do, and why you want the feature.

If you want to test recent bugfixes or features that have not been packaged in an official release yet, you can use the preview releases published after everycommit to our private NuGet feed. The source URL you need to specify for our feed ishttps://s3.amazonaws.com/realm.nugetpackages/index.json.Refer tothis guide for instructions on adding custom sources to the NuGet Package Manager.

We highly recommendusing our pre-built binaries via NuGet but you can also build from source.

Prerequisites:

• Visual Studio 2019 Community or above.
• Building iOS/macOS apps also requires Xcode 8.1 or above.

Instructions:

1. Download and build the native libraries using the instructions inwrappers/README.md
2. Open theRealm.sln inVisual Studio
3. BuildRealm,Realm.Fody andRealm.SourceGenerator
4. Build and run the tests for the relevant platforms.

If you are actively testing code against the Realm source, see also the unit test projects and other tests under the Tests folder.

Some minimal examples of Realm use can be found in theexamples folder:

• QuickJournal: a quick journalingMAUI application that shows how Realm can be used effectively in conjunction with MVVM and data binding.
• SimpleToDo: a simple to-do listAvalonia application that shows how Realm can be used effectively in conjunction with MVVM and data binding.

It is possible to find additional (and more complex) examples that useAtlas Device Sync in therealm-dotnet-samples repo.

SeeCONTRIBUTING.md for more details!

This project adheres to theMongoDB Code of Conduct.By participating, you are expected to uphold this code. Please reportunacceptable behavior tocommunity-conduct@mongodb.com.

Realm .NET andRealm Core are published under the Apache License 2.0.

If you use Realm and are happy with it, all we ask is that you please consider sending out a tweet mentioning@realm to share your thoughts!

And if you don't like it, please let us know what you would like improved, so we can fix it!