Dołączanie SQLite do Aplikacji Windows 8

SQLite

Baza danych w poważniejszych aplikacjach na Windows 8 to podstawa – niezależnie, czy budujemy małą aplikację do zapisywania obrazków czy dużą aplikacje działającą z Windows Azure, gdzie relacje między danymi to podstawa albo potrzebny nam Caching danych.

SQLite

Ponieważ nie ma komponentów baz danych SQL CE, które można by dołączyć do naszych projektów w środowisku Windows Runtime, Microsoft wraz z ludźmi z SQLite przygotował nam alternatywę w postaci tego bardzo ciekawego i szybkiego systemu bazy danych. Napisany jest on w natywnym C++, skompilowany do środowiska WinRT i działa z każdą architekturą na którą programujemy. Ponieważ nie jest to zarządzany kod (Managed Code) to niestety musimy przygotowywać oddzielne paczki aplikacji – x86, x64 oraz ARM – na szczęście na tym nasz udział w kompilowaniu się kończy, ponieważ kompilator sam wybierze automatycznie wymaganą architekturę bazy danych (plik dll w wersjach x86, x64, ARM) i dołączy ją do paczki.

 

 Instalacja paczki SQLite dla Windows Runtime

 

Pierwszą rzeczą, którą należy uczynić jest w ogóle ściągnięcie paczki z bazą danych. Można to zrobić z poziomu Visual Studio (we wszystkich edycjach). Z menu Tools (Narzędzia) wybieramy Extensions and Updates (Rozszerzenia i Aktualizacje), następnie wybieramy sekcję Online (po lewej stronie) i wpisujemy w wyszukiwarce w prawym górnym rogu “sqlite”. Wtedy ukaże się nam paczka: SQLite for Windows Runtime

Extensions and Updates - Wybór paczki SQLite dla WinRT

Klikamy Download (Pobierz) i instalujemy ściągnięty plik. Po zainstalowaniu należy zrestartować Visual Studio o czym poinformuje program.

 

Używanie SQLite w projektach XAML/C# (VB)

 

Kiedy mamy już paczkę SQLite dla Windows Runtime, możemy jej użyć. W aplikacjach C#/VB należy poczynić parę kroków:

  1. Stwórz aplikację (np. pusta Aplikacja)
  2. Wywołaj opcję Add Reference (czyli dodaj referencje)
  3. Dodajemy Rozszerzenie (nie czyste dll) z kategorii Windows/Extensions SQLite for Windows Runtime wraz z C++ Runtime Package

    Dodajemy Paczkę SQLite wraz z C++ do referencji

Ponieważ biblioteka ta jest napisana w języku C++, najwygodniej jest ściągnąć tzw. wrapper, czyli zbiór klas/funkcji pomocniczych, które napisane są w C#/VB a wywołują funkcje C++. Najłatwiejszą biblioteką do wykorzystania w projektach jest sqlite-net jest ona skompilowana w języku C# i dostępna poprzez menager NuGet. Programiści VB niestety muszą sami skompilować tę bibliotekę i dodać ją do referencji projektu.

Aby pobrać do projektu bibliotekę sqlite-net:

  1. Przy włączonym projekcie, włączamy Package Manager Console (konsola menagera projektów) w Visual Studio
  2. Wpisujemy komendę: Install-Package sqlite-net

 Instalacja SQLite-net

 Po tej komendzie automatycznie powinny nam pojawić się 2 pliki: SQLiteAsync.cs oraz SQLite.cs.

Biblioteka ta pozwala na używanie składni jak w LINQ2SQL, gdzie encje w bazie danych można reprezentować za pomocą typów.

[csharp]
public sealed partial class MainPage : Page
{
public MainPage()
{
this.InitializeComponent();
LoadData();
}

public void LoadData()
{
var dbPath = Path.Combine(Windows.Storage.ApplicationData.Current.LocalFolder.Path, “db.sqlite”);
using (var db = new SQLite.SQLiteConnection(dbPath))
{
db.CreateTable();

db.RunInTransaction(() =>
{
db.Insert(new Person() { FirstName = “Tim”, LastName = “Heuer” });
db.Insert(new Person() { FirstName = “Michał”, LastName = “Walczak” });
});
}
}
}

