runt18 / realm-dotnet

Realm is a mobile database: a replacement for SQLite & ORMs

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

This repository holds the source code for the .NET / C# versions of Realm. Currently, we only support Xamarin, specifically Xamarin.iOS, and Xamarin.Android. We do plan to support Xamarin.Mac, UWP, and Unity in the future.

Features

• Mobile-first: Realm is the first database built from the ground up to run directly inside phones, tablets and wearables.
• Simple: Data is directly exposed as objects and queryable by code, removing the need for ORM's riddled with performance & maintenance issues. Plus, we've worked hard to keep our API down to just 3 common classes (RealmObject, RealmResults and Realm): 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.

Getting Started

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

Documentation

The documentation can be found at realm.io/docs/xamarin/latest.
The API reference is located at realm.io/docs/xamarin/latest/api.

Getting Help

• Need help with your code?: Look for previous questions on the #realm tag — or ask a new question. We activtely monitor & answer questions on SO!
• 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.
• Sign up for our Community Newsletter to get regular tips, learn about other use-cases and get alerted of blogposts and tutorials about Realm.

Building Realm

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

Prerequisites:

• If you target Android/iOS via Xamarin: Xamarin Community or above.
• Windows platforms: Visual Studio 2015.
• Building Xamarin iOS apps also requires Xcode 7.1.
• Building Realm documentation requires Doxygen and Graphviz
• If you are using Xamarin Studio, the StyleCop Support add-in is required.

We support the current Xamarin Stable update channel, at the time of release this corresponded to:

• Xamarin iOS version 10.0.1.10
• Xamarin Android version 7.0.1.3
• Xamarin Studio version 6.1.1

Note for Debugging that the following steps mention building for Release. If you are debugging, just substitute Debug and you probably also want to choose Debug | iPhoneSimulator as a platform.

1. Open a terminal window in the wrappers directory
2. make clean
3. make all - this will probably download a current version of core binaries, unless you have built recently. The download and subsequent builds will take some time, depending on your system, as it builds a binary wrapper library for each platform including all Android CPU variations.
4. Open the Realm.sln in Xamarin Studio on OS X
   1. Choose the Solution Realm in the Solution navigator and context menu to Clean Realm
   2. platform popup Release | Default
   3. select Realm.PCL project and Build
   4. select RealmWeaver.Fody project and Build
   5. select platform popup Release | ARM
   6. select Realm.XamarinAndroid project and Build
   7. ensure you have an iOS device attached
   8. select platform popup Release | iPhone
   9. select Realm.XamarinIOS project and Build
5. If you want to build the NuGet packages, go on from this point and follow the steps in internals/RealmDotnetNugetBuild.md

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

Contributing

See CONTRIBUTING.md for more details!

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

License

Realm is published under the Apache 2.0 license.
The underlying core is available under the Realm Core Binary License while we work to open-source it under the Apache 2.0 license.

This product is not being made available to any person located in Cuba, Iran, North Korea, Sudan, Syria or the Crimea region, or to any other person that is not eligible to receive the product under U.S. law.

Feedback

If you use Realm and are happy with it, all we ask is that you please consider sending out a tweet mentioning @realm, or email [email protected] to let us know about it!

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