Skip to main content
Version: Next

LoadCountOptions <T>

Options for the Collection.loadCount() method.

Hierarchy

Index

Properties

Properties

optionalinheritedcache

cache?: number | boolean | [string, number]

optionalinheritedcollation

collation?: string | CollationOptions

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

optionalinheritedcomments

comments?: string | string[]

sql only

optionalinheritedconnectionType

connectionType?: ConnectionType

optionalinheritedctx

ctx?: any

optionaldataloader

dataloader?: boolean

Whether to use the dataloader for batching count operations.

optionalinheritedfilters

filters?: FilterOptions

optionalinheritedflushMode

flushMode?: always | FlushMode | commit | auto

optionalinheritedgroupBy

groupBy?: string | readonly string[]

optionalinheritedhaving

having?: FilterQuery<T>

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.

optionalinheritedinflightQueryAbortStrategy

inflightQueryAbortStrategy?: InflightQueryAbortStrategy

Strategy used when the signal fires while the query is in flight. See InflightQueryAbortStrategy for caveats around streams and MongoDB.

optionalinheritedloggerContext

loggerContext?: LogContext

optionalinheritedlogging

logging?: LoggingOptions

optionalinheritedmaxTimeMS

maxTimeMS?: number

mongodb only

optionalinheritedpopulate

populate?: Populate<T, *>

optionalinheritedpopulateFilter

populateFilter?: ObjectQuery<T>

optionalinheritedpopulateWhere

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

optionalrefresh

refresh?: boolean

Whether to reload the count from the database even if it is already cached.

optionalinheritedschema

schema?: string

optionalinheritedsignal

signal?: AbortSignal

AbortSignal that cancels the query when fired.

optionalinheritedunionWhere

unionWhere?: ObjectQuery<T>[]
@see

FindOptions.unionWhere

optionalinheritedunionWhereStrategy

unionWhereStrategy?: union-all | union
@see

FindOptions.unionWhereStrategy

optionalwhere

where?: FilterQuery<T>

Additional filtering conditions for the count query.

Page Options