https://github.com/maxmindlin/easy-sql
Lightweight MySQL connection wrapper and query builder for easy programmatic queries
https://github.com/maxmindlin/easy-sql
python sql
Last synced: about 1 year ago
JSON representation
Lightweight MySQL connection wrapper and query builder for easy programmatic queries
- Host: GitHub
- URL: https://github.com/maxmindlin/easy-sql
- Owner: maxmindlin
- Created: 2019-04-25T00:22:48.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-25T03:12:22.000Z (about 7 years ago)
- Last Synced: 2025-02-01T14:31:02.248Z (over 1 year ago)
- Topics: python, sql
- Language: Python
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Sometimes you just need a lightweight DB client outside a traditional MVC.
Requires a .env file in the format (`DB_TUNNEL` is optional if you pass `tunnel=False` to EasySQL):
```
DB_USER=
DB_PASS=
DB_HOST=
DB_PORT=
DB_NAME=
DB_TUNNEL=
```
Keeping this consistent makes connecting easier.
Example usage:
```python
query = (
EasySQL(".env", tunnel=True)
.SELECT(["users","user_ids"])
.FROM("user_table", alias="ut")
.JOIN("client_table", alias="c").LEFT().USING("ID")
.WHERE("c.type = 1")
.WHERE("ut.name = 'John'")
.ORDERBY("ut.date_created", by="desc")
.LIMIT(250)
)
data: pd.DataFrame = query.execute
```
You can nest EasySQL objects together in subqueries:
```python
(
EasySQL(".env")
.SELECT(["foo","bar"])
.FROM("table")
.JOIN("table2").LEFT().USING("field3")
.SUBQUERY(
(
EasySQL(".env")
.SELECT(["foo_"])
.FROM("table3")
),
alias="sub_query",
join_left="foo",
join_right="foo_"
)
.WHERE("foo = 1")
.LIMIT(100)
)
```
You can also pull out a new SQL client like so:
```python
client = EasySQL(".env").new()
```
This just a wrap for the mysql-connector class, so it can be used similarly by pulling out the client:
```python
# This returns a mysql.connector object
EasySQL(".env").new().client
```
`EasySQL().client` will only accept methods that are out of the box for mysql-connector.
Alternatively, use the EasySQL methods for DataFrame responses if you want to pass
full query strings:
```python
data: pd.DataFrame = EasySQL(".env").new().data_frame_query(query_string)
```