ModelStatic

ModelStatic<TInstance, TFields, TOptions> = TInstance

Defined in: define/table/types/model.ts:262

Represents the static side of a model class (the class itself). This includes the constructor, static properties like _tableName and _fields, and static methods like create and the overloaded select.

Type Parameters

TInstance

TInstance extends ModelInstance<InferShapeFromFields<TFields>>

The type of a model instance.

TFields

TFields extends Record<string, FieldDefinition<unknown>>

The field definitions for the model.

TOptions

TOptions extends TableDefineOptions<TFields>

The table definition options.

new ModelStatic(data): TInstance

The constructor signature for the model class.

Parameters

data

InferShapeFromFields<TFields>

Returns

TInstance

Methods

create()

Call Signature

create<T>(this, data): Promise<InstanceType<T>>

Defined in: define/table/types/model.ts:289

Creates a new record in the database (implicit db). Uses the globally configured database connection.

Type Parameters

T

T extends ModelStatic<TInstance, TFields, TOptions>

Parameters

this

T

data

CreateData<TFields>

The data to create the record with.

Returns

Promise<InstanceType<T>>

A promise that resolves to the created model instance.

Example

const user = await User.create({ name: 'John', email: 'john@example.com' });

Call Signature

create<T>(this, db, data): Promise<InstanceType<T>>

Defined in: define/table/types/model.ts:304

Creates a new record in the database (explicit db).

Type Parameters

T

T extends ModelStatic<TInstance, TFields, TOptions>

Parameters

this

T

db

SurrealLike

A SurrealDB connection or transaction object.

data

CreateData<TFields>

The data to create the record with.

Returns

Promise<InstanceType<T>>

A promise that resolves to the created model instance.

Example

const user = await User.create(db, { name: 'John', email: 'john@example.com' });

---

delete()

Call Signature

delete<T>(this, id): Promise<void>

Defined in: define/table/types/model.ts:765

Deletes a record from the database (implicit db).

Type Parameters

T

T extends ModelStatic<TInstance, TFields, TOptions>

Parameters

this

T

id

_RecordId

The record ID to delete.

Returns

Promise<void>

A promise that resolves when the record is deleted.

Example

await User.delete('user:123');

Call Signature

delete<T>(this, db, id): Promise<void>

Defined in: define/table/types/model.ts:784

Deletes a record from the database (explicit db).

Type Parameters

T

T extends ModelStatic<TInstance, TFields, TOptions>

Parameters

this

T

db

SurrealLike

A SurrealDB connection or transaction object.

id

_RecordId

The record ID to delete.

Returns

Promise<void>

A promise that resolves when the record is deleted.

Example

await User.delete(db, 'user:123');

---

getTableName()

getTableName(): string

Defined in: define/table/types/model.ts:277

Gets the table name for this model.

Returns

string

---

insert()

Call Signature

insert<T>(this, options): Promise<InstanceType<T>>

Defined in: define/table/types/model.ts:325

Inserts a single record using INSERT statement (implicit db).

Type Parameters

T

T extends ModelStatic<TInstance, TFields, TOptions>

Parameters

this

T

options

InsertQueryOptions<InferShapeFromFields<TFields>, Partial<InferShapeFromFields<TFields>>>

Insert options including data to insert.

Returns

Promise<InstanceType<T>>

A promise that resolves to the inserted model instance.

Example

const user = await User.insert({
  data: { name: 'John', email: 'john@example.com' },
});

Call Signature

insert<T>(this, options): Promise<InstanceType<T>[]>

Defined in: define/table/types/model.ts:347

Bulk inserts multiple records using INSERT statement (implicit db).

Type Parameters

T

T extends ModelStatic<TInstance, TFields, TOptions>

Parameters

this

T

options

InsertQueryOptions<InferShapeFromFields<TFields>, Partial<InferShapeFromFields<TFields>>[]>

Insert options including array of data to insert.

Returns

Promise<InstanceType<T>[]>

A promise that resolves to an array of inserted model instances.

Example

const users = await User.insert({
  data: [
    { name: 'John', email: 'john@example.com' },
    { name: 'Jane', email: 'jane@example.com' },
  ],
});

Call Signature

