Almacenamiento de datos en una base de datos de SQLite.NET localStore Data in a Local SQLite.NET Database

Descargar ejemplo Descargar el ejemploDownload Sample Download the sample

En este inicio rápido aprenderá a:In this quickstart, you will learn how to:

  • Usar el Administrador de paquetes de NuGet para agregar un paquete NuGet a un proyecto.Use the NuGet Package Manager to add a NuGet package to a project.
  • Almacenar datos de forma local en una base de datos de SQLite.NET.Store data locally in a SQLite.NET database.

En el inicio rápido se le guía sobre cómo almacenar datos en una base de datos de SQLite.NET local.The quickstart walks through how to store data in a local SQLite.NET database. A continuación se muestra la aplicación final:The final application is shown below:

Requisitos previosPrerequisites

Antes de intentar este inicio rápido, debe completar correctamente el inicio rápido anterior.You should successfully complete the previous quickstart before attempting this quickstart. También puede descargar el ejemplo del inicio rápido anterior y usarlo como punto de partida para este.Alternatively, download the previous quickstart sample and use it as the starting point for this quickstart.

Actualizar la aplicación con Visual StudioUpdate the app with Visual Studio

  1. Inicie Visual Studio y abra la solución Notes.Launch Visual Studio and open the Notes solution.

  2. En el Explorador de soluciones, seleccione el proyecto Notes, haga clic con el botón derecho y, después, seleccione Administrar paquetes NuGet… :In Solution Explorer, select the Notes project, right-click and select Manage NuGet Packages...:

  3. En el Administrador de paquetes NuGet, seleccione la pestaña Examinar, busque el paquete NuGet sqlite-net-pcl, selecciónelo y haga clic en el botón Instalar para agregarlo al proyecto:In the NuGet Package Manager, select the Browse tab, search for the sqlite-net-pcl NuGet package, select it, and click the Install button to add it to the project:

    Nota

    Hay varios paquetes NuGet con nombres similares.There are a number of NuGet packages with similar names. El paquete correcto tiene estos atributos:The correct package has these attributes:

    • Autores: Frank A. KruegerAuthor(s): Frank A. Krueger
    • Id.: sqlite-net-pclId: sqlite-net-pcl
    • Vínculo de NuGet: sqlite-net-pclNuGet link: sqlite-net-pcl

    A pesar del nombre del paquete, este paquete NuGet puede usarse en proyectos de .NET Standard.Despite the package name, this NuGet package can be used in .NET Standard projects.

    Este paquete se usará para incorporar operaciones de bases de datos en la aplicación.This package will be used to incorporate database operations into the application.

  4. En el Explorador de soluciones, en el proyecto Notes, abra Note.cs en la carpeta Modelos y reemplace el código existente por el siguiente:In Solution Explorer, in the Notes project, open Note.cs in the Models folder and replace the existing code with the following code:

    using System;
    using SQLite;
    
    namespace Notes.Models
    {
        public class Note
        {
            [PrimaryKey, AutoIncrement]
            public int ID { get; set; }
            public string Text { get; set; }
            public DateTime Date { get; set; }
        }
    }
    

    Esta clase define un modelo Note que almacenará los datos sobre cada nota en la aplicación.This class defines a Note model that will store data about each note in the application. La propiedad ID está marcada con los atributos PrimaryKey y AutoIncrement para garantizar que cada instancia de Note en la base de datos de SQLite.NET tenga un identificador único proporcionado por SQLite.NET.The ID property is marked with PrimaryKey and AutoIncrement attributes to ensure that each Note instance in the SQLite.NET database will have a unique id provided by SQLite.NET.

    Presione CTRL+S para guardar los cambios en Note.cs y cierre el archivo.Save the changes to Note.cs by pressing CTRL+S, and close the file.

    Advertencia

    Si en este momento intenta compilar la aplicación, se producirán errores que se corregirán en pasos posteriores.Attempting to build the application at this point will result in errors that will be fixed in subsequent steps.

  5. En el Explorador de soluciones, agregue una nueva carpeta denominada Datos al proyecto Notes.In Solution Explorer, add a new folder named Data to the Notes project.

  6. En el Explorador de soluciones, en el proyecto Notes, agregue una nueva clase denominada NoteDatabase a la carpeta Datos.In Solution Explorer, in the Notes project, add a new class named NoteDatabase to the Data folder.

  7. En NoteDatabase.cs, reemplace el código existente con el siguiente:In NoteDatabase.cs, replace the existing code with the following code:

    using System.Collections.Generic;
    using System.Threading.Tasks;
    using SQLite;
    using Notes.Models;
    
    namespace Notes.Data
    {
        public class NoteDatabase
        {
            readonly SQLiteAsyncConnection _database;
    
            public NoteDatabase(string dbPath)
            {
                _database = new SQLiteAsyncConnection(dbPath);
                _database.CreateTableAsync<Note>().Wait();
            }
    
            public Task<List<Note>> GetNotesAsync()
            {
                return _database.Table<Note>().ToListAsync();
            }
    
            public Task<Note> GetNoteAsync(int id)
            {
                return _database.Table<Note>()
                                .Where(i => i.ID == id)
                                .FirstOrDefaultAsync();
            }
    
            public Task<int> SaveNoteAsync(Note note)
            {
                if (note.ID != 0)
                {
                    return _database.UpdateAsync(note);
                }
                else
                {
                    return _database.InsertAsync(note);
                }
            }
    
            public Task<int> DeleteNoteAsync(Note note)
            {
                return _database.DeleteAsync(note);
            }
        }
    }
    

    Esta clase contiene código para crear la base de datos, leer datos de ella, escribir datos en ella y eliminarlos.This class contains code to create the database, read data from it, write data to it, and delete data from it. El código usa API asincrónicas de SQLite.NET que mueven las operaciones de base de datos a subprocesos en segundo plano.The code uses asynchronous SQLite.NET APIs that move database operations to background threads. Además, el constructor NoteDatabase toma la ruta de acceso del archivo de base de datos como un argumento.In addition, the NoteDatabase constructor takes the path of the database file as an argument. La clase App proporcionará esta ruta de acceso en el paso siguiente.This path will be provided by the App class in the next step.

    Presione CTRL+S para guardar los cambios en NoteDatabase.cs y cierre el archivo.Save the changes to NoteDatabase.cs by pressing CTRL+S, and close the file.

    Advertencia

    Si en este momento intenta compilar la aplicación, se producirán errores que se corregirán en pasos posteriores.Attempting to build the application at this point will result in errors that will be fixed in subsequent steps.

  8. En el Explorador de soluciones, en el proyecto Notes, haga doble clic en App.xaml.cs para abrirlo.In Solution Explorer, in the Notes project, double-click App.xaml.cs to open it. Después, reemplace el código existente con el siguiente:Then replace the existing code with the following code:

    using System;
    using System.IO;
    using Xamarin.Forms;
    using Notes.Data;
    
    namespace Notes
    {
        public partial class App : Application
        {
            static NoteDatabase database;
    
            public static NoteDatabase Database
            {
                get
                {
                    if (database == null)
                    {
                        database = new NoteDatabase(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "Notes.db3"));
                    }
                    return database;
                }
            }
    
            public App()
            {
                InitializeComponent();
                MainPage = new NavigationPage(new NotesPage());
            }
    
            protected override void OnStart()
            {
                // Handle when your app starts
            }
    
            protected override void OnSleep()
            {
                // Handle when your app sleeps
            }
    
            protected override void OnResume()
            {
                // Handle when your app resumes
            }
        }
    }
    

    Este código define una propiedad Database que crea una instancia de NoteDatabase como singleton, y pasa el nombre de archivo de la base de datos como argumento al constructor NoteDatabase.This code defines a Database property that creates a new NoteDatabase instance as a singleton, passing in the filename of the database as the argument to the NoteDatabase constructor. La ventaja de exponer la base de datos como un singleton es que se crea una conexión de base de datos única que se mantiene abierta mientras la aplicación se ejecuta, lo que evita el gasto de abrir y cerrar el archivo de base de datos cada vez que se realiza una operación de base de datos.The advantage of exposing the database as a singleton is that a single database connection is created that's kept open while the application runs, therefore avoiding the expense of opening and closing the database file each time a database operation is performed.

    Guarde los cambios en App.xaml.cs presionando CTRL+S y cierre el archivo.Save the changes to App.xaml.cs by pressing CTRL+S, and close the file.

    Advertencia

    Si en este momento intenta compilar la aplicación, se producirán errores que se corregirán en pasos posteriores.Attempting to build the application at this point will result in errors that will be fixed in subsequent steps.

  9. En el Explorador de soluciones, en el proyecto Notes, haga doble clic en NotesPage.xaml.cs para abrirlo.In Solution Explorer, in the Notes project, double-click NotesPage.xaml.cs to open it. Después, reemplace el método OnAppearing con el código siguiente:Then replace the OnAppearing method with the following code:

    protected override async void OnAppearing()
    {
        base.OnAppearing();
    
        listView.ItemsSource = await App.Database.GetNotesAsync();
    }
    

    Este código rellena el elemento ListView con todas las notas almacenadas en la base de datos.This code populates the ListView with any notes stored in the database.

    Presione CTRL+S para guardar los cambios en NotesPage.xaml.cs y cierre el archivo.Save the changes to NotesPage.xaml.cs by pressing CTRL+S, and close the file.

    Advertencia

    Si en este momento intenta compilar la aplicación, se producirán errores que se corregirán en pasos posteriores.Attempting to build the application at this point will result in errors that will be fixed in subsequent steps.

  10. En el Explorador de soluciones, haga doble clic en NoteEntryPage.xaml.cs para abrirlo.In Solution Explorer, double-click NoteEntryPage.xaml.cs to open it. Después, reemplace los métodos OnSaveButtonClicked y OnDeleteButtonClicked con el código siguiente:Then replace the OnSaveButtonClicked and OnDeleteButtonClicked methods with the following code:

    async void OnSaveButtonClicked(object sender, EventArgs e)
    {
        var note = (Note)BindingContext;
        note.Date = DateTime.UtcNow;
        await App.Database.SaveNoteAsync(note);
        await Navigation.PopAsync();
    }
    
    async void OnDeleteButtonClicked(object sender, EventArgs e)
    {
        var note = (Note)BindingContext;
        await App.Database.DeleteNoteAsync(note);
        await Navigation.PopAsync();
    }
    

    NoteEntryPage almacena una instancia de Note, que representa una única nota, en el objeto BindingContext de la página.The NoteEntryPage stores a Note instance, which represents a single note, in the BindingContext of the page. Cuando se ejecuta el controlador de eventos OnSaveButtonClicked, la instancia de Note se guarda en la base de datos y la aplicación regresa a la página anterior.When the OnSaveButtonClicked event handler is executed, the Note instance is saved to the database and the application navigates back to the previous page. Cuando se ejecuta el controlador de eventos OnDeleteButtonClicked, la instancia de Note se elimina de la base de datos y la aplicación regresa a la página anterior.When the OnDeleteButtonClicked event handler is executed, the Note instance is deleted from the database and the application navigates back to the previous page.

    Presione CTRL+S para guardar los cambios en NoteEntryPage.xaml.cs y cierre el archivo.Save the changes to NoteEntryPage.xaml.cs by pressing CTRL+S, and close the file.

  11. Compile y ejecute el proyecto en cada plataforma.Build and run the project on each platform. Para más información, vea Compilación del inicio rápido.For more information, see Building the quickstart.

    En NotesPage presione el botón + para ir hasta NoteEntryPage y escriba una nota.On the NotesPage press the + button to navigate to the NoteEntryPage and enter a note. Después de guardar la nota, la aplicación volverá a NotesPage.After saving the note the application will navigate back to the NotesPage.

    Escriba un número de notas, de longitud variable, para observar el comportamiento de la aplicación.Enter a number of notes, of varying length, to observe the application behavior.

