Skip to main content
Module

x/typeorm/src/index.ts>EntityOptions

Forked from https://github.com/typeorm/typeorm
Latest
interface EntityOptions
Re-export
import { type EntityOptions } from "https://deno.land/x/typeorm@v0.2.23-rc10/src/index.ts";

Describes all entity's options.

Properties

optional
name: string

Table name. If not specified then naming strategy will generate table name from entity name.

optional
orderBy: OrderByCondition | ((object: any) => OrderByCondition | any)

Specifies a default order by used for queries from this table when no explicit order by is specified.

optional
engine: string

Table's database engine type (like "InnoDB", "MyISAM", etc). It is used only during table creation. If you update this value and table is already created, it will not change table's engine type. Note that not all databases support this option.

optional
database: string

Database name. Used in Mysql and Sql Server.

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
withoutRowid: boolean

If set to 'true' this option disables Sqlite's default behaviour of secretly creating an integer primary key column named 'rowid' on table creation.