insert<T>(this, db, options): Promise<InstanceType<T>>

Defined in: define/table/types/model.ts:371

Inserts a single record using INSERT statement (explicit db).

Type Parameters

T

T extends ModelStatic<TInstance, TFields, TOptions>

Parameters

this

T

db

SurrealLike

A SurrealDB connection or transaction object.

options

InsertQueryOptions<InferShapeFromFields<TFields>, Partial<InferShapeFromFields<TFields>>>

Insert options including data to insert.

Returns

Promise<InstanceType<T>>

A promise that resolves to the inserted model instance.

Example

const user = await User.insert(db, {
  data: { name: 'John', email: 'john@example.com' },
});

Call Signature

insert<T>(this, db, options): Promise<InstanceType<T>[]>

Defined in: define/table/types/model.ts:395

Bulk inserts multiple records using INSERT statement (explicit db).

Type Parameters

T

T extends ModelStatic<TInstance, TFields, TOptions>

Parameters

this

T

db

SurrealLike

A SurrealDB connection or transaction object.

options

InsertQueryOptions<InferShapeFromFields<TFields>, Partial<InferShapeFromFields<TFields>>[]>

Insert options including array of data to insert.

Returns

Promise<InstanceType<T>[]>

A promise that resolves to an array of inserted model instances.

Example

const users = await User.insert(db, {
  data: [
    { name: 'John', email: 'john@example.com' },
    { name: 'Jane', email: 'jane@example.com' },
  ],
});

---

select()

Call Signature

select(this): Promise<TInstance[]>

Defined in: define/table/types/model.ts:416

Selects all full model instances from the table (implicit db).

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

Returns

Promise<TInstance[]>

A promise that resolves to an array of all model instances.

Example

const allUsers = await User.select();

Call Signature

select(this, options): Promise<Record<string, unknown>[]>

Defined in: define/table/types/model.ts:421

Selects records with GROUP BY aggregation (implicit db).

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

options

SelectQueryOptions<InferShapeFromFields<TFields>, TFields> & object

Returns

Promise<Record<string, unknown>[]>

Call Signature

select(this, options): Promise<unknown[]>

Defined in: define/table/types/model.ts:431

Selects records with VALUE clause - returns array of values (implicit db).

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

options

SelectQueryOptions<InferShapeFromFields<TFields>, TFields> & object

Returns

Promise<unknown[]>

Call Signature

select<TOmit>(this, options): Promise<{ [K in string | number | symbol]: { [K in string | number | symbol as K extends keyof TOmit ? TOmit[K] extends true ? never : K : K]: InferFieldType<TFields[K]> }[K] } | undefined>

Defined in: define/table/types/model.ts:441

Selects and omits fields from a single record (implicit db).

Type Parameters

TOmit

TOmit extends OmitSelect<TFields>

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

options

Omit<SelectQueryOptions<InferShapeFromFields<TFields>, TFields>, "omit"> & object

Returns

Promise<{ [K in string | number | symbol]: { [K in string | number | symbol as K extends keyof TOmit ? TOmit[K] extends true ? never : K : K]: InferFieldType<TFields[K]> }[K] } | undefined>

Call Signature

select<TOmit>(this, options): Promise<{ [K in string | number | symbol]: { [K in string | number | symbol as K extends keyof TOmit ? TOmit[K] extends true ? never : K : K]: InferFieldType<TFields[K]> }[K] }[]>

Defined in: define/table/types/model.ts:452

Type Parameters

TOmit

TOmit extends OmitSelect<TFields>

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

options

Omit<SelectQueryOptions<InferShapeFromFields<TFields>, TFields>, "omit"> & object

Returns

Promise<{ [K in string | number | symbol]: { [K in string | number | symbol as K extends keyof TOmit ? TOmit[K] extends true ? never : K : K]: InferFieldType<TFields[K]> }[K] }[]>

Call Signature

select<TSelect>(this, options): Promise<InferSelectResult<TFields, TSelect> | undefined>

Defined in: define/table/types/model.ts:469

Selects specified fields from a single record (implicit db).

Type Parameters

TSelect

TSelect extends FieldSelect<TFields>

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

options

Omit<SelectQueryOptions<InferShapeFromFields<TFields>, TFields>, "select"> & object

