PowerSync Core/com.powersync.db.schema/Table

Table

data class Table(var name: String, var columns: List<Column>, var indexes: List<Index> = listOf(), val localOnly: Boolean = false, val insertOnly: Boolean = false, viewNameOverride: String? = null, val trackMetadata: Boolean = false, val trackPreviousValues: TrackPreviousValuesOptions? = null, val ignoreEmptyUpdates: Boolean = false)

A single table in the schema.

Constructors

Table

constructor(name: String, columns: List<Column>, indexes: List<Index> = listOf(), localOnly: Boolean = false, insertOnly: Boolean = false, viewNameOverride: String? = null, trackMetadata: Boolean = false, trackPreviousValues: TrackPreviousValuesOptions? = null, ignoreEmptyUpdates: Boolean = false)

Types

Companion

object Companion

Properties

columns

var columns: List<Column>

List of columns.

ignoreEmptyUpdates

val ignoreEmptyUpdates: Boolean = false

Whether an UPDATE statement that doesn't change any values should be ignored when creating CRUD entries.

indexes

var indexes: List<Index>

List of indexes.

insertOnly

val insertOnly: Boolean = false

Whether this is an insert-only table.

localOnly

val localOnly: Boolean = false

Whether the table only exists locally.

name

var name: String

The synced table name, matching sync rules.

trackMetadata

val trackMetadata: Boolean = false

Whether to add a hidden _metadata column that will be enabled for updates to attach custom information about writes that will be reported through CrudEntry.metadata.

trackPreviousValues

val trackPreviousValues: TrackPreviousValuesOptions? = null

When set to a non-null value, track old values of columns for CrudEntry.previousValue.

validName

val validName: Boolean

Whether this table name is valid.

viewName

val viewName: String

Name for the view, used for queries. Defaults to the synced table name.

Functions

get

operator fun get(columnName: String): Column

validate

fun validate()

Check that there are no issues in the table definition.