SQLiteDriver


public interface SQLiteDriver

Known direct subclasses
AndroidSQLiteDriver

A SQLiteDriver implemented by android.database and that uses the Android's SDK SQLite APIs.

BundledSQLiteDriver

A SQLiteDriver that uses a bundled version of SQLite included as a native component of this library.

NativeSQLiteDriver

A SQLiteDriver that uses a version of SQLite included with the host operating system.

SupportSQLiteDriver

A SQLiteDriver implemented by androidx.sqlite.db.SupportSQLiteOpenHelper and that uses the Android's SQLite through the SupportSQLite APIs.


An interface to open database connections.

Summary

Public methods

default boolean

Identifies whether the driver has an internal connection pool or not.

abstract @NonNull SQLiteConnection
open(@NonNull String fileName)

Opens a new database connection.

Public methods

hasConnectionPool

Added in 2.6.0-alpha01
default boolean hasConnectionPool()

Identifies whether the driver has an internal connection pool or not.

A driver with an internal pool should be capable of opening connections that are safe to be used in a multi-thread and concurrent environment whereas a driver that does not have an internal pool will require the application to manage connections in a thread-safe manner. A driver might not report containing a connection pool but might still be safe to be used in a multi-thread environment, such behavior will depend on the driver implementation.

The value returned should be used as a signal to higher abstractions in order to determine if the driver and its connections should be managed by an external connection pool or not.

open

Added in 2.5.0
abstract @NonNull SQLiteConnection open(@NonNull String fileName)

Opens a new database connection.

To open an in-memory database use the special name :memory: as the fileName.

Parameters
@NonNull String fileName

Name of the database file.

Returns
@NonNull SQLiteConnection

the database connection.