MarcTron.Sqlite 1.3.1

.NET Standard 2.0
Install-Package MarcTron.Sqlite -Version 1.3.1
dotnet add package MarcTron.Sqlite --version 1.3.1
<PackageReference Include="MarcTron.Sqlite" Version="1.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MarcTron.Sqlite --version 1.3.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MarcTron.Sqlite, 1.3.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install MarcTron.Sqlite as a Cake Addin
#addin nuget:?package=MarcTron.Sqlite&version=1.3.1

// Install MarcTron.Sqlite as a Cake Tool
#tool nuget:?package=MarcTron.Sqlite&version=1.3.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

SqlLite Plugin for Xamarin

It is avery intuitive Plugin to use SqlLite on Xamarin. It requires only 1 line of code.

What is this repository for?

You can learn more about SqlLite and this plugin on https://www.xamarinexpert.it/blog/sqlite-made-easy/

LINKS

Available on Nuget: https://www.nuget.org/packages/MarcTron.Sqlite Project website: https://www.xamarinexpert.it/site/Plugin/MTSql Tutorial: https://www.xamarinexpert.it/sqlite-made-easy/ To report any issue: https://bitbucket.org/marcojak81/mtsql

SETUP

Install into your PCL/.NetStandard project and Client projects. The nuget package will automatically install the sqlite-net-pcl package version 1.5.231

HOT TO USE IT

To get the connection to your Sql database you just need to add this line:

SQLiteConnection conn = CrossMtSql.Current.GetConnection("yourdatabasename.db3");

in case you want to use an async connection you can use:

SQLiteAsyncConnection conn CrossMtSql.Current.GetConnectionAsync("yourdatabasename.db3");

From Version 1.2 you can use the MtSqlHelper to make you life with Sql even easier.

Remember to include the MTSql library with this code (usually it's added automatically):

using Plugin.MtSql;

EVEN EASIER WITH MTSQLHELPER

From Version 1.2 I've added an Helper class to make databases even easier.

To initialize your database just use:

CrossMtSql.Helper.Initialize("yourdatabasename.db3");

To add a table to your databse call:

CrossMtSql.Helper.CreateTable<YourTable>();

I've added a Base model for a table called BaseModel. This model alreasy includes a string Primary Key "Id" and the fields CreatedAt, UpdatedAt.

public class BaseModel
{
    [PrimaryKey]
    public string Id { get; set; }
    public DateTime CreatedAt { get; set; }
    public DateTime UpdatedAt { get; set; }
}

I'd suggest you to use this as base class for your models. For example:

public class BetterClass : BaseModel
{
    public string Name { get; set; }
}

CrossMtSql.Helper.CreateTable<BetterClass>();

Doing this you can use the helper method "Save" that will automatically insert or update your item:

CrossMtSql.Helper.Save(new BetterClass() { Name = "Better Test"});

This method will take care to create a Guid for you (if you don't set it) and to update CreatedAt, UpdatedAt. If the guid is not present, the method will insert the item otherwise it will update it.

Other methods present in MtSqlHelper are:

CreateTable<TType>();
Insert<TType>(TType item);
InsertAll<TType>(IEnumerable<TType> items);
Update<TType>(TType item);
FirstOrDefault<TType>(Expression<Func<TType, bool>> expression);
GetFromId<TType>(string itemId);
GetBy<TType>(string parameter, object value);
GetAll<TType>();
Delete<TType>(TType item);
DeleteAll<TType>();
Exists<TType>(string itemId);
Count<TType>();

RELEASE NOTES

Version 1.3 Updated Sqlite to version 1.7.335 Changed Namespace for Xamarin plugin compatibility BREAKING CHANGE: New Namespace so now you should use: Plugin.MtSql.CrossMtSql.Current.GetConnection("yourdb.db3");

Version 1.2 Added MtSqlHelper to make easier to work with databases Added BaseModel as a base model class for database tables.

Version 1.1.1 New method added: GetDatabaseAsStream("yourdatabasename.db3"); This method returns your database file as a Stream. For example you can use it if you want to do a backup of your database.

Version 1.1 This version has been rewritten using multi-targeting. Sqlite-net-pcl updated to version 1.5.231

Supported Platforms

  • Android
  • iOS
  • UWP
  • Windows

CONTACT ME

If you have suggestions or if you would like to see new features added to the plugin, let me know adding an issue on bitbucket or writing a comment on the blog tutorial

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid monoandroid90
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Universal Windows Platform uap10.0.17763
Xamarin.iOS xamarinios xamarinios10
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.3.1 1,090 7/11/2020
1.2.0 756 6/22/2019
1.1.1 551 3/19/2019
1.1.0 430 2/26/2019
1.0.1 1,121 3/28/2018
1.0.0 761 3/2/2018

Version 1.3
       Updated Sqlite to version 1.7.335
       Changed Namespace for Xamarin plugin compatibility

       Version 1.2
   Added MtSqlHelper to make easier to work with databases
   Added BaseModel as a base model class for database tables.

   Version 1.1.1
   New method added: GetDatabaseAsStream("yourdatabasename.db3");
   This method returns your database file as a Stream. For example you can use it if you want to do a backup of your database.

   Version 1.1
   This version has been rewritten using multitargeting.
   Sqlite-net-pcl updated to version 1.5.231