AttachmentTable

Internal

AttachmentTable defines the schema for the attachment queue table.

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

---

ignoreEmptyUpdates

Get Signature

get ignoreEmptyUpdates(): boolean

Returns

boolean

Inherited from

Table.ignoreEmptyUpdates

---

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

---

trackMetadata

Get Signature

get trackMetadata(): boolean

Returns

boolean

Inherited from

Table.trackMetadata

---

trackPrevious

Get Signature

get trackPrevious(): boolean | TrackPreviousOptions

Returns

boolean | TrackPreviousOptions

Inherited from

Table.trackPrevious

---

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

Returns

undefined | string

Inherited from

Table.viewNameOverride

Methods

copyWithName()

copyWithName(name): Table

Parameters

Parameter	Type
name	string

Returns

Table

Inherited from

Table.copyWithName

---

toJSON()

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

Returns

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

Name	Type
columns	{ name: string; type: undefined | ColumnType; }[]
ignore_empty_update	boolean
include_metadata	boolean
include_old	any
include_old_only_when_changed	boolean
indexes	{ columns: { ascending: undefined | 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<ColumnsType>

Parameters

Parameter	Type
options	TableOptions

Returns

Table<ColumnsType>

Inherited from

Table.createInsertOnly

---

createLocalOnly()

static createLocalOnly(options): Table<ColumnsType>

Parameters

Parameter	Type
options	TableOptions

Returns

Table<ColumnsType>

Inherited from

Table.createLocalOnly

---

createTable()

static createTable(name, table): Table<ColumnsType>

Create a table.

Parameters

Parameter	Type
name	string
table	Table

Returns

Table<ColumnsType>

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