From 3a63e36c34b42b762cf9346d7bf48f420637430a Mon Sep 17 00:00:00 2001 From: mouna-elmaazouzi Date: Fri, 27 Jan 2023 10:50:06 +0100 Subject: [PATCH] pages update --- docs/model/datastore-classes.md | 6 +++--- docs/model/model-editor-interface.md | 2 +- docs/model/model-overview.md | 30 +++++++++++++--------------- 3 files changed, 18 insertions(+), 20 deletions(-) diff --git a/docs/model/datastore-classes.md b/docs/model/datastore-classes.md index 23cd5d6..507a3aa 100644 --- a/docs/model/datastore-classes.md +++ b/docs/model/datastore-classes.md @@ -46,11 +46,11 @@ In the Properties tab, you can modify the datastore class's properties: - **Scope**: Modifies the scope of the datastore class(Expose as REST or do not expose as REST). By default, this option is set to Expose as REST which means the datastore class can be accessed using a REST request. -- **Page size**: +- **Page size**: Defines how many elements are within a list when you do a list fetch. -- **Records definitely deleted:** +- **Records definitely deleted**: -- **Include in log file:** +- **Include in log file**: By default, this option is checked for all new tables. Allows operations performed on the Datastore class’s data to be included in the database log file (when it is generated). - **Comment**: Comments that you can store with your datastore class for private use. diff --git a/docs/model/model-editor-interface.md b/docs/model/model-editor-interface.md index b49f3fd..577f197 100644 --- a/docs/model/model-editor-interface.md +++ b/docs/model/model-editor-interface.md @@ -48,7 +48,7 @@ The toolbar bordering the top of your workspace contains 3 actions: - Fit view : By clicking on the ![alt-text](img/fitview-icon.png) icon you will get a fitted view of your entire datastore classes Model in the Workspace area. -- ![alt-text](img/fitview-icon.png) reload model : +- Reload model : Clicking on the ![alt-text](img/reloadmodel-icon.png) icon refreshes your model’s interface and updates the latest modifications. **On the right side:** diff --git a/docs/model/model-overview.md b/docs/model/model-overview.md index c179ca2..2521a29 100644 --- a/docs/model/model-overview.md +++ b/docs/model/model-overview.md @@ -2,32 +2,30 @@ id: model-overview title: Qodly Models --- -The structure of your project is called a Model. When you click on an -empty space in the Data Model Editor, you can view the properties for -your Model(coming soon). By default, a Model does not contain any -default datastore classes; you have to create the datastore classes -either in the Data Model Editor or through the **?** +The structure of your project is called a Model. When you click on an empty space in the Data Model Editor, you can view the properties for your Model(coming soon). By default, a Model does not contain any default datastore classes; you can create datastore classes from the Data Model Editor. -You access your current project\'s model by double-clicking on -![alt-text](img/model-icon.png) in your project's sidebar menu. +You access your current project's model by double-clicking on ![alt-text](img/model-icon.png) in your project's sidebar menu. -***Note**: You can zoom out on your project's model to view the whole -structure of the datastore classes it contains; or zoom in to get a -clearer view of a specific datastore class.* +***Note**: You can zoom out on your project's model to view the whole structure of the datastore classes it contains; or zoom in to get a clearer view of a specific datastore class.* ### Model editor interface -In Qodly, the structure of your Model is organized in a new way that -allows you to better manage your datastore classes, attributes, -functions and their properties. +In Qodly, the structure of your Model is organized in a new way that allows you to better manage your datastore classes, attributes, functions and their properties. -You will find more in depth information in Model Editor - overview on -everything interface **from the toolbar to the Properties Area** +You will find more in depth information in Model Editor - overview on everything interface **from the toolbar to the Properties Area** ### Datastore Classes -### Datastore functions +A Datastore is an interface that allows us to reference a structure and access its data; Datastore Classes are object models within it that describe this data. Tables in the database provided by the datastore are handled through Datastore Classes. A dataclass is related to a single Datastore in which you can add custom functions. Each field of the table is an attribute of the dataclass. ### Attributes +An attribute is the smallest storage cell in our relational database, It’s used to designate dataclass properties that store data. + +Relation attributes are used to conceptualize relations between dataclasses (many-to-one and one-to-many). + +### Datastore functions + +Datastore functions allow us to execute code that can be applied to the Datastore Class in order to process data, manipulate data and create result sets. + #####