public class Person
{
[SQLite.AutoIncrement, SQLite.PrimaryKey]
public int ID { get; set; }
public string FirstName { get; set; }
public string LastName { get; set; }
}
[/csharp]

Teraz jedynie należy wybrać architekturę aplikacji (x86, x64, ARM) – nie można zostawić AnyCPU. Pamiętajcie, że przygotowując paczkę do certyfikacji zawsze ustawiajcie je na “Release” w przeciwnym wypadku aplikacja nie przejdzie certyfikacji.

 

 Używanie SQLite w projektach XAML/C++

 

Deweloperzy piszący w C++ muszą zainstalować paczkę i dodać ją do referencji. W projektach C++ nie ma czegoś takiego jak menu “Dodaj referencję”  – trzeba manualnie wybrać References (Referencje), wtedy dopiero przycisk Add Reference (Dodaj Referencję) pojawia się. Aby zacząć korzystać z SQLite należy dodać include w pliku gdzie wykorzystujemy bazę: #include <sqlite3.h>

Nie trzeba korzystać z wraperów, ponieważ cała baza napisana jest w C++ i odnosimy się jedynie do czystych funkcji C++.

 

 Używanie SQLite w projektach HTML5/Javascript

 

Aby korzystać z paczki SQLite w projektach Javascript należy podążać takimi samymi krokami jak w przypadku XAML/C#. Należy dodać referencje do rozszerzenia SQLite oraz C++ runtime. Aby korzystać z tej biblioteki należy pobrać odpowiedni wrapper. Zalecanym wrapperem jest SQLite3-WinRT. Wystarczy ściągnąć paczkę i dodać pliki do swojego projektu. Przykład kodu:

[javascript]
var dbPath = Windows.Storage.ApplicationData.current.localFolder.path + ‘\\db.sqlite’;
SQLite3JS.openAsync(dbPath)
.then(function (db) {
return db.runAsync(‘CREATE TABLE Item (name TEXT, price REAL, id INT PRIMARY KEY)’);
})
.then(function (db) {
return db.runAsync(‘INSERT INTO Item (name, price, id) VALUES (?, ?, ?)’, [‘Mango’, 4.6, 123]);
})
.then(function (db) {
return db.eachAsync(‘SELECT * FROM Item’, function (row) {
console.log(‘Get a ‘ + row.name + ‘ for $’ + row.price);
});
})
.then(function (db) {
db.close();
});
[/javascript]

Podsumowanie

 

SQLite to bardzo prosta w obsłudze, lecz zaawansowana baza danych – napisana jest w C++, działa na plikach lokalnych. Mam nadzieję, że artykuł ten przetłumaczony  na język Polski (oryginał Tim Heuer) przybliży wam instalację i używanie bazy. W przyszłości umieszczę przykłady projektów z insertami, deletami, zasileniem źródeł danych. Jeżeli zauważycie jakiś błąd, piszcie w komentarzach 🙂

 

Uwaga! Testowane wersje SQLite (wraz z 3.7.13) posiadają dosyć irytujący błąd. Ponieważ SQLite wykorzystuje do zapisu przestrzeń lokalną (Local Storage), to korzysta ze ścieżki bezpośredniej (C:/Users/…/KatalogZDanymiAplikacji ). Jeżeli wasza nazwa użytkownika zawiera polskie litery lub litery z rozszerzonej tablicy ASCII jest bardzo prawdopodobne, że SQLite nie będzie w stanie stworzyć pliku bazy danych, ponieważ nie obsługuje w ścieżkach takich znaków. Jedynym obejściem tymczasowym jest stworzenie w Windows 8 konta lokalnego nie zawierającego w nazwie polskich znaków

 

Artykuł przetłumaczony według licencji autora.
Źródło: http://timheuer.com/blog/archive/2012/08/07/updated-how-to-using-sqlite-from-windows-store-apps.aspx

Baza danych w Windows Phone 7

W najnowszej wersji WP7 Mango została udostępniona obsługa natywnej bazy danych opartej na silniku SQL CE. W tym wpisie przedstawie prostą bazę do obsługi aplikacji, która nadzoruje spalanie naszego samochodu. Przykład ten jest oparty na przykładowej aplikacji ToDo z sampli dotyczących WP 7.5. Baza ta będzie przydatna w następnym wpisie dotyczącym Data Bindning.

