Skip to content

Commit 2768e3d

Browse files
author
rotimi
committed
Documentation update in progress
1 parent 5f74f0b commit 2768e3d

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ Version 4.x & 5.x have been rigorously tested against:
3939
- See [run-tests-against-multiple-db-versions.php](./run-tests-against-multiple-db-versions.php)
4040

4141
Version 6.x has been rigorously tested against:
42-
- Sqlite 3.45.1
43-
- MariaDB 10.4.34, 10.5.29, 10.6.24, 10.11.15, 11.4.9, 11.8.5 & 12.1.2
44-
- MySQL 5.6.51, 5.7.44, 8.0.45 & 8.4.8
45-
- PostgreSQL 12.22, 13.23, 14.20, 15.15, 16.11, 17.7 & 18.1
46-
- See [run-tests-against-multiple-db-versions.php](./run-tests-against-multiple-db-versions.php)
42+
- Sqlite 3.46.1
43+
- MariaDB 10.4.34, 10.5.29, 10.6.25, 10.11.16, 11.4.10, 11.8.6 & 12.2.2
44+
- MySQL 5.6.51, 5.7.44, 8.0.45, 8.4.8 & 9.6.0
45+
- PostgreSQL 12.22, 13.23, 14.22, 15.17, 16.13, 17.9 & 18.3
46+
- See [run-tests-against-multiple-db-versions.php](./run-tests-against-multiple-db-versions.php) & [run-tests-against-multiple-db-versions-docker.php](./run-tests-against-multiple-db-versions-docker.php)
4747

4848
MS SQL Server, is theoretically supported but hasn't been tested.
4949
Will provide more updates on MS SQL Server support once testing on that DB engine has been done.
@@ -54,7 +54,7 @@ Version 1.x of this package never got a stable release.
5454

5555
Version 2.x+ of this package is stable & uses [**aura/sqlquery**](https://github.com/auraphp/Aura.SqlQuery/tree/2.8.1#select) 2.8.0+ .
5656

57-
Versions 3.x+, 4.x+ & 5.x+ of this package are also stable & use [**aura/sqlquery**](https://github.com/auraphp/Aura.SqlQuery/blob/3.x/docs/select.md) 3.0.0+.
57+
Version 3.x+ and higher of this package are also stable & use [**aura/sqlquery**](https://github.com/auraphp/Aura.SqlQuery/blob/3.x/docs/select.md) 3.0.0+.
5858

5959
Versions 2.x & 3.x mainly differ in the versions of **aura/sqlquery** their **Model::getSelect(): \Aura\SqlQuery\Common\Select** returns and
6060
3.x has a few newer features like **Model::fetchOneByPkey($id, array $relations_to_include = []): ?\GDAO\Model\RecordInterface**.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# LeanOrm Documentation
22

33
1. [Introduction](./indtroduction.md)
4-
2. [Comprehensive Guide](./getting-started.md)
4+
2. [Quick Start Guide](./getting-started.md)
55
3. [More about Models](./more-about-models.md)
66
4. [More about Records](./more-about-records.md)
77
5. [More about Collections](./more-about-collections.md)

docs/indtroduction.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,14 @@ For the most part, users of this package will only be interacting with the Model
1515
Instances of the Model class can be used to:
1616

1717
- Fetch data from the database into
18-
- one Record object or multiple Record objects wrapped in either an array or a Collection object
19-
- or one array (representing a row of data from the database) or multiple arrays (i.e. an array of arrays with each sub-array representing a row of data from the database)
18+
- one Record object or multiple Record objects stored in either an array or a Collection object
19+
- one array (representing a row of data from the database) or multiple arrays (i.e. an array of arrays with each sub-array representing a row of data from the database)
2020
- Insert new data into the database table associated with the Model (You cannot insert data into views)
2121
- Update existing data in the database table associated with the Model (You cannot update data in views)
2222
- Delete data from the database table associated with the Model (You cannot delete data from views)
23-
- Define relationship(s) between its associated database table / view and other database tables / views
23+
- Define a Model's relationship(s) to other Model(s).
24+
- These relationships can be used to fetch related data from other Models when fetching data from the Model where the relationships are defined
25+
- For example an Authors model class can have a relationship like an Author has many Posts defined in it. When fetching Authors you can also specify that the associated Posts for each Author be included in the fetched data
2426
- Get database table / view metadata for the table / view the Model is associated with
2527
- and some other database operations
2628

@@ -31,7 +33,7 @@ The Model class generates all the SQL for accessing and manipulating data in the
3133
The Model class also acts as a Data Mapper by being able to map:
3234

3335
- a row of data in a database table to a Record object
34-
- rows of data in a database table in to a Collection object containing one or more Record objects
36+
- rows of data in a database table into a Collection object containing one or more Record objects
3537
- foreign key relationship(s) between database tables into attribute(s) of a record object. Four relationship types are supported:
3638
1. Belongs-To
3739
2. Has-One

0 commit comments

Comments
 (0)