Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EntitySchemaOptions<T>

Interface for entity metadata mappings stored inside "schemas" instead of models decorated by decorators.

Type parameters

  • T

Hierarchy

  • EntitySchemaOptions

Index

Properties

Optional checks

Entity check options.

columns

columns: object

Entity column's options.

Type declaration

Optional database

database: string

Database name. Used in MySql and Sql Server.

Optional exclusions

Entity exclusion options.

Optional expression

expression: string | function

View expression.

Optional extends

extends: string

Name of the schema it extends.

Optional indices

Entity indices options.

name

name: string

Entity name.

Optional orderBy

Specifies a property name by which queries will perform ordering by default when fetching rows.

Optional relations

relations: object

Entity relation's options.

Type declaration

Optional schema

schema: string

Schema name. Used in Postgres and Sql Server.

Optional synchronize

synchronize: boolean

Indicates if schema synchronization is enabled or disabled for this entity. If it will be set to false then schema sync will and migrations ignore this entity. By default schema synchronization is enabled for all entities.

Optional tableName

tableName: string

Table name.

Optional target

target: Function

Target bind to this entity schema. Optional.

Optional type

type: TableType

Table type.

Optional uniques

Entity uniques options.

Generated using TypeDoc