Adapters
What is an adapter?
In Sails and Waterline, database adapters (often simply called "adapters", for short) allow the models in your Sails app to communicate with your database(s). In other words, when your code in a controller action or helper calls a model method like User.find(), what happens next is determined by the configured adapter.
An adapter is defined as a dictionary (aka JavaScript object, like {}) with methods like find, create, etc. Based on which methods it implements, and the completeness with which they are implemented, adapters are said to implement one or more interface layers. Each interface layer implies a contract to implement certain functionality. This allows Sails and Waterline to guarantee conventional usage patterns across multiple models, developers, apps, and even companies, making app code more maintainable, efficient, and reliable.
In previous versions of Sails, adapters were sometimes used for other purposes, like communicating with certain kinds of RESTful web APIs, internal/proprietary web services, or even hardware. But truly RESTful APIs are very rare, and so, in most cases, writing a database adapter to integrate with a non-database API can be limiting. Luckily, there is now a more straightforward way to build these types of integrations.
What kind of things can I do in an adapter?
Adapters are mainly focused on providing model-contextualized CRUD methods. CRUD stands for create, read, update, and delete. In Sails/Waterline, we call these methods create(), find(), update(), and destroy().
For example, a MySQLAdapter implements a create() method which, internally, calls out to a MySQL database using the specified table name and connection information and runs an INSERT ... SQL query.
Next steps
Read about available adapters, or how to make your own custom adapter.
For a better experience on sailsjs.com, update your browser.
Concepts
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-2024 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.