Realm 20.0.0
dotnet add package Realm --version 20.0.0
NuGet\Install-Package Realm -Version 20.0.0
<PackageReference Include="Realm" Version="20.0.0" />
paket add Realm --version 20.0.0
#r "nuget: Realm, 20.0.0"
// Install Realm as a Cake Addin #addin nuget:?package=Realm&version=20.0.0 // Install Realm as a Cake Tool #tool nuget:?package=Realm&version=20.0.0
<picture> <source srcset="./media/logo-dark.svg" media="(prefers-color-scheme: dark)" alt="realm by MongoDB"> <img src="./media/logo.svg" alt="realm by MongoDB"> </picture>
Realm is a mobile database that runs directly on phones, tablets or wearables. It supports 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 the Platform and Framework Compatibility section in the documentation.
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 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.
- Device Sync: Makes it simple to keep data in sync across users, devices, and your backend in real-time. Get started for free with a template application and create the cloud backend.
Getting Started
Model definition
Define a persistable model by inheriting from IRealmObject
. The Realm source generator will generate an implementation for most of the functionality, so you only need to specify the properties you want to persist:
public partial class Person : IRealmObject
{
[PrimaryKey]
public ObjectId Id { get; private set; } = ObjectId.GenerateNewId();
public string FirstName { get; set; }
public string LastName { get; set; }
public DateTimeOffset Birthday { get; set; }
// You can define constructors as usual
public Person(string firstName, string lastName)
{
FirstName = firstName;
LastName = lastName;
}
}
Open a Realm file
Open a Realm instance by calling Realm.GetInstance
:
// You can provide a relative or an absolute path to the Realm file or let
// Realm use the default one.
var realm = Realm.GetInstance("people.realm");
CRUD operations
Add, read, update, and remove objects by calling the corresponding API on the Realm
instance:
// Always mutate the Realm instance in a write transaction
realm.Write(() =>
{
realm.Add(new Person("John", "Smith"));
});
var peopleWithJ = realm.All<Person>().Where(p => p.FirstName.StartsWith("J"));
// All Realm collections and objects are reactive and implement INotifyCollectionChanged/INotifyPropertyChanged
peopleWithJ.AsRealmCollection().CollectionChanged += (s, e) =>
{
// React to notifications
};
For more examples, see the detailed instructions in our User Guide to add Realm to your solution.
Documentation
The documentation can be found at mongodb.com/docs/atlas/device-sdks/sdk/dotnet/. The API reference is located at mongodb.com/docs/realm-sdks/dotnet/latest/.
Getting Help
- Need help with your code?: Look for previous questions on the #realm tag — or ask a new question. You can also check out our Community 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.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net46 is compatible. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid is compatible. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios is compatible. |
Xamarin.Mac | xamarinmac is compatible. |
Xamarin.TVOS | xamarintvos is compatible. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Fody (>= 6.8.1)
- Microsoft.CSharp (>= 4.5.0)
- MongoDB.Bson (>= 2.21.0)
- Remotion.Linq (>= 2.2.0)
- System.Buffers (>= 4.5.1)
- System.Dynamic.Runtime (>= 4.3.0)
- System.Memory (>= 4.5.5)
- System.Net.Security (>= 4.3.2)
- System.Net.WebSockets.Client (>= 4.3.2)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
- System.Threading.Channels (>= 6.0.0)
-
net6.0
- Fody (>= 6.8.1)
- Microsoft.CSharp (>= 4.5.0)
- MongoDB.Bson (>= 2.21.0)
- Remotion.Linq (>= 2.2.0)
- System.Buffers (>= 4.5.1)
- System.Dynamic.Runtime (>= 4.3.0)
- System.Memory (>= 4.5.5)
- System.Net.Security (>= 4.3.2)
- System.Net.WebSockets.Client (>= 4.3.2)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
- System.Threading.Channels (>= 6.0.0)
-
net8.0
- Fody (>= 6.8.1)
- Microsoft.CSharp (>= 4.5.0)
- MongoDB.Bson (>= 2.21.0)
- Remotion.Linq (>= 2.2.0)
- System.Buffers (>= 4.5.1)
- System.Dynamic.Runtime (>= 4.3.0)
- System.Memory (>= 4.5.5)
- System.Net.Security (>= 4.3.2)
- System.Net.WebSockets.Client (>= 4.3.2)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
- System.Threading.Channels (>= 6.0.0)
NuGet packages (39)
Showing the top 5 NuGet packages that depend on Realm:
Package | Downloads |
---|---|
ppy.osu.Game
Package Description |
|
Iridium360.Connect.Framework
This framework allows you to bind your Android or iOS device with i360RockSTAR tracker |
|
ItEnterprise.Common.CoreStandard
ItEnterprise Common.CoreStandard for Xamarin Forms |
|
Arc4u.Standard.Diagnostics.Serilog.Sinks.RealmDb
Package Description |
|
ItEnterprise.WmsStandard
ItEnterprise WmsStandard for Xamarin Forms |
GitHub repositories (7)
Showing the top 5 popular GitHub repositories that depend on Realm:
Repository | Stars |
---|---|
ppy/osu
rhythm is just a *click* away!
|
|
realm/realm-dotnet
Realm is a mobile database: a replacement for SQLite & ORMs
|
|
sgermosen/xReader
XML, NEWS, RSS & Scrapping Reader maked in Xamarin, for educational purpose.
|
|
Piotrekol/CollectionManager
An extensive tool for creating, editing, and exporting of osu! collections.
|
|
realm/realm-draw
The official Realm Draw app used in promotional videos
|
Version | Downloads | Last updated | |
---|---|---|---|
20.0.0 | 3,947 | 9/9/2024 | |
12.4.1 | 1,967 | 9/16/2024 | |
12.4.0 | 8,124 | 8/25/2024 | |
12.3.0 | 23,953 | 7/20/2024 | |
12.2.0 | 41,753 | 5/22/2024 | |
12.1.0 | 11,230 | 5/1/2024 | |
12.0.0 | 11,619 | 4/17/2024 | |
11.7.0 | 84,569 | 2/5/2024 | |
11.6.1 | 82,854 | 11/17/2023 | |
11.6.0 | 20,252 | 11/4/2023 | |
11.5.0 | 245,232 | 9/16/2023 | |
11.4.0 | 30,123 | 8/16/2023 | |
11.3.0 | 42,896 | 7/26/2023 | |
11.2.0 | 16,364 | 7/8/2023 | |
11.1.2 | 106,986 | 6/20/2023 | |
11.1.1 | 6,810 | 6/19/2023 | |
11.1.0 | 2,707 | 6/17/2023 | |
11.0.0 | 44,262 | 5/8/2023 | |
10.21.1 | 40,529 | 4/21/2023 | |
10.21.0 | 23,910 | 3/24/2023 | |
10.20.0 | 90,012 | 2/10/2023 | |
10.19.0 | 35,059 | 1/6/2023 | |
10.18.0 | 135,620 | 11/2/2022 | |
10.17.0 | 92,441 | 10/6/2022 | |
10.16.0 | 12,825 | 10/3/2022 | |
10.15.1 | 109,524 | 8/8/2022 | |
10.15.0 | 5,699 | 8/5/2022 | |
10.14.0 | 183,048 | 6/2/2022 | |
10.13.0 | 28,241 | 5/18/2022 | |
10.12.0 | 18,342 | 5/5/2022 | |
10.11.2 | 35,111 | 4/21/2022 | |
10.11.1 | 21,655 | 3/31/2022 | |
10.11.0 | 5,548 | 3/28/2022 | |
10.10.0 | 96,150 | 2/28/2022 | |
10.9.0 | 80,169 | 1/21/2022 | |
10.8.0 | 38,370 | 1/17/2022 | |
10.7.1 | 105,409 | 11/20/2021 | |
10.7.0 | 7,229 | 11/10/2021 | |
10.6.0 | 165,737 | 9/30/2021 | |
10.5.1 | 18,235 | 9/22/2021 | |
10.5.0 | 30,997 | 9/9/2021 | |
10.4.1 | 3,807 | 9/3/2021 | |
10.4.0 | 11,379 | 8/31/2021 | |
10.3.0 | 139,753 | 7/7/2021 | |
10.2.1 | 27,104 | 7/1/2021 | |
10.2.0 | 27,936 | 6/15/2021 | |
10.2.0-beta.2 | 773 | 5/5/2021 | |
10.2.0-beta.1 | 358 | 4/12/2021 | |
10.1.4 | 19,785 | 5/12/2021 | |
10.1.3 | 22,478 | 4/29/2021 | |
10.1.2 | 29,631 | 3/19/2021 | |
10.1.1 | 22,617 | 2/25/2021 | |
10.1.0 | 14,989 | 2/9/2021 | |
10.0.1 | 7,441 | 2/2/2021 | |
10.0.0-beta.6 | 439 | 1/26/2021 | |
10.0.0-beta.5 | 645 | 1/19/2021 | |
10.0.0-beta.3 | 1,162 | 12/10/2020 | |
10.0.0-beta.2 | 1,480 | 11/4/2020 | |
10.0.0-beta.1 | 733 | 10/16/2020 | |
10.0.0-alpha.43 | 367 | 10/9/2020 | |
10.0.0-alpha.34 | 479 | 10/4/2020 | |
5.1.3 | 26,141 | 2/10/2021 | |
5.1.2 | 84,376 | 10/20/2020 | |
5.1.1 | 28,003 | 10/2/2020 | |
5.1.0 | 7,357 | 9/30/2020 | |
5.0.1 | 10,854 | 9/9/2020 | |
4.3.0 | 276,714 | 2/5/2020 | |
4.2.0 | 70,146 | 10/8/2019 | |
4.1.0 | 87,325 | 8/6/2019 | |
4.0.1 | 20,310 | 6/27/2019 | |
4.0.0 | 6,319 | 6/14/2019 | |
3.4.0 | 103,343 | 1/9/2019 | |
3.3.0 | 26,430 | 11/8/2018 | |
3.2.1 | 47,693 | 9/27/2018 | |
3.2.0 | 16,561 | 9/4/2018 | |
3.1.0 | 32,969 | 7/4/2018 | |
3.0.0 | 109,706 | 4/16/2018 | |
2.2.0 | 14,213 | 3/22/2018 | |
2.1.0 | 55,136 | 11/13/2017 | |
2.0.0 | 18,404 | 10/17/2017 | |
2.0.0-rc1 | 2,623 | 10/3/2017 | |
1.6.0 | 35,551 | 8/15/2017 | |
1.5.0 | 18,030 | 6/20/2017 | |
1.4.0 | 14,941 | 5/19/2017 | |
1.3.0 | 3,763 | 5/16/2017 | |
1.2.1 | 8,004 | 5/1/2017 | |
1.2.0 | 5,986 | 4/4/2017 | |
1.1.1 | 7,545 | 3/15/2017 | |
1.1.0 | 3,723 | 3/3/2017 | |
1.0.4 | 4,952 | 2/21/2017 | |
1.0.3 | 17,109 | 2/14/2017 | |
0.82.1 | 18,518 | 1/27/2017 | |
0.82.0 | 3,437 | 1/23/2017 | |
0.81.0 | 5,534 | 12/15/2016 | |
0.80.0 | 11,655 | 10/27/2016 | |
0.78.1 | 20,637 | 9/15/2016 | |
0.78.0 | 2,778 | 9/11/2016 | |
0.77.2 | 5,655 | 8/11/2016 | |
0.77.1 | 3,211 | 7/28/2016 | |
0.76.1 | 6,101 | 6/15/2016 | |
0.76.0 | 3,462 | 6/9/2016 | |
0.75.0 | 3,283 | 6/3/2016 | |
0.74.1 | 5,900 | 5/10/2016 |
## 20.0.0 (2024-09-09)
### Breaking Changes
* Removed all functionality related to App Services/Atlas Device Sync.
### Compatibility
* Realm Studio: 15.0.0 or later.
### Internal
* Using Core 20.0.1.