Edit Page

.create()

Create a record in the database.

await Something.create(initialValues);

Or:

var createdRecord = await Something.create(initialValues).fetch();

Usage

	Argument	Type	Details
1	initialValues		The initial values for the new record. (Note that, if this model is in "schemaful" mode, then any extraneous keys will be silently omitted.)

Result

Type	Description
	For improved performance, the created record is not provided as a result by default. But if you chain `.fetch()`, then the newly-created record will be sent back. (Be aware that this requires an extra database query in some adapters.)

Errors

Name	Type	When?
UsageError		Thrown if something invalid was passed in.
AdapterError		Thrown if something went wrong in the database adapter. See Concepts > Models and ORM > Errors for an example of how to negotiate a uniqueness error (i.e. from attempting to create a record with a duplicate that would violate a uniqueness constraint).
Error		Thrown if anything else unexpected happens.

See Concepts > Models and ORM > Errors for examples of negotiating errors in Sails and Waterline.

Meta keys

Key	Type	Details
fetch		If set to `true`, then the created record will be sent back. Defaults to `false`.

For more information on meta keys, see .meta().

Example

To create a user named Finn in the database:

await User.create({name:'Finn'});

return res.ok();

Fetching the newly-created record

var createdUser = await User.create({name:'Finn'}).fetch();

sails.log('Finn\'s id is:', createdUser.id);
return res.json(createdUser);

Negotiating errors

It's important to always handle errors from model methods. But sometimes, you need to look at errors in a more granular way. To learn more about the kinds of errors Waterline returns, and for examples of how to handle them, see Concepts > Models and ORM > Errors.

Notes

This method can be used with await, promise chaining, or traditional Node callbacks.

Is something missing?

If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the sails-docs repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.

Documentation

Reference

Built with Love

The Sails framework is built by a web & mobile shop in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!