Skip to content
unreal-orm-logo unreal-orm-logo unreal-orm
🚀 This documentation is for unreal-orm 1.0.0 alpha which requires SurrealDB 2.0 SDK. For use with version 1.x, see here.

CountQueryOptions

Defined in: define/table/types/query.ts:218

Defines the options available for a COUNT query.

Example

Section titled “Example”
// Count all active users
const activeUserCount = await User.count({
  where: surql`isActive = true`
});

Type Parameters

Section titled “Type Parameters”

TTable

Section titled “TTable”

TTable

The data shape of the table being queried.

Properties

Section titled “Properties”

DEBUG?

Section titled “DEBUG?”

optional DEBUG: boolean

Defined in: define/table/types/query.ts:231

If true, outputs the generated query and bindings for debugging.

groupBy?

Section titled “groupBy?”

optional groupBy: (string | keyof TTable)[]

Defined in: define/table/types/query.ts:222

An array of fields to group the results by before counting.

parallel?

Section titled “parallel?”

optional parallel: boolean

Defined in: define/table/types/query.ts:227

timeout?

Section titled “timeout?”

optional timeout: string

Defined in: define/table/types/query.ts:229

The timeout for the query, specified in a duration string (e.g. “1m”).

where?

Section titled “where?”

optional where: string

Defined in: define/table/types/query.ts:220

The WHERE clause to filter the records before counting.