@@ -61,63 +61,79 @@ This allows us to avoid circular dependencies
6161The 'something else' can be a lot of things including a ` IEntity ` or a vector of
6262` IEntity ` .
6363
64- In this documentation we call
65- * A '_ complex property_ ', a property of type ` IEntity ` . It is also named
66- a "manyToOne" property and it resolves to a foreign key in the table of the
64+ In this documentation we call:
65+
66+ A '_ complex property_ ', a property of type ` IEntity ` . It is also named
67+ a "manyToOne" property and it resolves to a foreign key in the table of the
6768 _ class_ .
68- * A '_ property of IEntities_ ', a property of type
69- ` Vector{T} where T <: IEntity ` . It is also named a "oneToMany" property and
70- it is the counter part of a _ complex property_ in another _ class_ .
69+
70+ A '_ property of IEntities_ ', a property of type ` Vector{T} where T <: IEntity ` .
71+ It is also named a "oneToMany" property and it is the counter part of a
72+ _ complex property_ in another _ class_ .
7173
7274
7375
7476#### A _ class_ has two constructors
7577
76- 1 . A constructor that takes a NamedTuple and that is required by PostgresORM
78+ A first constructor that takes a NamedTuple and that is required by PostgresORM
7779function. It calls the second constructor by splatting the NamedTuple.
78- 2 . A constructor that takes optional named arguments with default values
80+
81+ A second constructor that takes optional named arguments with default values
7982 ` missing ` and that assign the values to the matching properties.
8083
8184Therefore:
8285
83- * Calling ` Film() ` creates an instance of _ Film_ with all properties set
86+ Calling ` Film() ` creates an instance of _ Film_ with all properties set
8487to ` missing `
85- * Calling ` Film(id = 34, codeName = "cube") ` creates an instance of _ Film_
88+
89+ Calling ` Film(id = 34, codeName = "cube") ` creates an instance of _ Film_
8690with all properties set to ` missing ` except _ id_ and _ codeName_
8791
8892### ORM modules
8993An ORM module is a Julia module that tells PostgresORM how to handle a _ class_ .
9094It contains the following:
9195
92- * ` data_type = Model.Film ` : Assigns the module variable ` data_type ` to the
96+ ` data_type = Model.Film ` : Assigns the module variable ` data_type ` to the
9397 _ class_ associated with the ORM module
94- * ` PostgresORM.get_orm(x::Model.Film) = return(ORM.FilmORM) ` : Declares a new
98+
99+ ` PostgresORM.get_orm(x::Model.Film) = return(ORM.FilmORM) ` : Declares a new
95100 method of function ` PostgresORM.get_orm ` , this function is used to tell
96101 PostgresORM which ORM module to use for a given _ class_
97- * ` get_schema_name() = "public" ` : Returns the PostgreSQL schema name of the
102+
103+ ` get_schema_name() = "public" ` : Returns the PostgreSQL schema name of the
98104table associated with the _ class_
99- * ` get_table_name() = "film" ` : Returns the table name associated with the _ class_
100- * ` get_columns_selection_and_mapping() ` : Returns the mapping between julia
105+
106+ ` get_table_name() = "film" ` : Returns the table name associated with the _ class_
107+
108+ ` get_columns_selection_and_mapping() ` : Returns the mapping between julia
101109 fields and table columns. Note that a _ complex property_ can be mapped to
102110 an array of columns if the foreign key has multiple columns (i.e. if the
103111 _ class_ of the _ complex_property_ has a composite id)
104- * ` get_id_props() ` : Returns the fields that make the id of the _ class_ . These
112+
113+ ` get_id_props() ` : Returns the fields that make the id of the _ class_ . These
105114 fields can be _ complex properties_
106- * ` get_onetomany_counterparts() ` : It gives for every _ property of IEntities_
115+
116+ ` get_onetomany_counterparts() ` : It gives for every _ property of IEntities_
107117 the associated _ complex property_ (i.e. manyToOne property)
108- * ` get_types_override() ` : It gives for every oneToMany or manyToOne property
118+
119+ ` get_types_override() ` : It gives for every oneToMany or manyToOne property
109120 the real type of the property
110121
111- Some optional functions for the tracking of changes:
112- * ` get_track_changes() ` : Tells PostgresORM to record all the changes made to
122+ __ Some optional functions for the tracking of changes:__
123+
124+ ` get_track_changes() ` : Tells PostgresORM to record all the changes made to
113125 instances of the _ class_
114- * ` get_creator_property() ` : Tells which property holds the reference of the
126+
127+ ` get_creator_property() ` : Tells which property holds the reference of the
115128 user that created the instance. This property must inherit ` PostgresORM.AppUser `
116- * ` get_editor_property() ` : Tells which property holds the reference of the
129+
130+ ` get_editor_property() ` : Tells which property holds the reference of the
117131 user that last edited the instance. This property must inherit ` PostgresORM.AppUser `
118- * ` get_creation_time_property() ` : Tells which property holds the creation
132+
133+ ` get_creation_time_property() ` : Tells which property holds the creation
119134 time of the instance
120- * ` get_update_time_property() ` : Tells which property holds the last update
135+
136+ ` get_update_time_property() ` : Tells which property holds the last update
121137 time of the instance
122138
123139### Enums
0 commit comments