Skip to content

Commit bc16f2f

Browse files
Add rough structure for feature specification
1 parent b6eb052 commit bc16f2f

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

docs/framework/orm/index.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,27 @@
11
# Overview
22
## About
3-
The ORM (Object-Relational-Mapping) allows you to access SQL databases without any need to write sql query strings or map between sql and java. This is all done by the ORM for you and even more.
3+
The ORM (Object-Relational-Mapping) allows you to access SQL databases without any need to write SQL query strings or map between SQL and java.
44
[Getting Started](/docs/orm/getting-started)
5+
6+
## Goals and State of the Project
7+
The ORM attempts to make sensible decisions for developers while also granting the ability to overwrite these decisions. To illustrate this with an example:
8+
9+
The ORM ships with a DefaultMapper, which specifies, for instance, what Field in your model maps to which SQL datatype. You have the option to use your own definition and partially use ours when it fits you already.
10+
11+
We consider our v1.0 goals achieved when the following features have been achieved:
12+
13+
### Relation Mapping
14+
15+
|Achieved|Tested|Implemented|Feature|
16+
| - | - | - | - |
17+
| No |No | No |
18+
| | | |
19+
20+
### Query Building
21+
|Achieved|Tested|Implemented|Feature|
22+
| - | - | - | - |
23+
| No | No | Yes | |
24+
525
## Maven (Standalone Usage)
626
```xml
727
<repository>

0 commit comments

Comments
 (0)