Skip to main content
Module

x/typeorm/src/entity-schema/EntitySchemaOptions.ts>EntitySchemaOptions

Forked from https://github.com/typeorm/typeorm
denolib/typeorm
Latest
class EntitySchemaOptions
import { EntitySchemaOptions } from "https://deno.land/x/typeorm@v0.2.23-rc10/src/entity-schema/EntitySchemaOptions.ts";

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

Properties

optional
checks: EntitySchemaCheckOptions[]

Entity check options.

columns: [P in keyof T]?: EntitySchemaColumnOptions

Entity column's options.

optional
database: string

Database name. Used in MySql and Sql Server.

optional
exclusions: EntitySchemaExclusionOptions[]

Entity exclusion options.

optional
expression: string | ((connection: Connection) => SelectQueryBuilder<any>)

View expression.

optional
extends: string

Name of the schema it extends.

optional
indices: EntitySchemaIndexOptions[]

Entity indices options.

name: string

Entity name.

optional
orderBy: OrderByCondition

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

optional
relations: [P in keyof T]?: EntitySchemaRelationOptions

Entity relation's options.

optional
schema: string

Schema name. Used in Postgres and Sql Server.

optional
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: string

Table name.

optional
target: Function

Target bind to this entity schema. Optional.

optional
type: TableType

Table type.

optional
uniques: EntitySchemaUniqueOptions[]

Entity uniques options.