IndexDeclaration

@webda/sql-schema

---

Interface: IndexDeclaration

Defined in: packages/sql-schema/src/metadata.ts:137

An index declared on a model attribute (@Index / @Unique JSDoc tag), as compiled

Properties

attribute

attribute: string

Defined in: packages/sql-schema/src/metadata.ts:141

Attribute

---

name?

optional name?: string

Defined in: packages/sql-schema/src/metadata.ts:149

Group name (@Index <name>): the tagged attributes sharing it form one composite index

---

unique?

optional unique?: boolean

Defined in: packages/sql-schema/src/metadata.ts:145

@Unique: a unique index