SQLite (Kotlin multiplataforma)

A biblioteca androidx.sqlite contém interfaces abstratas com implementações básicas que podem ser usadas para criar bibliotecas que acessam o SQLite. Use a biblioteca Room, que fornece uma camada de abstração sobre o SQLite para permitir um acesso mais robusto ao banco de dados, aproveitando toda a capacidade do SQLite.

Como configurar dependências

A versão atual do androidx.sqlite com suporte ao Kotlin Multi-Platform (KMP) é a 2.5.0-alpha01 ou mais recente.

Para configurar o SQLite no seu projeto KMP, adicione as dependências dos artefatos no arquivo build.gradle.kts do seu módulo:

• androidx.sqlite:sqlite: as interfaces do driver SQLite.
• androidx.sqlite:sqlite-bundled: a implementação do driver empacotado

APIs de driver SQLite

Os grupos de bibliotecas androidx.sqlite oferecem APIs de baixo nível para se comunicar com a biblioteca SQLite, incluídas na biblioteca ao usar androidx.sqlite:sqlite-bundled ou na plataforma de host, como Android ou iOS, ao usar androidx.sqlite:sqlite-framework. As APIs seguem de perto a funcionalidade principal da API SQLite C.

Há três interfaces principais:

• SQLiteDriver: é o ponto de entrada para usar o SQLite e é responsável por abrir conexões de banco de dados.
• SQLiteConnection: é a representação do objeto sqlite3.
• SQLiteStatement: é a representação do objeto sqlite3_stmt.

O exemplo a seguir mostra as principais APIs:

fun main() {
  val databaseConnection = BundledSQLiteDriver().open("todos.db")
  databaseConnection.execSQL(
    "CREATE TABLE IF NOT EXISTS Todo (id INTEGER PRIMARY KEY, content TEXT)"
  )
  databaseConnection.prepare(
    "INSERT OR IGNORE INTO Todo (id, content) VALUES (? ,?)"
  ).use { stmt ->
    stmt.bindInt(index = 1, value = 1)
    stmt.bindText(index = 2, value = "Try Room in the KMP project.")
    stmt.step()
  }
  databaseConnection.prepare("SELECT content FROM Todo").use { stmt ->
    while (stmt.step()) {
      println("Action item: ${stmt.getText(0)}")
    }
  }
  databaseConnection.close()
}

De forma semelhante às APIs SQLite C, o uso comum é:

• Abra uma conexão de banco de dados usando a implementação SQLiteDriver instanciada.
• preparar uma instrução SQL usando SQLiteConnection.prepare();
• Execute um SQLiteStatement:
  • Opcionalmente, argumentos de vinculação usando as funções bind*().
  • Iteração sobre o conjunto de resultados usando a função step().
  • Leitura de colunas do conjunto de resultados usando as funções get*().

Cuidado: as conexões e instruções de banco de dados são recursos que precisam ser gerenciados. Todas as instruções preparadas precisam ser fechadas quando não forem mais necessárias. Da mesma forma, se uma conexão de banco de dados não for mais necessária, ela deverá ser fechada.

Implementações de drivers

A tabela a seguir resume as implementações de driver disponíveis:

Nome da classe	Artefato	Plataformas compatíveis
AndroidSQLiteDriver	androidx.sqlite:sqlite-framework	Android
NativeSQLiteDriver	androidx.sqlite:sqlite-framework	iOS, Mac e Linux
BundledSQLiteDriver	androidx.sqlite:sqlite-bundled	Android, iOS, Mac, Linux e JVM (computador)

A implementação recomendada para uso é BundledSQLiteDriver, disponível em androidx.sqlite:sqlite-bundled. Ela inclui a biblioteca SQLite compilada da fonte, oferecendo a versão mais atualizada e a consistência em todas as plataformas KMP com suporte.

Driver SQLite e Room

As APIs de driver são úteis para interações de baixo nível com um banco de dados SQLite. Para uma biblioteca com muitos recursos que oferece um acesso mais robusto ao SQLite, o Room é o recomendado.

Um RoomDatabase depende de um SQLiteDriver para executar operações de banco de dados, e é necessário configurar uma implementação usando RoomDatabase.Builder.setDriver(). O Room oferece RoomDatabase.useReaderConnection e RoomDatabase.useWriterConnection para um acesso mais direto às conexões de banco de dados gerenciadas.