Returns

Promise<InferSelectResult<TFields, TSelect> | undefined>

Call Signature

select<TSelect>(this, options): Promise<InferSelectResult<TFields, TSelect>[]>

Defined in: define/table/types/model.ts:482

Type Parameters

TSelect

TSelect extends FieldSelect<TFields>

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

options

Omit<SelectQueryOptions<InferShapeFromFields<TFields>, TFields>, "select"> & object

Returns

Promise<InferSelectResult<TFields, TSelect>[]>

Call Signature

select(this, options): Promise<TInstance | undefined>

Defined in: define/table/types/model.ts:497

Selects a single full model instance (implicit db).

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

options

SelectQueryOptions<InferShapeFromFields<TFields>, TFields> & object

Returns

Promise<TInstance | undefined>

Call Signature

select(this, options): Promise<TInstance[]>

Defined in: define/table/types/model.ts:507

Selects multiple full model instances with options (implicit db).

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

options

SelectQueryOptions<InferShapeFromFields<TFields>, TFields>

Returns

Promise<TInstance[]>

Call Signature

select(this, db): Promise<TInstance[]>

Defined in: define/table/types/model.ts:525

Selects all full model instances from the table (explicit db).

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

db

SurrealLike

A SurrealDB connection or transaction object.

Returns

Promise<TInstance[]>

A promise that resolves to an array of all model instances.

Example

const allUsers = await User.select(db);

Call Signature

select(this, db, options): Promise<Record<string, unknown>[]>

Defined in: define/table/types/model.ts:533

Selects records with GROUP BY aggregation (explicit db).

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

db

SurrealLike

options

SelectQueryOptions<InferShapeFromFields<TFields>, TFields> & object

Returns

Promise<Record<string, unknown>[]>

Call Signature

select(this, db, options): Promise<unknown[]>

Defined in: define/table/types/model.ts:544

Selects records with VALUE clause - returns array of values (explicit db).

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

db

SurrealLike

options

SelectQueryOptions<InferShapeFromFields<TFields>, TFields> & object

Returns

Promise<unknown[]>

Call Signature

select<TOmit>(this, db, options): Promise<{ [K in string | number | symbol]: { [K in string | number | symbol as K extends keyof TOmit ? TOmit[K] extends true ? never : K : K]: InferFieldType<TFields[K]> }[K] } | undefined>

Defined in: define/table/types/model.ts:564

Selects and omits fields from a single record (explicit db).

Type Parameters

TOmit

TOmit extends OmitSelect<TFields>

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

db

SurrealLike

options

Omit<SelectQueryOptions<InferShapeFromFields<TFields>, TFields>, "omit"> & object

Returns

Promise<{ [K in string | number | symbol]: { [K in string | number | symbol as K extends keyof TOmit ? TOmit[K] extends true ? never : K : K]: InferFieldType<TFields[K]> }[K] } | undefined>

Call Signature

select<TOmit>(this, db, options): Promise<{ [K in string | number | symbol]: { [K in string | number | symbol as K extends keyof TOmit ? TOmit[K] extends true ? never : K : K]: InferFieldType<TFields[K]> }[K] }[]>

Defined in: define/table/types/model.ts:576

Type Parameters

TOmit

TOmit extends OmitSelect<TFields>

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

db

SurrealLike

options

Omit<SelectQueryOptions<InferShapeFromFields<TFields>, TFields>, "omit"> & object

Returns

Promise<{ [K in string | number | symbol]: { [K in string | number | symbol as K extends keyof TOmit ? TOmit[K] extends true ? never : K : K]: InferFieldType<TFields[K]> }[K] }[]>

Call Signature

select(this, db, options): Promise<Partial<InferShapeFromFields<TFields>>[]>

Defined in: define/table/types/model.ts:591

Selects records with OMIT clause using string array (explicit db). Less type-safe than object format.

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

db

SurrealLike

options

SelectQueryOptions<InferShapeFromFields<TFields>, TFields> & object

Returns

Promise<Partial<InferShapeFromFields<TFields>>[]>

Call Signature

select<TSelect>(this, db, options): Promise<InferSelectResult<TFields, TSelect> | undefined>

