{"id":14982439,"url":"https://github.com/juliandavidmr/sails-inverse-model","last_synced_at":"2025-10-29T12:31:45.698Z","repository":{"id":70333179,"uuid":"62933054","full_name":"juliandavidmr/sails-inverse-model","owner":"juliandavidmr","description":"Generate views, models and controllers for SailsJS from MySQL, PostgreSQL and MongoDB","archived":false,"fork":false,"pushed_at":"2018-11-25T15:28:11.000Z","size":147,"stargazers_count":56,"open_issues_count":5,"forks_count":24,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-02-02T01:31:56.766Z","etag":null,"topics":["database","ejs","generator","mongodb","mysql","nodejs","postgresql","sails-inverse-model","sailsjs","waterline"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/sails-inverse-model","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/juliandavidmr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-09T05:01:47.000Z","updated_at":"2024-10-16T04:55:15.000Z","dependencies_parsed_at":"2023-06-10T04:15:43.711Z","dependency_job_id":null,"html_url":"https://github.com/juliandavidmr/sails-inverse-model","commit_stats":{"total_commits":62,"total_committers":8,"mean_commits":7.75,"dds":"0.20967741935483875","last_synced_commit":"da4e2d0e526170314fe7d1c547e8c41b2b0e29f4"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juliandavidmr%2Fsails-inverse-model","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juliandavidmr%2Fsails-inverse-model/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juliandavidmr%2Fsails-inverse-model/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juliandavidmr%2Fsails-inverse-model/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/juliandavidmr","download_url":"https://codeload.github.com/juliandavidmr/sails-inverse-model/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238825780,"owners_count":19537126,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","ejs","generator","mongodb","mysql","nodejs","postgresql","sails-inverse-model","sailsjs","waterline"],"created_at":"2024-09-24T14:05:24.995Z","updated_at":"2025-10-29T12:31:45.405Z","avatar_url":"https://github.com/juliandavidmr.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![enter image description here](http://sailsjs.org/images/bkgd_squiddy.png)\n\n# Automated generator models, views and controllers for SailsJS \u0026 WaterLine\n\n[![Build Status](https://travis-ci.org/juliandavidmr/sails-inverse-model.svg?branch=master)](https://travis-ci.org/juliandavidmr/sails-inverse-model)\n\n**Sails Inverse Model** helps you build models, controllers and views JS Sails from any database. In addition, you can quickly and individually generate each model, view, controller or all three at the same time.\n\n\u003e Available for **PostgreSQL**, **MySQL** and **MongoDB**\n\n- [Installation](#installation)\n- [Individual generation](#individual-generation)\n- [Generator](#generator)\n- [Import](#import)\n\n--------------------------------------------------------------------------------\n\n## Installation\n\nLinux or MacOS\n\n```bash\n$ sudo npm install sails-inverse-model@next -g\n```\n\nMicrosoft Windows\n\n```bash\n$ npm install sails-inverse-model@next -g\n```\n\n## Individual generation\n\nYou can quickly generate a model, a controller, a view or these three at the same time simply define the attributes of your model. Let's look at an example:\n\n```bash\n# Generate model\n$ sails-inverse-model -g model --name Pet -a \"name:string:r:u owner:string\"\n\n# Generate Controller\n$ sails-inverse-model -g controller --name Pet -a \"\"\n\n# Generate View\n$ sails-inverse-model -g view --name Pet -a \"name:string:r owner:string\"\n\n# Generate all (Model, View and Controller)\n$ sails-inverse-model -g all --name Pet -a \"name:string:r:k owner:string\"\n```\n\n## Detail\n\n|Param              |          Description                |\n|------------------:|:------------------------------------|\n|g                  | Generate view, model, controller    |\n|name               | Name: model, driver, and view folder|\n|a                  | Content of the element to generate  |\n|name:string:params | Attribute name: data type: params   |\n\nSpecifies the type of data that will be stored in this attribute. [Here](http://sailsjs.com/documentation/concepts/models-and-orm/attributes)\n\n## Params\n\n|Param  | Description   |     Example       |\n|------:|:--------------|:------------------|\n|r      | Required      | catname:string:r  |\n|u      | Unique        | catname:string:u  |\n|a      | Autoincrement | index:integer:a   |\n|k      | Primary Key   | index:integer:k   |\n\nYou can also set all three parameters at the same time, for example: __index:integer:a:u:r__\n\n## Example\n\n```bash\nsails-inverse-model -g model --name Pet -a \"index:integer:r:u:a name:string:r:u owner:string:r\"\n\n=\u003e\n  module.exports = {\n      attributes: {\n          index: {                -\u003e index\n              type: 'integer',    -\u003e :integer \n              required: true,     -\u003e :r\n              unique: true,       -\u003e :u \n              autoincrement: true -\u003e :a\n          },\n          name: {\n              type: 'string',\n              required: true,\n              unique: true\n          },\n          owner: {\n              type: 'string',\n              required: true\n          }\n      }\n  };\n```\n\n## Generator (from Database)\n\n```bash\n$ sails-inverse-model --help\n\n  Sails Inverse Model helps you build models, controllers and views JS Sails from any database. In addition, you can quickly and individually generate each model, view, controller or all three at the same time.\n\n                  .-..-.\t\t\t\t\t\t\t\t\t\t\t\t\t\t      \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n  Sails-inverse-model\u003c|    .-..-.\t2.x.x\n                      |\t\t\t\t\t\t\t\t\t\t\n      ~    ~   ~     /|. \t\t\t\t\t\t\t\t\t\n         ~  ~       / || \t\t\t\t\t\t\t\t\t\n           ~  ~   ,'  |'  \t\t\t\t\t\t\t\t\t\n               .-'.-==|/_--'\t\t\t\t\t\t\t\t\n               `--'-------' \t\t\t\t\t\t\t\t\n     _--__--_---__---___--__---__--___      \n   __---__--__---___--__---___--_-_---___    \n   ----------------------------------------------------------\n   :: Sat Feb 04 2017 22:43:52 GMT-0500 (COT)\n   ----------------------------------------------------------\n  Example:\n    $ mkdir sails-output\n    $ cd sails-output\n    $ sails-inverse-model -u postgres -p root -d almacen -t pg -m -v -c\n\n  User         : postgres\n  Password     : root\n  Database     : almacen\n  Host         : localhost\n  Models       : /home/julian/Documents/sails-output/models\n  Views        : /home/julian/Documents/sails-output/views\n  Controllers  : /home/julian/Documents/sails-output/controllers\n  DB           : pg\n  Schema (pg)  : public\n  =====================================\n  Views [OK]\n  =====================================\n  Models [OK]\n  =====================================\n  Controllers [OK]\n\n      Note: Copy models      =\u003e your/project_sails/api\n            Copy controllers =\u003e your/project_sails/api\n            Copy views/*     =\u003e your/project_sails/views/\n   Then: \n   $ cd your/project_sails/\n   $ sails lift\n\n   More info: https://github.com/juliandavidmr/sails-inverse-model\n   ---------------------------------------------------------------\n  Options:\n   -u, --user        User of database\n   -p, --pass        Password of database\n   -d, --database    Database name\n   -h, --host        Host server               Default: localhost\n   -m, --models      Folder output models      Default: Folder actual\n   -c, --controllers Folder output controllers Default: Folder actual\n   -v, --views       Folder output views       Default: Folder actual (Experimental)\n   -t, --type        Type gestor database: mysql|postgres|mongodb  Default: mysql\n   -s, --schema      (Only PostgreSQL) Schema database postgres: Default: public\n   -f, --file        (Only MySQL) .sql file path entry (Experimental)\n\n\n  ====================== Individual generation ==================\n  You can quickly generate a model, a controller, a view or these three at the same time.\n  # Generate model\n  $ sails-inverse-model -g model --name Pet -a \"name:string:r:u owner:string\"\n\n  # Generate Controller\n  $ sails-inverse-model -g controller --name Pet -a \"name:string:r:u owner:string\"\n\n  # Generate View\n  $ sails-inverse-model -g view --name Pet -a \"name:string:r owner:string\"\n\n  # Generate all (Model, View and Controller)\n  $ sails-inverse-model -g all --name Pet -a \"name:string:r:k owner:string\"\n\n  Where:\n  --------------------------------------------\n  |Param | Description   |     Example       |\n  |------|---------------|-------------------|\n  |   r  | Required      | catname:string:r  |\n  |   u  | Unique        | catname:string:u  |\n  |   a  | Autoincrement | index:integer:a   |\n  |   k  | Primary Key   | index:integer:k   |\n  --------------------------------------------\n  You can also set all three parameters at the same time, for example: index:integer:a:u:r\n\n```\n\n## MySQL\n\n```bash\nsails-inverse-model -u root -p root -d mydbmysql -m -v -c\n```\n\n### MySQL from file .sql\n\n```bash\nsails-inverse-model -f /your/path/to/script.sql -m -v -c\n```\n\n## PostgreSQL\n\n```bash\nsails-inverse-model -u postgres -p root -d almacen -t pg -m -v -c\n```\n\n## MongoDB\n\n```bash\nsails-inverse-model -d blog_db -t mg -m -v -c\n```\n\n# Import\n\n## Install package\n\n```bash\nnpm install sails-inverse-model --save\n```\n\n## Generate from **MySQL**\n\n```js\nvar sim = require('sails-inverse-model');\n\nvar config = {\n  host: \"localhost\",\n  database: \"almacen\",\n  user: \"root\",\n  pass: \"root\",\n  port: 3306\n}\n\nvar folder_controllers = \"/your/project/sails/api/\"; //if folder_models == \"\" then: no generate controllers\nvar folder_models = \"/your/project/sails/api/\"; //if folder_models == \"\" then: no generate models\nvar folder_views = \"/your/project/sails/\"; //if folder_models == \"\" then: no generate views\n\nsim.generatemy(config, folder_models, folder_controllers, folder_views, plurallang);\n```\n\n### Generate from **PostgreSQL**\n\n```js\nvar sim = require('sails-inverse-model');\n\nvar config = {\n  host: \"localhost\",\n  database: \"example\",\n  user: \"postgres\",\n  pass: \"root\",\n  port: 5432,\n  schema: \"public\"\n}\n\nvar folder_controllers = \"/your/project/sails/api/\"; //if folder_models == \"\" then: no generate controllers\nvar folder_models = \"/your/project/sails/api/\"; //if folder_models == \"\" then: no generate models\nvar folder_views = \"/your/project/sails/\"; //if folder_models == \"\" then: no generate views\n\nsim.generatepg(config, folder_models, folder_controllers, folder_views, plurallang);\n```\n\n### Generate from **MongoDB**\n\n```js\nvar sim = require('sails-inverse-model');\n\nvar folder_controllers = \"/your/project/sails/api/\"; //if folder_models == \"\" then: no generate controllers\nvar folder_models = \"/your/project/sails/api/\"; //if folder_models == \"\" then: no generate models\nvar folder_views = \"/your/project/sails/\"; //if folder_models == \"\" then: no generate views\n\n//                host       port         database           views         models        controllers\nsim.generatemg('localhost', 27017, 'my_name_collection', folder_views, folder_models, folder_controllers);\n```\n\n### Then navigate to the output folder and can find the js generated.\n\n# [Contributions](/CONTRIBUTING.md)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuliandavidmr%2Fsails-inverse-model","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuliandavidmr%2Fsails-inverse-model","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuliandavidmr%2Fsails-inverse-model/lists"}