Model Introduction

During project development, you always need to manipulate data tables, thus involes CRUD operations. The model is just an incapsulation in order to facilitate database manipulation. A model maps to a data table in database.

ThinkJS currently supports MySQL, MongoDB and SQLite.

Create Model

You can use command thinkjs model [name] in project directory to create model:

thinkjs model user;

This will create file src/common/model/user.js.

Model file will be placed in common module by default, if you want to use other modules, you need to specify module name when creating:

thinkjs model home/user

Note: Model file is not required, you don't need to create it when there is no custom method, in this case the instance of base class will be used.

Model Properties

Default primary key is id, and _id in MongoDB.


The table fields definition, will be readed from database by default, and the result like this:

  id: {
    name: 'id',
    type: 'int', //type
    required: true, //is it required
    primary: true, //is it primary
    unique: true, //is it unique
    auto_increment: true //is it autoincrement?

Additional properties can be added in the model, such as default value and does it read only:

export default class extends think.model.base {
   * Table fields definition
   * @type {Object}
  schema = {
    view_nums: { //read count
      default: 0  //default is 0
    fullname: { //fullname
      default: function() { //combination of first_name and last_name, can not use arrows function
        return this.first_name + this.last_name;
    create_time: { //create time
      default: () => { //get current time
        return moment().format('YYYY-MM-DD HH:mm:ss')
      readonly: true //read only, you can't change it after added

default is only valid in adding, and readonly is only valid in updating.

You can see API -> Model to get more details.

Model Instantiation

Model instantiation is different depend on use cases. If current class has model method, it will be used directly to instantiate:

export default class extends think.controller.base {
    let model = this.model("user");

You can also use think.model to instantiate:

let getModelInstance = function(){
  let model = think.model("user", think.config("db"), "home");

You need to pass in configuration when using think.model.

Chaining Invoke

Model provides many chaining invoke methods(like jQuery does) which can facilitate data manipulation. Chaining invoke is implemented by returnning this:

export default class extends think.model.base {
   * get list data
  async getList(){
    let data = await this.field("title, content").where({
      id: [">", 100]
    }).order("id DESC").select();

Model supports chaining invoke the following methods:

  • where, define query or update conditions
  • table, define table name
  • alias, define alias of current table
  • data, assign value before creating or updating data
  • field, define field for querying, support exclude
  • order, sort results
  • limit, limit results number
  • page, results pagination, will be translated to limit when generate sql commands
  • group, querying group support
  • having, querying having support
  • join, querying join support
  • union, querying union support
  • distinct, querying distinct support
  • cache, query cache

This doc stays at