.findOrCreate()
Find the record matching the specified criteria. If no such record exists, create one using the provided initial values.
var newOrExistingRecord = await Something.findOrCreate(criteria, initialValues);
or, if you need to know whether a new record was created,
Something.findOrCreate(criteria, initialValues)
.exec(function(err, newOrExistingRecord, wasCreated) {
});
Usage
| # | Argument | Type | Details |
|---|---|---|---|
| 1 | criteria | The Waterline criteria to use for matching records in the database. This particular criteria should always match exactly zero or one records in the database. | |
| 2 | initialValues | The initial values for the new record, if one is created. |
Callback
| Argument | Type | Details | |
|---|---|---|---|
| 1 | err | The error that occurred, or undefined if there were no errors. |
|
| 2 | newOrExistingRecord | The record that was found, or undefined if no such record could be located. |
|
| 3 | wasCreated | Whether a new record was created. |
Errors
| Name | Type | When? |
|---|---|---|
| UsageError | Thrown if something invalid was passed in. | |
| AdapterError | Thrown if something went wrong in the database adapter. | |
| Error | Thrown if anything else unexpected happens. |
See Concepts > Models and ORM > Errors for examples of negotiating errors in Sails and Waterline.
Example
Let's make sure our test user, Finn, exists:
User.findOrCreate({ name: 'Finn' }, { name: 'Finn' })
.exec(async(err, user, wasCreated)=> {
if (err) { return res.serverError(err); }
if(wasCreated) {
sails.log('Created a new user: ' + user.name);
}
else {
sails.log('Found existing user: ' + user.name);
}
});
Notes
- This method can be used with
await, promise chaining, or traditional Node callbacks. If you useawait, be aware that the result will be the record only—you will not have access towasCreated.- Behind the scenes, this uses
.findOne(), so if more than one record in the database matches the provided criteria, there will be an error explaining so.
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command-line interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
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!
© 2012-2025 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.