Skip to main content
Version: Next

StreamOptions <Entity, Populate, Fields, Exclude>

Hierarchy

  • Omit<FindAllOptions<Entity, Populate, Fields, Exclude>, cache | before | after | first | last | overfetch | strategy>
    • StreamOptions

Index

Properties

Properties

optionalinheritedallowDiskUse

allowDiskUse?: boolean

mongodb only

optionalinheritedcollation

collation?: string | CollationOptions

SQL: collation name string applied as COLLATE to ORDER BY; MongoDB: CollationOptions object.

optionalinheritedcomments

comments?: string | string[]

sql only

optionalinheritedconnectionType

connectionType?: ConnectionType

optionalinheritedconvertCustomTypes

convertCustomTypes?: boolean

optionalinheritedctx

ctx?: any

optionalinheriteddisableIdentityMap

disableIdentityMap?: boolean

optionalinheritedexclude

exclude?: readonly AutoPath<Entity, Exclude, never, 9>[]

optionalinheritedfields

fields?: readonly AutoPath<Entity, Fields, *, 9>[]

optionalinheritedfilters

filters?: FilterOptions

optionalinheritedflags

flags?: QueryFlag[]

optionalinheritedflushMode

flushMode?: always | FlushMode | commit | auto

optionalinheritedgroupBy

groupBy?: string | string[]

sql only

optionalinheritedhaving

having?: FilterQuery<Entity>

optionalinheritedhintComments

hintComments?: string | string[]

sql only

optionalinheritedindexHint

indexHint?: string | Dictionary

SQL: appended to FROM clause (e.g. 'force index(my_index)'); MongoDB: index name or spec passed as hint.

optionalinheritedlimit

limit?: number

Limit the number of returned results. If you try to use limit/offset on a query that joins a to-many relation, pagination mechanism will be triggered, resulting in a subquery condition, to apply this limit only to the root entities instead of the cartesian product you get from a database in this case.

optionalinheritedlockMode

lockMode?: NONE | PESSIMISTIC_READ | PESSIMISTIC_WRITE | PESSIMISTIC_PARTIAL_WRITE | PESSIMISTIC_WRITE_OR_FAIL | PESSIMISTIC_PARTIAL_READ | PESSIMISTIC_READ_OR_FAIL

sql only

optionalinheritedlockTableAliases

lockTableAliases?: string[]

sql only

optionalinheritedloggerContext

loggerContext?: LogContext

optionalinheritedlogging

logging?: LoggingOptions

optionalinheritedmaxTimeMS

maxTimeMS?: number

mongodb only

optionalmergeResults

mergeResults?: boolean = true

When populating to-many relations, the ORM streams fully merged entities instead of yielding every row. You can opt out of this behavior by specifying mergeResults: false. This will yield every row from the SQL result, but still mapped to entities, meaning that to-many collections will contain at most a single item, and you will get duplicate root entities when they have multiple items in the populated collection.

optionalinheritedoffset

offset?: number

Sets the offset. If you try to use limit/offset on a query that joins a to-many relation, pagination mechanism will be triggered, resulting in a subquery condition, to apply this limit only to the root entities instead of the cartesian product you get from a database in this case.

optionalinheritedorderBy

orderBy?: OrderDefinition<Entity>

Ordering of the results.Can be an object or array of objects, keys are property names, values are ordering (asc/desc)

optionalinheritedpopulate

populate?: Populate<Entity, Populate>

optionalinheritedpopulateFilter

populateFilter?: ObjectQuery<Entity>

Filter condition for populated relations. This is similar to populateWhere, but will produce a left join when nesting the condition. This is used for implementation of joined filters.

optionalinheritedpopulateHints

populateHints?: [Populate] extends [never] ? never : { [ K in string ]?: PopulateHintOptions }

Per-relation overrides for populate loading behavior. Keys are populate paths (same as used in populate).

optionalinheritedpopulateOrderBy

populateOrderBy?: OrderDefinition<Entity>

Used for ordering of the populate queries. If not specified, the value of options.orderBy is used.

optionalinheritedpopulateWhere

populateWhere?: PopulateHint | infer | all | ObjectQuery<Entity>

Where condition for populated relations. This will have no effect on the root entity. With select-in strategy, this is applied only to the populate queries. With joined strategy, those are applied as join on conditions. When you use a nested condition on a to-many relation, it will produce a nested inner join, discarding the collection items based on the child condition.

optionalinheritedrefresh

refresh?: boolean

optionalinheritedschema

schema?: string

optionalinheritedwhere

where?: FilterQuery<Entity>
Page Options