TableMetadataArgs | /src/metadata-args/TableMetadataArgs.ts | typeorm@v0.2.23-rc10

interface TableMetadataArgs

import { type TableMetadataArgs } from "https://deno.land/x/typeorm@v0.2.23-rc10/src/metadata-args/TableMetadataArgs.ts";

Arguments for TableMetadata class, helps to construct an TableMetadata object.

Properties

target: Function | string

Class to which table is applied. Function target is a table defined in the class. String target is a table defined in a json schema.

optional

name: string

Table's name. If name is not set then table's name will be generated from target's name.

type: TableType

Table type. Tables can be abstract, closure, junction, embedded, etc.

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).

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

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

View expression.

optional

materialized: boolean

Indicates if view is materialized

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.