Skip to content
This repository was archived by the owner on Apr 22, 2024. It is now read-only.

Commit 4d17173

Browse files
committed
Update Docs for Connection;
1 parent 8f9a8f9 commit 4d17173

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/ORM-Lite.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,9 @@ ORMapper (const string &connectionString);
173173
Remarks:
174174
- Construct a **O/R Mapper** to connect to `connectionString`;
175175
- For SQLite, the `connectionString` is the **database name**;
176+
- The `ORMapper` **Keeps** the **Connection**
177+
and **Shares** the **Connection** with `Queryable`;
178+
- **Disconnecting** at all related `ORMapper`/`Queryable` destructied;
176179
177180
### Transaction
178181
@@ -326,7 +329,8 @@ Queryable<MyClass> Query (MyClass queryHelper);
326329
Remarks:
327330
- Return new `Queryable` object with `QueryResult` is `MyClass`;
328331
- `MyClass` **MUST** be **Copy Constructible**
329-
to Construct `queryHelper`;
332+
to Construct a `queryHelper`;
333+
- The `ORMapper` **Shares** the **Connection** with `Queryable`;
330334
331335
## `BOT_ORM::Queryable<QueryResult>`
332336
@@ -342,6 +346,7 @@ Remarks:
342346
- `QueryResult` specifies the **Row Type** of Query Result;
343347
- `Select` will Get the one-or-zero-row Result for `agg` immediately;
344348
- `ToVector` / `ToList` returns the Collection of `QueryResult`;
349+
- The results are from the **Connection** of `Queryable`;
345350
- If the Result is `null` for `NOT Nullable` Field,
346351
it will throw `std::runtime_error`;
347352
- `Expression` will be described later;
@@ -368,6 +373,7 @@ Remarks:
368373
- `OrderBy` will **Append** `field` to Condition,
369374
while Other functions will **Set** `DISTINCT`,
370375
`expr`, `field` or `count` to Condition;
376+
- New `Queryable` **Shares** the **Connection** of `this`;
371377
- `Expression` will be described later;
372378
373379
### Construct New `QueryResult`
@@ -394,7 +400,8 @@ Remarks:
394400
all `Nullable<T>`, where `T` is the Supported Types of `ORMAP`
395401
(NOT `std::tuple` or `MyClass`);
396402
- `onExpr` specifies the `ON` Expression for `JOIN`;
397-
- All Functions will pass the **Conditions** of `this` to the new one;
403+
- All Functions will copy the **Conditions** of `this` to the new one;
404+
- New `Queryable` **Shares** the **Connection** of `this`;
398405
- `Expression` will be described later;
399406

400407
### Compound Select
@@ -411,6 +418,7 @@ Remarks:
411418
for `this` and `queryable`;
412419
- All Functions will only **Inherit Conditions**
413420
`OrderBy` and `Limit` from `this`;
421+
- New `Queryable` **Shares** the **Connection** of `this`;
414422
415423
### Query SQL
416424

0 commit comments

Comments
 (0)