Skip to content

Commit 80286d6

Browse files
committedMay 18, 2024
Updated README
1 parent bcf6cd4 commit 80286d6

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed
 

‎README.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# sqlorm
22

3-
SQL-focused Python ORM
3+
**SQL-focused Python ORM**
4+
5+
![GitHub License](https://img.shields.io/github/license/hyperflask/sqlorm) ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/hyperflask/sqlorm/python.yml?branch=main) ![Code coverage](https://img.shields.io/badge/coverage-90%25-blue)
6+
7+
ORMs and developers often end up in a love/hate relationship. The advantages of ORMs (the mapping of objects) can be negated by their compromises (have to learn their pseudo sql syntax, less control over the generated sql, low performance).
8+
9+
sqlorm intends to provide a solution where sql stays front and center and where the behavior of the ORM is what you expect and no more.
410

511
- Thin layer on top of [DBAPI 2.0](https://peps.python.org/pep-0249/)
612
- Use SQL as usual
@@ -11,7 +17,6 @@ SQL-focused Python ORM
1117
- Supports relationships
1218
- Built-in SQL based migration system
1319
- Low coupling between different parts of the library which can be used directly with DBAPI Connections
14-
- High test coverage (90%)
1520
- Easy to understand code
1621

1722
Example usage:
@@ -241,7 +246,9 @@ engine = Engine.from_uri("psycopg://?host=localhost&port=5432") # using the dbap
241246

242247
Once initialized, an engine can be used as a context to start sessions.
243248

244-
By default, connections are pooled and re-used. You can disabled this behavior by using `pool=False` in the engine constructor.
249+
### Pooling
250+
251+
Connections are pooled and re-used by default. You can disabled this behavior by using `pool=False` in the engine constructor.
245252
`max_pool_conns` can also be used to define the maximum number of connections to start.
246253

247254
### Drivers

0 commit comments

Comments
 (0)