Documentation

gitHub

Create a new model from scratch

Dynamically generate forward-engineering scripts and documentation with just a few mouse clicks.  

 

When starting a new project, the database model is at the core of your application.  With Hackolade, you can get started in no time!  With just a few mouse clicks, you can generate sample documents, MongoDB collection or DynamoDB table creation scripts, and HTML or PDF documentation.  In an Agile approach, you can engage in a meaningful dialog between analysts, designers, architects, developers and DBAs, playing what-if scenarios.  It increases your chances to deliver an evolving application that responds to your customer's needs.

 

While a real-life model creation process will not be as linear as the flow below, the list below provides a useful checklist:

  1. Create a new model
  2. Fill in model properties
  3. Create a collection
  4. Fill in collection properties
  5. Create a collection attribute
  6. Fill in attribute properties
  7. Iterate steps 5 and 6 to create all attributes in collection
  8. Iterate steps 3 through 6 to create all collections in the database
  9. Create relationships between collection fields
  10. Save the model

 

1. Create a new model

There are 4 ways to create a new model:

- from the Welcome Screen, choose the New model option:

Create new model

- or click File > New Model

- or press the shortcut Ctrl+N

- of click on the New model icon Icons - new Model in the Toolbar

 

2. Fill in model properties

You start by filling the name for your new model, and the rest of the relevant information in the details tab of properties pane.

Creat new model properties

At this stage, you may ignore the Relationships tab, and come back to it later.

 

You may maintain user credentials at the DB-level in the Users tab of the properties pane:

Create new model - user credentials

To add a new user, press the Properties pane controls - add entry sign to add a new user and check the appropriate rights.  To remove a user, press the X Properties pane controls - delete entry .

 

 

3. Create a collection

There are 4 ways to create a new collection:

- from the menu, choose Actions > Add Collection

- press the shortcut Ctrl+L

- from the toolbar, choose the 'add collection' button Icons - add Collection

- inside the central pane, Diagram tab, right-click where you want the collection box to appear, and choose Add Collection

Contextual menu - Add collection

For more details, you may consult the Collection boxes in ER diagram page.

 

4. Fill in collection properties

You start by filling the name for your new collection, and the rest of the relevant information in the details tab of properties pane:

Properties pane - Collection

The fields Capped (and related Size and Max) plus the Validation level and action flags are used in Forward-Engineering for the generation of the MongoDB script. 

 

5. Create a collection attribute

Before you add an attribute, you need to decide where it needs to be added.  For the first one, it's simple: it needs to be an attribute of the tree root.

 

Make sure to review the page Attribute boxes in hierarchical schema view if you have any question on how to add an attribute.  For example, you can add an objectId field, by right-clicking on the root box, and choosing in the cascading contextual menu as displayed below:

Create collection attributes

6. Fill in attribute properties

For example:

Properties pane - field details0 or 

Properties pane - field details1

7. Iterate steps 5 and 6 to create all attributes in collection

 

8. Iterate steps 3 through 6 to create all collections in the database

 

9. Create relationships between collection fields

 

ER Diagram - contextual menu - add relationsh

For more details, you may consult the Relationship links in ER diagram page.

10. Save the model