Class ORMUser

Get an array of all instances of this model.

Apply the default scopes to this model to the given query builder.

Similar to assumeFromSource, but instead of mapping database fields to model properties, this function assumes the object contains a mapping of model properties to the values of those properties.

Only properties with @Field() annotations will be set.

Given a row from the database, set the properties on this model that correspond to fields on that database.

The row maps database fields to values, and the values are set for the properties that they correspond to based on the model's @Field() annotations.

Create the inverse of a one-to-many relation. Should be called from a method on the model:

Example

class MyModel extends Model<MyModel> {
    @Related()
    public otherModels() {
        return this.hasMany(MyOtherModel)
    }
}

class MyOtherModel extends Model<MyOtherModel> {
    @Related()
    public myModels() {
        return this.belongsToMany(MyModel, 'otherModels')
    }
}

Create the inverse of a one-to-one relation. Should be called from a method on the model:

Example

class MyModel extends Model<MyModel> {
    @Related()
    public otherModel() {
        return this.hasOne(MyOtherModel)
    }
}

class MyOtherModel extends Model<MyOtherModel> {
    @Related()
    public myModel() {
        return this.belongsToOne(MyModel, 'otherModel')
    }
}

Initialize the model's properties from the given values and do any other initial setup.

values can optionally be an object mapping model properties to the values of those properties. Only properties with @Field() annotations will be set.

Count all instances of this model in the database.

Delete the current model from the database, if it exists.

Get a query row mapping database columns to values for properties on this model that (1) have @Field() annotations and (2) have been modified since the record was fetched from the database or created.

Clean up this event bus.

Returns true if this instance's record has been persisted into the database.

Fetch a fresh instance of this record from the database.

This returns a NEW instance of the SAME record by matching on the primary key. It does NOT change the current instance of the record.

Get the method with the given name from this class, bound to this class.

Returns

function

Returns an array of MODEL fields that have been modified since this record was fetched from the database or created.

Get an object of the database field => value mapping that was originally fetched from the database. Excludes changes to model properties.

Create a new one-to-one relation instance. Should be called from a method on the model:

Example

class MyModel extends Model<MyModel> {
    @Related()
    public otherModels() {
        return this.hasMany(MyOtherModel)
    }
}

Create a new one-to-one relation instance. Should be called from a method on the model:

Example

class MyModel extends Model<MyModel> {
    @Related()
    public otherModel() {
        return this.hasOne(MyOtherModel)
    }
}

Returns true if the other model refers to the same database record as this instance.

This is done by comparing the qualified primary keys.

Returns true if none of the fields on this model have been modified since they were fetched from the database (and all exist in the database).

Only fields with @Field() annotations are checked.

Returns true if any of the fields on this model have been modified since they were fetched from the database (or ones that were never saved to the database).

Only fields with @Field() annotations are checked.

Inverse of is().

Get the value of the primary key of this model, if it exists.

Get the unqualified name of the column corresponding to the primary key of this model.

Called before an instance of a key is released from the container.

Return an object of only the given properties on this model.

Example

Assume a is an instance of some model A with the given fields.

const a = new A({ field1: 'field1 value', field2: 'field2 value', id: 123 })

a.only('field1', 'id)  // => {field1: 'field1 value', id: 123}

Register a pipeline as an event handler.

Populates an instance of the model with the same database fields that are set on this model, with the exclusion of the primary key.

Useful for inserting copies of records.

Example

Assume a record, a, is an instance of some model A with the given fields.

const a = A.find(123)  // => A{id: 123, name: 'some_name', other_field: 'a value'}

const b = a.populate(new A)  // => A{name: 'some_name', other_field: 'a value'}

Push an event onto the bus.

Given the name of a column, return the qualified name of the column as it could appear in a query.

Example

modelInstance.qualify('id')  // => 'model_table_name.id'

Return the qualified name of the column corresponding to the model's primary key.

Example

class A extends Model<A> {
    protected static table = 'table_a'
    protected static key = 'a_id'
}

const a = new A()
a.qualifyKey()  // => 'table_a.a_id'

Get a new query builder that yields instances of this model, pre-configured with this model's QuerySource, connection, and fields.

Example

await user.query()
 .where('name', 'LIKE', 'John Doe')
 .update({ username: 'jdoe' })

Re-load the currently-loaded database fields from the table.

Overwrites any un-persisted changes in the current instance.

Persist the model into the database. If the model already exists, perform an update on its fields. Otherwise, insert a new row with its fields.

Passing the withoutTimestamps will prevent the configured CREATED_AT/UPDATED_AT timestamps from being updated.

Sets a value in the override row and (if applicable) associated class property for the given database column.

Subscribe to an event on the bus.

Get normalized values of the configured CREATED_AT/UPDATED_AT fields for this model.

Example

user.timestamps()  // => {updated: Date, created: Date}

Cast the model to an JSON string object.

Only fields with @Field() annotations are included.

Cast this model to a simple object mapping model fields to their values.

Only fields with @Field() annotations are included.

Cast the model to the base QueryRow object. The resultant object maps DATABASE fields to values, NOT MODEL fields to values.

Only fields with @Field() annotations will be included.

Updates the timestamps for this model, if they are configured.

If the model doesn't yet exist, set the CREATED_AT date. Always sets the UPDATED_AT date.

Returns true if the given field has changed since this model was fetched from the database, or if the given field never existed in the database.

Get the name of the connection where this model's table is found.

Find the first instance of this model where the primary key matches key.

Example

const user = await UserModel.findByKey(45)

Get the unqualified canonical resolver of this class, if one has been set.

Get the database connection instance for this model's connection.

Get the fully-qualified canonical resolver of this class, if one has been set.

Given the name of a property on the model with a @Field() annotation, return the unqualified name of the database column it corresponds to.

Given the name of a column, return the qualified name of the column as it could appear in a query.

Example

SomeModel.qualify('col_name')  // => 'model_table_name.col_name'

Return the qualified name of the column corresponding to the model's primary key.

Example

class A extends Model<A> {
    protected static table = 'table_a'
    protected static key = 'a_id'
}

A.qualifyKey()  // => 'table_a.a_id'

Get a new query builder that yields instances of this model, pre-configured with this model's QuerySource, connection, and fields.

Example

const user = await UserModel.query<UserModel>().where('name', 'LIKE', 'John Doe').first()

Get the QuerySource object for this model as it should be applied to query builders.

This sets the alias for the model table equal to the table name itself, so it can be referenced explicitly in queries if necessary.

Sets the fully- and un-qualified canonical resolver strings. Intended for use by the Canonical unit.

Get the table name for this model.