ge/quicker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

upd README

Browse Source
This commit is contained in:
ge
2023-07-09 03:50:37 +03:00
parent c452f7519c
commit 1947315448
1 changed files with 4 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -3,12 +3,12 @@ Quicker is a pythonic tool for querying databases.
Quicker wraps popular Python packages: Quicker wraps popular Python packages:
- `mysqlclient` for MySQL. - `mysqlclient` for MySQL.
- `psycopg2` for PostgreSQL. - `psycopg2` for PostgreSQL (not implemented yet).
- Python builtin `sqlite` for SQLite. - Python builtin `sqlite` for SQLite (not implemented yet).
Connection parameters will passed to "backend" module as is. Connection parameters will passed to "backend" module as is.
# `Connection` class # Usage
`Connection` is context manages and must be used with `with` keyword. `Connection` returns `Query` callable object. `Query` can be called in this ways: `Connection` is context manages and must be used with `with` keyword. `Connection` returns `Query` callable object. `Query` can be called in this ways:
@@ -22,8 +22,6 @@ with Connection(**config) as query:
query("sql query here...") query("sql query here...")
``` ```
# `Query`
`Query` cannot be called itself, you must use `Connection` to correctly initialise `Query` object. `Query` cannot be called itself, you must use `Connection` to correctly initialise `Query` object.
Methods and properties: Methods and properties:
@@ -32,10 +30,6 @@ Methods and properties:
- `commit()`. Write changes into database. - `commit()`. Write changes into database.
- `cursor`. Call [MySQLdb Cursor object](https://mysqlclient.readthedocs.io/user_guide.html#cursor-objects) methods directly. - `cursor`. Call [MySQLdb Cursor object](https://mysqlclient.readthedocs.io/user_guide.html#cursor-objects) methods directly.
# Examples
## SELECT
```python ```python
import json import json
@@ -74,9 +68,7 @@ print(json.dumps(users, indent=4))
] ]
``` ```
## Change database ```python
```
from quicker import Connection from quicker import Connection
with Connection(provider='mysql', read_default_file='~/.my.cnf') as db: with Connection(provider='mysql', read_default_file='~/.my.cnf') as db: