MarcTron.Sqlite 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/

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