new()

Signature

new() — returns any

Available in: model Category: Create Functions

Description

Creates a new object based on supplied properties and returns it. The object is not saved to the database, it only exists in memory. Property names and values can be passed in either using named arguments or as a struct to the properties argument.

Parameters

Name	Type	Required	Default	Description
properties	struct	no	[runtime expression]	The properties you want to set on the object (can also be passed in as named arguments).
callbacks	boolean	no	true	Set to false to disable callbacks for this method.
allowExplicitTimestamps	boolean	no	false	Set this to true to allow explicit assignment of createdAt or updatedAt properties

Examples

1. Create a new author in memory (not saved to the database)
newAuthor = model("author").new();

2. Create a new author based on properties in a struct
newAuthor = model("author").new(params.authorStruct);

3. Create a new author by passing in named arguments
newAuthor = model("author").new(firstName="John", lastName="Doe");

4. If you have a `hasOne` or `hasMany` association setup from `customer` to `order`, you can do a scoped call. (The `newOrder` method below will call `model("order").new(customerId=aCustomer.id)` internally.)
aCustomer = model("customer").findByKey(params.customerId);
anOrder = aCustomer.newOrder(shipping=params.shipping);

5. Allow explicit timestamps
// You can manually set createdAt and updatedAt fields
newAuthor = model("author").new(
    firstName="Bob",
    lastName="Builder",
    allowExplicitTimestamps=true,
    createdAt=createDate(2025,9,24),
    updatedAt=createDate(2025,9,24)
);