API 参考
    正在准备搜索索引...

    接口 EntitySchemaColumnOptions

    interface EntitySchemaColumnOptions {
        array?: boolean;
        asExpression?: string;
        charset?: string;
        collation?: string;
        columnDefinition?: string;
        comment?: string;
        createDate?: boolean;
        default?: any;
        deleteDate?: boolean;
        enum?: Object | any[];
        enumName?: string;
        generated?: true | "uuid" | "rowid" | "increment";
        generatedType?: "VIRTUAL" | "STORED";
        hstoreType?: "string" | "object";
        insert?: boolean;
        length?: string | number;
        name?: string;
        nullable?: boolean;
        objectId?: boolean;
        onUpdate?: string;
        precision?: number;
        primary?: boolean;
        primaryKeyConstraintName?: string;
        readonly?: boolean;
        scale?: number;
        select?: boolean;
        spatialFeatureType?:
            | "Point"
            | "LineString"
            | "Polygon"
            | "MultiPoint"
            | "MultiLineString"
            | "MultiPolygon"
            | "GeometryCollection";
        srid?: number;
        transformer?: ValueTransformer
        | ValueTransformer[];
        treeChildrenCount?: boolean;
        treeLevel?: boolean;
        type: ColumnType;
        unique?: boolean;
        unsigned?: boolean;
        update?: boolean;
        updateDate?: boolean;
        version?: boolean;
        width?: number;
        zerofill?: boolean;
    }

    层级

    • SpatialColumnOptions
      • EntitySchemaColumnOptions
    索引

    属性

    array?: boolean

    Indicates if this column is an array. Can be simply set to true or array length can be specified. Supported only by postgres.

    asExpression?: string

    Generated column expression.

    charset?: string

    Defines a column character set. Not supported by all database types.

    collation?: string

    Defines a column collation.

    columnDefinition?: string

    Extra column definition. Should be used only in emergency situations. Note that if you'll use this property auto schema generation will not work properly anymore. Avoid using it.

    comment?: string

    Column comment.

    createDate?: boolean

    Indicates if this column is a created date column.

    default?: any

    Default database value.

    deleteDate?: boolean

    Indicates if this column is a delete date column.

    enum?: Object | any[]

    Array of possible enumerated values.

    enumName?: string

    Exact name of enum

    generated?: true | "uuid" | "rowid" | "increment"

    Specifies if this column will use AUTO_INCREMENT or not (e.g. generated number).

    generatedType?: "VIRTUAL" | "STORED"

    Generated column type.

    hstoreType?: "string" | "object"

    Return type of HSTORE column. Returns value as string or as object.

    insert?: boolean

    Indicates if column is inserted by default. Default value is "true".

    length?: string | number

    Column type's length. For example type = "string" and length = 100 means that ORM will create a column with type varchar(100).

    name?: string

    Column name in the database.

    nullable?: boolean

    Indicates if column's value can be set to NULL.

    objectId?: boolean

    Indicates if this column is of type ObjectId

    onUpdate?: string

    ON UPDATE trigger. Works only for MySQL.

    precision?: number

    The precision for a decimal (exact numeric) column (applies only for decimal column), which is the maximum number of digits that are stored for the values.

    primary?: boolean

    Indicates if this column is a primary column.

    primaryKeyConstraintName?: string

    Name of the primary key constraint.

    readonly?: boolean

    Indicates if column value is not updated by "save" operation. It means you'll be able to write this value only when you first time insert the object. Default value is "false".

    Please use the update option instead. Careful, it takes the opposite value to readonly.

    scale?: number

    The scale for a decimal (exact numeric) column (applies only for decimal column), which represents the number of digits to the right of the decimal point and must not be greater than precision.

    select?: boolean

    Indicates if column is always selected by QueryBuilder and find operations. Default value is "true".

    spatialFeatureType?:
        | "Point"
        | "LineString"
        | "Polygon"
        | "MultiPoint"
        | "MultiLineString"
        | "MultiPolygon"
        | "GeometryCollection"

    Column type's feature type. Geometry, Point, Polygon, etc.

    srid?: number

    Column type's SRID. Spatial Reference ID or EPSG code.

    Specifies a value transformer that is to be used to (un)marshal this column when reading or writing to the database.

    treeChildrenCount?: boolean

    Indicates if this column is a treeChildrenCount column.

    treeLevel?: boolean

    Indicates if this column is a treeLevel column.

    Column type. Must be one of the value from the ColumnTypes class.

    unique?: boolean

    Specifies if column's value must be unique or not.

    unsigned?: boolean

    Puts UNSIGNED attribute on to numeric column. Works only for MySQL.

    update?: boolean

    Indicates if column value is updated by "save" operation. If false you'll be able to write this value only when you first time insert the object. Default value is "true".

    updateDate?: boolean

    Indicates if this column is an update date column.

    version?: boolean

    Indicates if this column is a version column.

    width?: number

    Column type's display width. Used only on some column types in MySQL. For example, INT(4) specifies an INT with a display width of four digits.

    zerofill?: boolean

    Puts ZEROFILL attribute on to numeric column. Works only for MySQL. If you specify ZEROFILL for a numeric column, MySQL automatically adds the UNSIGNED attribute to the column