AttachmentTable

Extends

• Table

Constructors

new AttachmentTable()

new AttachmentTable(options?): AttachmentTable

Parameters

Parameter	Type
options?	AttachmentTableOptions

Returns

AttachmentTable

Overrides

Table.constructor

Accessors

columnMap

Get Signature

get columnMap(): Columns

Returns

Columns

Inherited from

Table.columnMap

---

columns

Get Signature

get columns(): Column[]

Returns

Column[]

Inherited from

Table.columns

---

indexes

Get Signature

get indexes(): Index[]

Returns

Index[]

Inherited from

Table.indexes

---

insertOnly

Get Signature

get insertOnly(): boolean

Returns

boolean

Inherited from

Table.insertOnly

---

internalName

Get Signature

get internalName(): string

Returns

string

Inherited from

Table.internalName

---

localOnly

Get Signature

get localOnly(): boolean

Returns

boolean

Inherited from

Table.localOnly

---

name

Get Signature

get name(): string

Returns

string

Inherited from

Table.name

---

validName

Get Signature

get validName(): boolean

Returns

boolean

Inherited from

Table.validName

---

viewName

Get Signature

get viewName(): string

Returns

string

Inherited from

Table.viewName

---

viewNameOverride

Get Signature

get viewNameOverride(): string

Returns

string

Inherited from

Table.viewNameOverride

Methods

toJSON()

toJSON(): {
  columns: {
     name: string;
     type: ColumnType;
    }[];
  indexes: {
     columns: {
        ascending: boolean;
        name: string;
        type: ColumnType;
       }[];
     name: string;
    }[];
  insert_only: boolean;
  local_only: boolean;
  name: string;
  view_name: string;
}

Returns

{
  columns: {
     name: string;
     type: ColumnType;
    }[];
  indexes: {
     columns: {
        ascending: boolean;
        name: string;
        type: ColumnType;
       }[];
     name: string;
    }[];
  insert_only: boolean;
  local_only: boolean;
  name: string;
  view_name: string;
}

Name	Type
columns	{ name: string; type: ColumnType; }[]
indexes	{ columns: { ascending: boolean; name: string; type: ColumnType; }[]; name: string; }[]
insert_only	boolean
local_only	boolean
name	string
view_name	string

Inherited from

Table.toJSON

---

validate()

validate(): void

Returns

void

Inherited from

Table.validate

---

createInsertOnly()

static createInsertOnly(options): Table

Parameters

Parameter	Type
options	TableOptions

Returns

Table

Inherited from

Table.createInsertOnly

---

createLocalOnly()

static createLocalOnly(options): Table

Parameters

Parameter	Type
options	TableOptions

Returns

Table

Inherited from

Table.createLocalOnly

---

createTable()

static createTable(name, table): Table

Create a table.

Parameters

Parameter	Type
name	string
table	Table

Returns

Table

Deprecated

This was only only included for TableV2 and is no longer necessary. Prefer to use new Table() directly.

TODO remove in the next major release.

Inherited from

Table.createTable