MarcTron.Sqlite 1.3.1

dotnet add package MarcTron.Sqlite --version 1.3.1                
NuGet\Install-Package MarcTron.Sqlite -Version 1.3.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<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                
#r "nuget: MarcTron.Sqlite, 1.3.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. 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                

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/

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 Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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 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 was computed.  monoandroid90 is compatible. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap10.0.17763 is compatible. 
Xamarin.iOS xamarinios was computed.  xamarinios10 is compatible. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
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,436 7/11/2020
1.2.0 979 6/22/2019
1.1.1 742 3/19/2019
1.1.0 607 2/26/2019
1.0.1 1,338 3/28/2018
1.0.0 961 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