Nie jest to materiał “szkoleniowy”, jedynie baza pod nastpęny wpis, być może w przyszłości przerobię ten wpis tak, aby wszystko było wyjasnione.

(Szerzej na ten temat: Windows Phone 7 : Using Local Database for Application)

Najpierw tworzymy naszą tabelę, przechowującą dane. Należy okerślić wszystkie kolumny – ich nazwy, typ i dodatkowe parametry

[csharp]

 

public class ToDoDataContext : DataContext
{
// Pass the connection string to the base class.
public ToDoDataContext(string connectionString)
: base(connectionString)
{ }

// Specify a table for the items.
public Table<Entries> Items;

}

 

[/csharp]

Entries będzie naszą Tabelą danych.

[csharp]

[Table]
public class Entries : INotifyPropertyChanged, INotifyPropertyChanging
{

// Define ID: private field, public property, and database column.
private int _EntriesId;

[Column(IsPrimaryKey = true, IsDbGenerated = true, DbType = “INT NOT NULL Identity”, CanBeNull = false, AutoSync = AutoSync.OnInsert)]
public int EntriesId
{
get { return _EntriesId; }
set
{
if (_EntriesId != value)
{
NotifyPropertyChanging(“EntriesId”);
_EntriesId = value;
NotifyPropertyChanged(“EntriesId”);
}
}
}

// Data tankowania
private DateTime _itemDate;

[Column]
public DateTime ItemDate
{
get { return _itemDate.Date; }
set
{
if (_itemDate != value)
{
NotifyPropertyChanging(“ItemDate”);
_itemDate = value;
NotifyPropertyChanged(“ItemDate”);
}
}
}

// Odleglosc przejechana
private double _itemDist;

[Column]
public double ItemDist
{
get { return _itemDist; }
set
{
if (_itemDist != value)
{
NotifyPropertyChanging(“ItemDist”);
_itemDist = value;
NotifyPropertyChanged(“ItemDist”);
}
}
}

// Ile zatankowano
private double _itemRefuel;

[Column]
public double ItemRefuel
{
get { return _itemRefuel; }
set
{
if (_itemRefuel != value)
{
NotifyPropertyChanging(“ItemRefuel”);
_itemRefuel = value;
NotifyPropertyChanged(“ItemRefuel”);
}
}
}

// Cena paliwa za jednostke
private double _itemFPrice;

[Column]
public double ItemFPrice
{
get { return _itemFPrice; }
set
{
if (_itemFPrice != value)
{
NotifyPropertyChanging(“ItemFPrice”);
_itemFPrice = value;
NotifyPropertyChanged(“ItemFPrice”);
}
}
}

// Komentarz
private string _itemComment;

[Column]
public string ItemComment
{
get { return _itemComment; }
set
{
if (_itemComment != value)
{
NotifyPropertyChanging(“ItemComment”);
_itemComment = value;
NotifyPropertyChanged(“ItemComment”);
}
}
}

// Spalanie
private double _itemFuelMill;

[Column]
public double ItemFuelMill
{
get { return _itemFuelMill; }
set
{
if (_itemFuelMill != value)
{
NotifyPropertyChanging(“ItemFuelMill”);
_itemFuelMill = value;
NotifyPropertyChanged(“ItemFuelMill”);
}
}
}

 

// Version column aids update performance.
[Column(IsVersion = true)]
private Binary _version;

#region INotifyPropertyChanged Members

public event PropertyChangedEventHandler PropertyChanged;

// Used to notify that a property changed
private void NotifyPropertyChanged(string propertyName)
{
if (PropertyChanged != null)
{
PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
}
}

#endregion

#region INotifyPropertyChanging Members

public event PropertyChangingEventHandler PropertyChanging;

// Used to notify that a property is about to change
private void NotifyPropertyChanging(string propertyName)
{
if (PropertyChanging != null)
{
PropertyChanging(this, new PropertyChangingEventArgs(propertyName));
}
}

#endregion
}

[/csharp]

Kiedy mamy już gotową bazę danych, tworzymy Model, który będzie obsługiwał dane, i zwracał je nam do mechanizmu Data Binding

[csharp]

