What are Waterline models?

Summary

In this lesson, we introduce Waterline models in Sails.js. Waterline models represent structured data called records, corresponding to tables in SQL databases or collections in MongoDB. These models are defined in JavaScript files, with attributes mapping to database columns or document properties. The lesson also examines how Waterline models interact with databases and provides an example using a User model. Special columns in Waterline will be discussed in subsequent lessons.

Transcript

Okay, so in this chapter, we're going to look at Waterline models. And in this lesson, we're going to explore what a Waterline model is. Although we've touched on models briefly in previous lessons to demonstrate certain concepts, we are now going to zoom in and examine them in depth.

In this chapter, we’ll cover how to define Waterline models and discuss related concepts.

So, what are Waterline models? Waterline models represent structured data, known as records, that correspond to a table in SQL databases or a collection in MongoDB.

Models are primarily defined in a model file, where attributes in the model correspond to columns in a table or properties in a collection. These models facilitate database interaction within a Sails application.

Let's take a look at a model we've been working with—the User model. Here’s how it’s defined. This is the typical way of working with models in Sails and Waterline. The model definition is structured as a plain JavaScript object with properties that have specific meanings within Waterline and Sails. The key element of this structure is the attributes property, which maps directly to column names in a table or properties in a collection.

For example, when we define attributes like name and age, they correspond directly to columns in the user table. Other columns, which you might see in the database, will be discussed in later lessons as they have special significance in how Sails and Waterline manage data.

To summarize, Waterline models in Sails.js provide a structured way to define and interact with data. A model definition is a JavaScript file that represents structured data called records. When you create a record using the model, it gets inserted as a row in a database table or as a document in a MongoDB collection.