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

    接口 FindOneOptions<Entity>

    Defines a special criteria to find specific entity.

    interface FindOneOptions<Entity = any> {
        cache?: number | boolean | { id: any; milliseconds: number };
        comment?: string;
        join?: JoinOptions;
        loadEagerRelations?: boolean;
        loadRelationIds?:
            | boolean
            | { disableMixedMap?: boolean; relations?: string[] };
        lock?:
            | { mode: "optimistic"; version: number
            | Date }
            | {
                mode:
                    | "pessimistic_read"
                    | "pessimistic_write"
                    | "dirty_read"
                    | "pessimistic_partial_write"
                    | "pessimistic_write_or_fail"
                    | "for_no_key_update"
                    | "for_key_share";
                onLocked?: "nowait"
                | "skip_locked";
                tables?: string[];
            };
        order?: FindOptionsOrder<Entity>;
        relationLoadStrategy?: "join" | "query";
        relations?: FindOptionsRelations<Entity> | FindOptionsRelationByString;
        select?: FindOptionsSelect<Entity> | FindOptionsSelectByString<Entity>;
        transaction?: boolean;
        where?: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[];
        withDeleted?: boolean;
    }

    类型参数

    • Entity = any

    层级 (查看层级一览)

    索引
    cache? comment? join? loadEagerRelations? loadRelationIds? lock? order? relationLoadStrategy? relations? select? transaction? where? withDeleted?
    cache?: number | boolean | { id: any; milliseconds: number }

    Enables or disables query result caching.

    comment?: string

    Adds a comment with the supplied string in the generated query. This is helpful for debugging purposes, such as finding a specific query in the database server's logs, or for categorization using an APM product.

    join?: JoinOptions

    Specifies what relations should be loaded.

    loadEagerRelations?: boolean

    Indicates if eager relations should be loaded or not. By default, they are loaded when find methods are used.

    loadRelationIds?: boolean | { disableMixedMap?: boolean; relations?: string[] }

    If sets to true then loads all relation ids of the entity and maps them into relation values (not relation objects). If array of strings is given then loads only relation ids of the given properties.

    lock?:
        | { mode: "optimistic"; version: number
        | Date }
        | {
            mode:
                | "pessimistic_read"
                | "pessimistic_write"
                | "dirty_read"
                | "pessimistic_partial_write"
                | "pessimistic_write_or_fail"
                | "for_no_key_update"
                | "for_key_share";
            onLocked?: "nowait"
            | "skip_locked";
            tables?: string[];
        }

    Indicates what locking mode should be used.

    Note: For lock tables, you must specify the table names and not the relation names

    order?: FindOptionsOrder<Entity>

    Order, in which entities should be ordered.

    relationLoadStrategy?: "join" | "query"

    Specifies how relations must be loaded - using "joins" or separate queries. If you are loading too much data with nested joins it's better to load relations using separate queries.

    Default strategy is "join", but default can be customized in connection options.

    relations?: FindOptionsRelations<Entity> | FindOptionsRelationByString

    Indicates what relations of entity should be loaded (simplified left join form).

    select?: FindOptionsSelect<Entity> | FindOptionsSelectByString<Entity>

    Specifies what columns should be retrieved.

    transaction?: boolean

    If this is set to true, SELECT query in a find method will be executed in a transaction.

    where?: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]

    Simple condition that should be applied to match entities.

    withDeleted?: boolean

    Indicates if soft-deleted rows should be included in entity result.

    显示设置
    成员可见性

    目录
    属性