Interface: EntityBuilder

Defined in: packages/ir/src/builder.ts:107

Methods

additionalProperties()

additionalProperties(def): this;

Defined in: packages/ir/src/builder.ts:109

Parameters

Parameter	Type
def	(value) => void

Returns

this

---

dbName()

dbName(name): this;

Defined in: packages/ir/src/builder.ts:120

Parameters

Parameter	Type
name	string

Returns

this

---

doc()

doc(text): this;

Defined in: packages/ir/src/builder.ts:119

Parameters

Parameter	Type
text	string

Returns

this

---

field()

field(name, def): this;

Defined in: packages/ir/src/builder.ts:108

Parameters

Parameter	Type
name	string
def	(f) => void

Returns

this

---

index()

index(fields, opts?): this;

Defined in: packages/ir/src/builder.ts:113

Parameters

Parameter	Type
fields	string[]
opts?	{ name?: string; type?: "btree" | "hash" | "gin" | "gist" | "brin" | "spgist"; }
opts.name?	string
opts.type?	"btree" | "hash" | "gin" | "gist" | "brin" | "spgist"

Returns

this

---

indexExpression()

indexExpression(expression, opts?): this;

Defined in: packages/ir/src/builder.ts:114

Parameters

Parameter	Type
expression	string
opts?	{ name?: string; type?: "btree" | "hash" | "gin" | "gist" | "brin" | "spgist"; }
opts.name?	string
opts.type?	"btree" | "hash" | "gin" | "gist" | "brin" | "spgist"

Returns

this

---

localEnum()

localEnum(name, def): this;

Defined in: packages/ir/src/builder.ts:111

Parameters

Parameter	Type
name	string
def	(e) => void

Returns

this

---

primaryKey()

primaryKey(...fields): this;

Defined in: packages/ir/src/builder.ts:112

Parameters

Parameter	Type
...fields	string[]

Returns

this

---

relation()

relation(name, def): this;

Defined in: packages/ir/src/builder.ts:110

Parameters

Parameter	Type
name	string
def	(r) => void

Returns

this

---

unique()

unique(fields, opts?): this;

Defined in: packages/ir/src/builder.ts:118

Parameters

Parameter	Type
fields	string[]
opts?	{ name?: string; }
opts.name?	string

Returns

this