PowerSync Common/com.powersync.db.schema

Package-level declarations

Types

sealed interface BaseTable

@Serializable

data class Column(val name: String, val type: ColumnType)

A single column in a table schema.

enum ColumnType : Enum<ColumnType>

@Serializable

data class Index(val name: String, val columns: List<IndexedColumn>)

@Serializable

data class IndexedColumn(val column: String, val ascending: Boolean = true, columnDefinition: Column? = null, var type: ColumnType? = null)

Describes an indexed column.

PendingStatement

class PendingStatement(val sql: String, val parameters: List<PendingStatementParameter>)

PendingStatementParameter

sealed interface PendingStatementParameter

A parameter that can be used in a PendingStatement.

@Serializable(with = RawTableSerializer::class)

class RawTable : BaseTable

A table that is managed by the user instead of being auto-created and migrated by the PowerSync SDK.

class RawTableSchema(val tableName: String? = null, val syncedColumns: List<String>? = null, val options: TableOptions = TableOptions())

The schema of a RawTable in the local database.

@Serializable

data class Schema

The schema used by the database.

@Serializable(with = TableSerializer::class)

data class Table(var name: String, var columns: List<Column>, var indexes: List<Index> = listOf(), var options: TableOptions = TableOptions(), viewNameOverride: String? = null) : BaseTable

A single table in the schema.

data class TableOptions(val localOnly: Boolean = false, val insertOnly: Boolean = false, val trackMetadata: Boolean = false, val trackPreviousValues: TrackPreviousValuesOptions? = null, val ignoreEmptyUpdates: Boolean = false)

TrackPreviousValuesOptions

data class TrackPreviousValuesOptions(val columnFilter: List<String>? = null, val onlyWhenChanged: Boolean = false)

Options to include old values in CrudEntry.previousValues for update statements.