Actualizar la aplicación con Visual Studio para MacUpdate the app with Visual Studio for Mac

  1. Inicie Visual Studio para Mac y abra el proyecto Notes.Launch Visual Studio for Mac and open the Notes project.

  2. En el Panel de solución, seleccione el proyecto Notes, haga clic con el botón derecho y seleccione Agregar > Agregar paquetes NuGet... :In the Solution Pad, select the Notes project, right-click and select Add > Add NuGet Packages...:

  3. En la ventana Agregar paquetes, busque el paquete NuGet sqlite-net-pcl, selecciónelo y haga clic en el botón Agregar paquete para agregarlo al proyecto:In the Add Packages window, search for the sqlite-net-pcl NuGet package, select it, and click the Add Package button to add it to the project:

    Nota

    Hay varios paquetes NuGet con nombres similares.There are a number of NuGet packages with similar names. El paquete correcto tiene estos atributos:The correct package has these attributes:

    • Autor: Frank A. KruegerAuthor: Frank A. Krueger
    • Id.: sqlite-net-pclId: sqlite-net-pcl
    • Vínculo de NuGet: sqlite-net-pclNuGet link: sqlite-net-pcl

    A pesar del nombre del paquete, este paquete NuGet puede usarse en proyectos de .NET Standard.Despite the package name, this NuGet package can be used in .NET Standard projects.

    Este paquete se usará para incorporar operaciones de bases de datos en la aplicación.This package will be used to incorporate database operations into the application.

  4. En el Panel de solución, en el proyecto Notes, abra Note.cs en la carpeta Modelos y reemplace el código existente por el siguiente:In the Solution Pad, in the Notes project, open Note.cs in the Models folder and replace the existing code with the following code:

    using System;
    using SQLite;
    
    namespace Notes.Models
    {
        public class Note
        {
            [PrimaryKey, AutoIncrement]
            public int ID { get; set; }
            public string Text { get; set; }
            public DateTime Date { get; set; }
        }
    }
    

    Esta clase define un modelo Note que almacenará los datos sobre cada nota en la aplicación.This class defines a Note model that will store data about each note in the application. La propiedad ID está marcada con los atributos PrimaryKey y AutoIncrement para garantizar que cada instancia de Note en la base de datos de SQLite.NET tenga un identificador único proporcionado por SQLite.NET.The ID property is marked with PrimaryKey and AutoIncrement attributes to ensure that each Note instance in the SQLite.NET database will have a unique id provided by SQLite.NET.

    Para guardar los cambios en Note.cs, seleccione Archivo > Guardar (o bien presione ⌘ + S) y cierre el archivo.Save the changes to Note.cs by choosing File > Save (or by pressing ⌘ + S), and close the file.

    Advertencia

    Si en este momento intenta compilar la aplicación, se producirán errores que se corregirán en pasos posteriores.Attempting to build the application at this point will result in errors that will be fixed in subsequent steps.

  5. En el Panel de solución, agregue una nueva carpeta denominada Datos al proyecto Notes.In the Solution Pad, add a new folder named Data to the Notes project.

  6. En el Panel de solución, en el proyecto Notes, agregue una nueva clase denominada NoteDatabase a la carpeta Datos.In the Solution Pad, in the Notes project, add a new class named NoteDatabase to the Data folder.

  7. En NoteDatabase.cs, reemplace el código existente con el siguiente:In NoteDatabase.cs, replace the existing code with the following code:

    using System.Collections.Generic;
    using System.Threading.Tasks;
    using SQLite;
    using Notes.Models;
    
    namespace Notes.Data
    {
        public class NoteDatabase
        {
            readonly SQLiteAsyncConnection _database;
    
            public NoteDatabase(string dbPath)
            {
                _database = new SQLiteAsyncConnection(dbPath);
                _database.CreateTableAsync<Note>().Wait();
            }
    
            public Task<List<Note>> GetNotesAsync()
            {
                return _database.Table<Note>().ToListAsync();
            }
    
            public Task<Note> GetNoteAsync(int id)
            {
                return _database.Table<Note>()
                                .Where(i => i.ID == id)
                                .FirstOrDefaultAsync();
            }
    
            public Task<int> SaveNoteAsync(Note note)
            {
                if (note.ID != 0)
                {
                    return _database.UpdateAsync(note);
                }
                else
                {
                    return _database.InsertAsync(note);
                }
            }
    
            public Task<int> DeleteNoteAsync(Note note)
            {
                return _database.DeleteAsync(note);
            }
        }
    }
    

    Esta clase contiene código para crear la base de datos, leer datos de ella, escribir datos en ella y eliminarlos.This class contains code to create the database, read data from it, write data to it, and delete data from it. El código usa API asincrónicas de SQLite.NET que mueven las operaciones de base de datos a subprocesos en segundo plano.The code uses asynchronous SQLite.NET APIs that move database operations to background threads. Además, el constructor NoteDatabase toma la ruta de acceso del archivo de base de datos como un argumento.In addition, the NoteDatabase constructor takes the path of the database file as an argument. La clase App proporcionará esta ruta de acceso en el paso siguiente.This path will be provided by the App class in the next step.

    Para guardar los cambios en NoteDatabase.cs, seleccione Archivo > Guardar (o bien presione ⌘ + S) y cierre el archivo.Save the changes to NoteDatabase.cs by choosing File > Save (or by pressing ⌘ + S), and close the file.

    Advertencia

    Si en este momento intenta compilar la aplicación, se producirán errores que se corregirán en pasos posteriores.Attempting to build the application at this point will result in errors that will be fixed in subsequent steps.

  8. En el Panel de solución, en el proyecto Notes, haga doble clic en App.xaml.cs para abrirlo.In the Solution Pad, in the Notes project, double-click App.xaml.cs to open it. Después, reemplace el código existente con el siguiente:Then replace the existing code with the following code:

    using System;
    using System.IO;
    using Xamarin.Forms;
    using Notes.Data;
    
    namespace Notes
    {
        public partial class App : Application
        {
            static NoteDatabase database;
    
            public static NoteDatabase Database
            {
                get
                {
                    if (database == null)
                    {
                        database = new NoteDatabase(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "Notes.db3"));
                    }
                    return database;
                }
            }
    
            public App()
            {
                InitializeComponent();
                MainPage = new NavigationPage(new NotesPage());
            }
    
            protected override void OnStart()
            {
                // Handle when your app starts
            }
    
            protected override void OnSleep()
            {
                // Handle when your app sleeps
            }
    
            protected override void OnResume()
            {
                // Handle when your app resumes
            }
        }
    }
    

    Este código define una propiedad Database que crea una instancia de NoteDatabase como singleton, y pasa el nombre de archivo de la base de datos como argumento al constructor NoteDatabase.This code defines a Database property that creates a new NoteDatabase instance as a singleton, passing in the filename of the database as the argument to the NoteDatabase constructor. La ventaja de exponer la base de datos como un singleton es que se crea una conexión de base de datos única que se mantiene abierta mientras la aplicación se ejecuta, lo que evita el gasto de abrir y cerrar el archivo de base de datos cada vez que se realiza una operación de base de datos.The advantage of exposing the database as a singleton is that a single database connection is created that's kept open while the application runs, therefore avoiding the expense of opening and closing the database file each time a database operation is performed.

    Guarde los cambios en App.xaml.cs eligiendo Archivo > Guardar (o presionando ⌘ + S) y cierre el archivo.Save the changes to App.xaml.cs by choosing File > Save (or by pressing ⌘ + S), and close the file.

    Advertencia

    Si en este momento intenta compilar la aplicación, se producirán errores que se corregirán en pasos posteriores.Attempting to build the application at this point will result in errors that will be fixed in subsequent steps.

  9. En el Panel de solución, en el proyecto Notes, haga doble clic en NotesPage.xaml.cs para abrirlo.In the Solution Pad, in the Notes project, double-click NotesPage.xaml.cs to open it. Después, reemplace el método OnAppearing con el código siguiente:Then replace the OnAppearing method with the following code:

    protected override async void OnAppearing()
    {
        base.OnAppearing();
    
        listView.ItemsSource = await App.Database.GetNotesAsync();
    }
    

    Este código rellena el elemento ListView con todas las notas almacenadas en la base de datos.This code populates the ListView with any notes stored in the database.

    Para guardar los cambios en NotesPage.xaml.cs, seleccione Archivo > Guardar (o bien presione ⌘ + S) y cierre el archivo.Save the changes to NotesPage.xaml.cs by choosing File > Save (or by pressing ⌘ + S), and close the file.

    Advertencia

    Si en este momento intenta compilar la aplicación, se producirán errores que se corregirán en pasos posteriores.Attempting to build the application at this point will result in errors that will be fixed in subsequent steps.

  10. En el Panel de solución, haga doble clic en NoteEntryPage.xaml.cs para abrirlo.In the Solution Pad, double-click NoteEntryPage.xaml.cs to open it. Después, reemplace los métodos OnSaveButtonClicked y OnDeleteButtonClicked con el código siguiente:Then replace the OnSaveButtonClicked and OnDeleteButtonClicked methods with the following code:

    async void OnSaveButtonClicked(object sender, EventArgs e)
    {
        var note = (Note)BindingContext;
        note.Date = DateTime.UtcNow;
        await App.Database.SaveNoteAsync(note);
        await Navigation.PopAsync();
    }
    
    async void OnDeleteButtonClicked(object sender, EventArgs e)
    {
        var note = (Note)BindingContext;
        await App.Database.DeleteNoteAsync(note);
        await Navigation.PopAsync();
    }
    

    NoteEntryPage almacena una instancia de Note, que representa una única nota, en el objeto BindingContext de la página.The NoteEntryPage stores a Note instance, which represents a single note, in the BindingContext of the page. Cuando se ejecuta el controlador de eventos OnSaveButtonClicked, la instancia de Note se guarda en la base de datos y la aplicación regresa a la página anterior.When the OnSaveButtonClicked event handler is executed, the Note instance is saved to the database and the application navigates back to the previous page. Cuando se ejecuta el controlador de eventos OnDeleteButtonClicked, la instancia de Note se elimina de la base de datos y la aplicación regresa a la página anterior.When the OnDeleteButtonClicked event handler is executed, the Note instance is deleted from the database and the application navigates back to the previous page.

    Para guardar los cambios en NoteEntryPage.xaml.cs, seleccione Archivo > Guardar (o bien presione ⌘ + S) y cierre el archivo.Save the changes to NoteEntryPage.xaml.cs by choosing File > Save (or by pressing ⌘ + S), and close the file.

  11. Compile y ejecute el proyecto en cada plataforma.Build and run the project on each platform. Para más información, vea Compilación del inicio rápido.For more information, see Building the quickstart.

    En NotesPage presione el botón + para ir hasta NoteEntryPage y escriba una nota.On the NotesPage press the + button to navigate to the NoteEntryPage and enter a note. Después de guardar la nota, la aplicación volverá a NotesPage.After saving the note the application will navigate back to the NotesPage.

    Escriba un número de notas, de longitud variable, para observar el comportamiento de la aplicación.Enter a number of notes, of varying length, to observe the application behavior.

Pasos siguientesNext steps

En este inicio rápido ha aprendido a:In this quickstart, you learned how to:

  • Usar el Administrador de paquetes de NuGet para agregar un paquete NuGet a un proyecto.Use the NuGet Package Manager to add a NuGet package to a project.
  • Almacenar datos de forma local en una base de datos de SQLite.NET.Store data locally in a SQLite.NET database.

Para aplicar estilo a la aplicación con estilos XAML, continúe con el inicio rápido siguiente.To style the application with XAML styles, continue to the next quickstart.