PowerSync Common/com.powersync

Package-level declarations

Types

DriverBasedInMemoryFactory

open class DriverBasedInMemoryFactory<D : SQLiteDriver>(driver: D) : InMemoryConnectionFactory

ExperimentalPowerSyncAPI

@RequiresOptIn(message = "This API is experimental and not covered by PowerSync semver releases. It can be changed at any time")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])

annotation class ExperimentalPowerSyncAPI

InMemoryConnectionFactory

interface InMemoryConnectionFactory

PersistentConnectionFactory

interface PersistentConnectionFactory : InMemoryConnectionFactory

PowerSyncDatabase

interface PowerSyncDatabase : Queries

A PowerSync managed database.

PowerSyncException

class PowerSyncException(message: String, cause: Throwable?) : Exception

PowerSyncInternal

@RequiresOptIn(message = "This API should not be used outside of PowerSync SDK packages")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])

annotation class PowerSyncInternal

Properties

DEFAULT_DB_FILENAME

const val DEFAULT_DB_FILENAME: String

Functions

appleDefaultDatabasePath

fun appleDefaultDatabasePath(dbFilename: String): String

The default path to use for databases on Apple platforms.

fun extractLib(reference: KClass<*>, fileName: String): String

PowerSyncDatabase

fun PowerSyncDatabase(factory: PersistentConnectionFactory, schema: Schema, dbFilename: String = DEFAULT_DB_FILENAME, scope: CoroutineScope = GlobalScope, logger: Logger? = null, dbDirectory: String? = null): PowerSyncDatabase

Use this to create a PowerSyncDatabase

resolvePowerSyncLoadableExtensionPath

actual fun resolvePowerSyncLoadableExtensionPath(): String?

expect fun resolvePowerSyncLoadableExtensionPath(): String?

Resolves a path to the loadable PowerSync core extension library.

actual fun resolvePowerSyncLoadableExtensionPath(): String?

actual fun resolvePowerSyncLoadableExtensionPath(): String?