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

• Table

Constructors

Constructor

new ResolvedTable(options): ResolvedTable;

Parameters

Parameter	Type
options	ResolvedTableOptions

Returns

ResolvedTable

Properties

Property	Modifier	Type
options	readonly	ResolvedTableOptions

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(): string | undefined;

Returns

string | undefined

Methods

toJSON()

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

Returns

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

Name	Type	Default value
columns	{ name: string; type: ColumnType | undefined; }[]	-
ignore_empty_update	boolean | undefined	options.ignoreEmptyUpdates
include_metadata	boolean | undefined	options.trackMetadata
include_old	any	-
include_old_only_when_changed	boolean	-
indexes	{ columns: { ascending: boolean | undefined; name: string; type: ColumnType; }[]; name: string; }[]	-
insert_only	boolean | undefined	options.insertOnly
local_only	boolean | undefined	options.localOnly
name	string	-
view_name	string	-

---

validate()

validate(): void;

Returns

void