Defined in: define/table/types/model.ts:620

Selects specified fields from a single record (explicit db).

Type Parameters

TSelect

TSelect extends FieldSelect<TFields>

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

db

SurrealLike

options

Omit<SelectQueryOptions<InferShapeFromFields<TFields>, TFields>, "select"> & object

Returns

Promise<InferSelectResult<TFields, TSelect> | undefined>

Call Signature

select<TSelect>(this, db, options): Promise<InferSelectResult<TFields, TSelect>[]>

Defined in: define/table/types/model.ts:634

Type Parameters

TSelect

TSelect extends FieldSelect<TFields>

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

db

SurrealLike

options

Omit<SelectQueryOptions<InferShapeFromFields<TFields>, TFields>, "select"> & object

Returns

Promise<InferSelectResult<TFields, TSelect>[]>

Call Signature

select(this, db, options): Promise<TInstance | undefined>

Defined in: define/table/types/model.ts:648

Selects a single full model instance (explicit db).

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

db

SurrealLike

options

SelectQueryOptions<InferShapeFromFields<TFields>, TFields> & object

Returns

Promise<TInstance | undefined>

Call Signature

select(this, db, options): Promise<TInstance[]>

Defined in: define/table/types/model.ts:659

Selects multiple full model instances with options (explicit db).

Parameters

this

ModelStatic<TInstance, TFields, TOptions>

db

SurrealLike

options

SelectQueryOptions<InferShapeFromFields<TFields>, TFields>

Returns

Promise<TInstance[]>

---

update()

Call Signature

update<T>(this, id, options): Promise<InstanceType<T>>

Defined in: define/table/types/model.ts:675

Updates a record using content, merge, or replace mode (implicit db).

Type Parameters

T

T extends ModelStatic<TInstance, TFields, TOptions>

Parameters

this

T

id

_RecordId

The record ID to update.

options

Update options including data and mode.

data

Partial<InferShapeFromFields<TFields>>

mode

"content" | "merge" | "replace"

Returns

Promise<InstanceType<T>>

A promise that resolves to the updated model instance.

Call Signature

update<T>(this, id, options): Promise<InstanceType<T>>

Defined in: define/table/types/model.ts:690

Updates a record using JSON Patch operations (implicit db).

Type Parameters

T

T extends ModelStatic<TInstance, TFields, TOptions>

Parameters

this

T

id

_RecordId

The record ID to update.

options

Update options including patch operations and mode.

data

JsonPatchOperation[]

mode

"patch"

Returns

Promise<InstanceType<T>>

A promise that resolves to the updated model instance.

Call Signature

update<T>(this, db, id, options): Promise<InstanceType<T>>

Defined in: define/table/types/model.ts:721

Updates a record using content, merge, or replace mode (explicit db).

Type Parameters

T

T extends ModelStatic<TInstance, TFields, TOptions>

Parameters

this

T

db

SurrealLike

A SurrealDB connection or transaction object.

id

_RecordId

The record ID to update.

options

Update options including data and mode.

data

Partial<InferShapeFromFields<TFields>>

mode

"content" | "merge" | "replace"

Returns

Promise<InstanceType<T>>

A promise that resolves to the updated model instance.

Example

// Full content replacement
const user = await User.update(db, 'user:123', {
  data: { name: 'Jane', email: 'jane@example.com' },
  mode: 'content'
});

// Partial merge
const user = await User.update(db, 'user:123', {
  data: { name: 'Jane' },
  mode: 'merge'
});

Call Signature

update<T>(this, db, id, options): Promise<InstanceType<T>>

Defined in: define/table/types/model.ts:745

Updates a record using JSON Patch operations (explicit db).

Type Parameters

T

T extends ModelStatic<TInstance, TFields, TOptions>

Parameters

this

T

db

SurrealLike

A SurrealDB connection or transaction object.

id

_RecordId

The record ID to update.

options

Update options including patch operations and mode.

data

JsonPatchOperation[]

mode

"patch"

Returns

Promise<InstanceType<T>>

A promise that resolves to the updated model instance.

Example

const user = await User.update(db, 'user:123', {
  data: [{ op: 'replace', path: '/name', value: 'Jane' }],
  mode: 'patch'
});