core-database/org.meshtastic.core.database

Package-level declarations

Types

AutoMigration12to13

class AutoMigration12to13 : AutoMigrationSpec

AutoMigration29to30

class AutoMigration29to30 : AutoMigrationSpec

AutoMigration33to34

class AutoMigration33to34 : AutoMigrationSpec

AutoMigration34to35

class AutoMigration34to35 : AutoMigrationSpec

AutoMigration42to43

class AutoMigration42to43 : AutoMigrationSpec

Device links moved from the bundled urls.json to the resolved API; original_url is no longer stored.

class Converters

DatabaseConstants

object DatabaseConstants

DatabaseManager

open class DatabaseManager(datastore: DataStore<Preferences>, dispatchers: CoroutineDispatchers) : DatabaseProvider, DatabaseManager

Manages per-device Room database instances for node data, with LRU eviction.

object DatabaseMerger

Folds the contents of one device database (source) into another (dest) when both turn out to belong to the same physical node reached over different transports (BLE / TCP / USB). Called once, by DatabaseManager.associateNode, the first time a secondary transport learns a myNodeNum that another transport already claimed.

DatabaseProvider

interface DatabaseProvider

Provides multiplatform access to the current MeshtasticDatabase and a safe transactional helper. Platform implementations manage the concrete lifecycle (Room on Android, etc.).

MeshtasticDatabase

abstract class MeshtasticDatabase : RoomDatabase

MeshtasticDatabaseConstructor

expect object MeshtasticDatabaseConstructor : RoomDatabaseConstructor<MeshtasticDatabase>

Functions

anonymizeAddress

fun anonymizeAddress(address: String?): String

anonymizeDbName

fun anonymizeDbName(name: String): String

fun buildDbName(address: String?): String

createDatabaseDataStore

actual fun createDatabaseDataStore(name: String): DataStore<Preferences>

Creates an Android DataStore for database preferences.

expect fun createDatabaseDataStore(name: String): DataStore<Preferences>

Creates a platform-specific DataStore for database-related preferences.

actual fun createDatabaseDataStore(name: String): DataStore<Preferences>

Creates a JVM DataStore for database preferences in the data directory.

actual fun deleteDatabase(dbName: String)

Deletes the Android database using the platform-specific deleteDatabase helper.

expect fun deleteDatabase(dbName: String)

Deletes the database with the given dbName and its associated files (e.g., -wal, -shm).

actual fun deleteDatabase(dbName: String)

Deletes the database and its Room-associated files on JVM.

fun desktopDataDir(): String

Resolves the desktop data directory for persistent storage (DataStore files, Room database). Defaults to ~/.meshtastic/. Override via MESHTASTIC_DATA_DIR environment variable.

getDatabaseBuilder

actual fun getDatabaseBuilder(dbName: String): RoomDatabase.Builder<MeshtasticDatabase>

Returns a RoomDatabase.Builder configured for Android with the given dbName.

expect fun getDatabaseBuilder(dbName: String): RoomDatabase.Builder<MeshtasticDatabase>

Returns a RoomDatabase.Builder configured for the current platform with the given dbName.

actual fun getDatabaseBuilder(dbName: String): RoomDatabase.Builder<MeshtasticDatabase>

Returns a RoomDatabase.Builder configured for JVM/Desktop with the given dbName.

getDatabaseDirectory

actual fun getDatabaseDirectory(): Path

Returns the Android directory where database files are stored.

expect fun getDatabaseDirectory(): Path

Returns the platform-specific directory where database files are stored.

actual fun getDatabaseDirectory(): Path

Returns the JVM/Desktop directory where database files are stored.

actual fun getFileSystem(): FileSystem

Returns the system FileSystem for Android.

expect fun getFileSystem(): FileSystem

Returns the FileSystem to use for database file operations.

actual fun getFileSystem(): FileSystem

Returns the system FileSystem for JVM.

getInMemoryDatabaseBuilder

actual fun getInMemoryDatabaseBuilder(): RoomDatabase.Builder<MeshtasticDatabase>

Returns a RoomDatabase.Builder configured for an in-memory Android database.

expect fun getInMemoryDatabaseBuilder(): RoomDatabase.Builder<MeshtasticDatabase>

Returns a RoomDatabase.Builder configured for an in-memory database on the current platform.

actual fun getInMemoryDatabaseBuilder(): RoomDatabase.Builder<MeshtasticDatabase>

Returns a RoomDatabase.Builder configured for an in-memory JVM database.

fun shortSha1(s: String): String