Skip to main content

ResolvedTable

A resolved table in the PowerSync schema, with all columns, index definitions and options.

When constructing tables for your schema, consider using Table instead.

Extended by

Constructors

new ResolvedTable()

new ResolvedTable(options): ResolvedTable

Parameters

ParameterType
optionsResolvedTableOptions

Returns

ResolvedTable

Properties

PropertyModifierType
optionsreadonlyResolvedTableOptions

Accessors

columns

Get Signature

get columns(): Column[]
Returns

Column[]


ignoreEmptyUpdates

Get Signature

get ignoreEmptyUpdates(): boolean
Returns

boolean


indexes

Get Signature

get indexes(): Index[]
Returns

Index[]


insertOnly

Get Signature

get insertOnly(): boolean
Returns

boolean


internalName

Get Signature

get internalName(): string
Returns

string


localOnly

Get Signature

get localOnly(): boolean
Returns

boolean


name

Get Signature

get name(): string
Returns

string


trackMetadata

Get Signature

get trackMetadata(): boolean
Returns

boolean


trackPrevious

Get Signature

get trackPrevious(): boolean | TrackPreviousOptions
Returns

boolean | TrackPreviousOptions


validName

Get Signature

get validName(): boolean
Returns

boolean


viewName

Get Signature

get viewName(): string
Returns

string


viewNameOverride

Get Signature

get viewNameOverride(): undefined | string
Returns

undefined | string

Methods

toJSON()

toJSON(): {
columns: {
name: string;
type: undefined | ColumnType;
}[];
ignore_empty_update: undefined | boolean;
include_metadata: undefined | boolean;
include_old: any;
include_old_only_when_changed: boolean;
indexes: {
columns: {
ascending: undefined | boolean;
name: string;
type: ColumnType;
}[];
name: string;
}[];
insert_only: undefined | boolean;
local_only: undefined | boolean;
name: string;
view_name: string;
}

Returns

{
columns: {
name: string;
type: undefined | ColumnType;
}[];
ignore_empty_update: undefined | boolean;
include_metadata: undefined | boolean;
include_old: any;
include_old_only_when_changed: boolean;
indexes: {
columns: {
ascending: undefined | boolean;
name: string;
type: ColumnType;
}[];
name: string;
}[];
insert_only: undefined | boolean;
local_only: undefined | boolean;
name: string;
view_name: string;
}
NameType
columns{ name: string; type: undefined | ColumnType; }[]
ignore_empty_updateundefined | boolean
include_metadataundefined | boolean
include_oldany
include_old_only_when_changedboolean
indexes{ columns: { ascending: undefined | boolean; name: string; type: ColumnType; }[]; name: string; }[]
insert_onlyundefined | boolean
local_onlyundefined | boolean
namestring
view_namestring

validate()

validate(): void

Returns

void