Table<Columns>

A table with a statically-typed Columns record structure.

This is the recommended way to declare tables in PowerSync schemas.

Extends

• ResolvedTable

Extended by

• AttachmentTable

Type Parameters

Type Parameter	Default type
Columns extends ColumnsType	ColumnsType

Constructors

Constructor

new Table<Columns>(columns, options?): Table<Columns>;

Creates a new Table instance.

Parameters

Parameter	Type	Description
columns	Columns	A Columns object (a record of column names to column types).
options?	TableOptions	Optional configuration options for the table.

Returns

Table<Columns>

Example

const table = new Table(
  {
    name: column.text,
    age: column.integer
  },
  { indexes: { nameIndex: ['name'] } }
);

Overrides

ResolvedTable.constructor

Properties

Property	Modifier	Type	Inherited from
options	readonly	ResolvedTableOptions	ResolvedTable.options

Accessors

columns

Get Signature

get columns(): Column[];

Returns

Column[]

Inherited from

ResolvedTable.columns

---

ignoreEmptyUpdates

Get Signature

get ignoreEmptyUpdates(): boolean;

Returns

boolean

Inherited from

ResolvedTable.ignoreEmptyUpdates

---

indexes

Get Signature

get indexes(): Index[];

Returns

Index[]

Inherited from

ResolvedTable.indexes

---

insertOnly

Get Signature

get insertOnly(): boolean;

Returns

boolean

Inherited from

ResolvedTable.insertOnly

---

internalName

Get Signature

get internalName(): string;

Returns

string

Inherited from

ResolvedTable.internalName

---

localOnly

Get Signature

get localOnly(): boolean;

Returns

boolean

Inherited from

ResolvedTable.localOnly

---

name

Get Signature

get name(): string;

Returns

string

Inherited from

ResolvedTable.name

---

trackMetadata

Get Signature

get trackMetadata(): boolean;

Returns

boolean

Inherited from

ResolvedTable.trackMetadata

---

trackPrevious

Get Signature

get trackPrevious(): 
  | boolean
  | TrackPreviousOptions;

Returns

| boolean | TrackPreviousOptions

Inherited from

ResolvedTable.trackPrevious

---

validName

Get Signature

get validName(): boolean;

Returns

boolean

Inherited from

ResolvedTable.validName

---

viewName

Get Signature

get viewName(): string;

Returns

string

Inherited from

ResolvedTable.viewName

---

viewNameOverride

Get Signature

get viewNameOverride(): string | undefined;

Returns

string | undefined

Inherited from

ResolvedTable.viewNameOverride

Methods

copyWithName()

copyWithName(name): ResolvedTable;

Parameters

Parameter	Type
name	string

Returns

ResolvedTable

---

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	-

Inherited from

ResolvedTable.toJSON

---

validate()

validate(): void;

Returns

void

Inherited from

ResolvedTable.validate

---

createInsertOnly()

static createInsertOnly<Columns>(columns, options?): Table<Columns>;

Type Parameters

Type Parameter	Default type
Columns extends ColumnsType	ColumnsType

Parameters

Parameter	Type
columns	Columns
options?	TableOptions

Returns

Table<Columns>

---

createLocalOnly()

static createLocalOnly<Columns>(columns, options?): Table<Columns>;

Type Parameters

Type Parameter	Default type
Columns extends ColumnsType	ColumnsType

Parameters

Parameter	Type
columns	Columns
options?	TableOptions

Returns

Table<Columns>