public class ToDoViewModel : INotifyPropertyChanged
{
// LINQ to SQL data context for the local database.
private ToDoDataContext toDoDB;

// Class constructor, create the data context object.
public ToDoViewModel(string toDoDBConnectionString)
{
toDoDB = new ToDoDataContext(toDoDBConnectionString);
}

// All entries.
private ObservableCollection<Entries> _allEntriess;
public ObservableCollection<Entries> AllEntriess
{
get { return _allEntriess; }
set
{
_allEntriess = value;
NotifyPropertyChanged(“AllEntriess”);
}
}
public ObservableCollection<Entries> AllEntriessASC // Loads only once for chart
{
get
{
var EntriessInDB = from Entries entry in toDoDB.Items
orderby entry.ItemDate ascending
select entry;
ObservableCollection<Entries>  _allEntriessASC = new ObservableCollection<Entries>(EntriessInDB);
return _allEntriessASC;
}
}

 

// Query database and load the collections and list used by the pivot pages.
public void LoadCollectionsFromDatabase()
{

// Specify the query for all to-do items in the database.
var EntriessInDB = from Entries entry in toDoDB.Items
orderby entry.ItemDate descending
select entry;

// Query the database and load all to-do items.
AllEntriess = new ObservableCollection<Entries>(EntriessInDB);
}

 

// Add a to-do item to the database and collections.
public void AddEntries(Entries newEntries)
{
// Fuel Millage Logic
newEntries.ItemFuelMill = (newEntries.ItemRefuel / newEntries.ItemDist) * 100;

// Add a to-do item to the data context.
toDoDB.Items.InsertOnSubmit(newEntries);

// Save changes to the database.
toDoDB.SubmitChanges();

// Add a to-do item to the “all” observable collection.
AllEntriess.Insert(0,newEntries);

}

// Remove a to-do task item from the database and collections.
public void DeleteEntries(Entries toDoForDelete)
{

// Remove the to-do item from the “all” observable collection.
AllEntriess.Remove(toDoForDelete);
// Remove the to-do item from the data context.
toDoDB.Items.DeleteOnSubmit(toDoForDelete);

// Save changes to the database.
toDoDB.SubmitChanges();
}

 

// Write changes in the data context to the database.
public void SaveChangesToDB()
{
toDoDB.SubmitChanges();
}

#region INotifyPropertyChanged Members

public event PropertyChangedEventHandler PropertyChanged;

// Used to notify Silverlight that a property has changed.
private void NotifyPropertyChanged(string propertyName)
{
if (PropertyChanged != null)
{
PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
}
}
#endregion
}

[/csharp]

 

Teraz kiedy mamy już przygotowane dane, najłatwiej jest zrobić sobie do nich referencję w pliku App.xaml.cs. Musimy również wskazać gdzie ma być przechowywana nasza baza danych. WP 7.5 wykorzystujemy mechanizm isolated storage. Warto dodać, że cały mechanizm, który tu opisujemy działa na silniku SQL CE, dostępnym dopiero w WP 7.5

 

[csharp]

private static ToDoViewModel viewModel;
public static ToDoViewModel ViewModel
{
get { return viewModel; }
}

 

public App()
{
// Global handler for uncaught exceptions.
UnhandledException += Application_UnhandledException;

// Standard Silverlight initialization
InitializeComponent();

// Phone-specific initialization
InitializePhoneApplication();

// Show graphics profiling information while debugging.
if (System.Diagnostics.Debugger.IsAttached)
{
PhoneApplicationService.Current.UserIdleDetectionMode = IdleDetectionMode.Disabled;
}

// Specify the local database connection string.
string DBConnectionString = “Data Source=isostore:/entries.sdf”;

// Create the database if it does not exist.
using (ToDoDataContext db = new ToDoDataContext(DBConnectionString))
{
if (db.DatabaseExists() == false)
{
// Create the local database.
db.CreateDatabase();

// Save categories to the database.
db.SubmitChanges();
}
}

// Create the ViewModel object.
viewModel = new ToDoViewModel(DBConnectionString);

// Query the local database and load observable collections.
viewModel.LoadCollectionsFromDatabase();

}

[/csharp]

Teraz nasza aplikacja ma pełny dostęp do danych. Całkiem sporo kodu jak na obsługę bazy danych, czyż nie? Jednak cała ta “nadmiarowość” bardzo szybko ukaże wszelkie zalety tego systemu. o Tym w następnym wpisie.