https://github.com/TimonW-Dev/micropg_lite
Lightweight PostgreSQL database driver for MicroPython (made for ESP8266). Based on micropg by nakagami.
https://github.com/TimonW-Dev/micropg_lite
Last synced: about 1 month ago
JSON representation
Lightweight PostgreSQL database driver for MicroPython (made for ESP8266). Based on micropg by nakagami.
- Host: GitHub
- URL: https://github.com/TimonW-Dev/micropg_lite
- Owner: TimonW-Dev
- License: other
- Created: 2023-06-06T19:26:54.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-12T19:44:20.000Z (over 1 year ago)
- Last Synced: 2024-04-22T13:31:32.218Z (about 1 year ago)
- Language: Python
- Size: 36.1 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-micropython - micropg_lite - Lightweight version of micropg with some slight limitations (e.g. error handling), in order to run on low-RAM microcontrollers (works with ESP8266). (Libraries / Storage)
README
# micropg_lite V3
**Lightweight PostgreSQL database driver for MicroPython...**
...made for ESP8266, ESP32, RP2040 (Raspberry Pi Pico W) and other microcontrollers.
---
This README contains the most important things you need to know about micropg_lite. You can find detailed documentation in the [wiki of this repository](https://github.com/TimonW-Dev/micropg_lite/wiki).
**micropg_superlite is based on [micropg](https://github.com/nakagami/micropg), which was developed by [nakagami](https://github.com/nakagami). Therefore very big thanks to nakagami for the great development. Without micropg there wouldn't be micropg_lite!**
If there are any problems, questions, bugs or suggestions for improvement, please open an [issue](https://github.com/TimonW-Dev/micropg_lite/issues) on this Github repository or write an email to the email address linked in [my profile](https://github.com/TimonW-Dev). We are happy to provide the necessary free support to help you with your micropg_lite requests.
## About micropg_lite
### Difference between [micropg_lite](https://github.com/TimonW-Dev/micropg_lite) and [micropg](https://github.com/nakagami/micropg)
[micropg_lite](https://github.com/TimonW-Dev/micropg_lite) is a lightweight version based on [micropg](https://github.com/nakagami/micropg) by [
nakagami](https://github.com/nakagami). If you have RAM/memory issues with micropg than this library might solve this issue.
micropg_lite has been specially optimised for the ESP8266 and other microchips that have little RAM. micopg_lite works on any microchip that runs micropyhton.
### Major changes in micropg_lite V3
Those who have already worked with micropg_lite V2 know that the micropg_lite V2 driver has some limitations in terms of functionality. Therefore, micropg_lite V3 was optimized from scratch to bring back the functionality that is present in [Nakagami's](https://github.com/nakagami) [micropg](https://github.com/nakagami/micropg).
### There is even a lighter version
[micropg_superlite](https://github.com/TimonW-Dev/micropg_superlite) is based on micropg_lite, but some functions have been removed to make the PostgreSQL driver even lighter. If you still have problems with RAM utilization, you can try micropg_superlite. More information can be found in the [README](https://github.com/TimonW-Dev/micropg_superlite#readme) from the [micropg_superlite](https://github.com/TimonW-Dev/micropg_superlite) repository.
## Installation
1. Download the `micropg_lite.py` file from this repository to your local computer.
2. Copy the `micropg_lite.py` file to the "/lib" folder on the microcontroller using the Thonny IDE or another program. If there is no "lib" folder in the root directory, you have to create it.
**Hint** for the Thony IDE:
Open in the top bar the "View" menu and make sure that the entry "Files" has a "✓", if not then click on "Files". Now you can directly download and upload files from your computer to the microcontroller. You also can create folders on the microcontroller.
3. Now you should be able to import the library to your microcontroller in a MicroPython file.
````python
import micropg_lite
````
## microcontroller file tree
````
/
├─ example.py
└─ lib/
└─ micropg_lite.py
````
## Examples
You need to establish a network connection before executing micropg_lite code. The [SELECT example](#select-example-with-wifi-connection) inclueds the wifi template. All other examples do not include the wifi template.
### examples/ folder
The [examples](https://github.com/TimonW-Dev/micropg_lite/tree/main/examples) folder has a [docker-postgres-container-setup.sh](https://github.com/TimonW-Dev/micropg_lite/blob/main/examples/docker-postgres-container-setup.sh) script to create an empty PostgreSQL container and an [exampleDatabase.sql](https://github.com/TimonW-Dev/micropg_lite/blob/main/examples/exampleDatabase.sql) file which contains the database used in the examples. You will also find complete test scripts with WLAN connection templates and examples for CREATE/DROP TABLE and DATABASE in the examples folder.
### SELECT example with wifi connection:
````python
import time
import network # Handles the wifi connection
import micropg_lite
### To Do: Fill in your wifi connection data and change the server data
ssid = 'wifissid'
password = 'secret'
# Connect to network
wlan = network.WLAN(network.STA_IF)
wlan.active(True)
wlan.connect(ssid, password)
while not wlan.isconnected():
print("Wifi Status: ", wlan.status())
time.sleep(1)
print("Wifi connected")
conn = micropg_lite.connect(host='127.0.0.1', # To Do: Replace this string with the IP address of your server
user='postgres',
password='123456',
database='exampledatabase')
cur = conn.cursor()
cur.execute('select * from customers')
selectresult = cur.fetchall()
conn.close()
# EXAMPLE: Print raw data
print(selectresult)
# EXAMPLE: Print data table
for r1 in selectresult:
for r2 in r1:
print(r2, end="\t")
print()
````
### INSERT example
````python
conn = micropg_lite.connect(host='127.0.0.1', # To Do: Replace this string with the IP address of your server
user='postgres',
password='123456',
database='exampledatabase')
cur = conn.cursor()
cur.execute('INSERT INTO customers (id, firstName, lastName, email) values (%s, %s, %s, %s)', ['5', 'David', 'Wilson', '[email protected]'])
conn.commit()
conn.close()
````
### UPDATE example
```` python
conn = micropg_lite.connect(host='127.0.0.1', # To Do: Replace this string with the IP address of your server
user='postgres',
password='123456',
database='exampledatabase')
cur = conn.cursor()
cur.execute("update customers set firstName='UpdatedFirstName' where id=2;")
conn.commit()
conn.close()
````
### DELETE example
```` python
conn = micropg_lite.connect(host='127.0.0.1', # To Do: Replace this string with the IP address of your server
user='postgres',
password='123456',
database='exampledatabase')
cur = conn.cursor()
cur.execute("delete from customers where id=1;")
conn.commit()
conn.close()
````
## micropg_lite limitations
- Reduced error handling
- No MD5 auth method support
- No native support for the so-called "executemany" function
## Tutorial
[YouTube](https://youtu.be/MK_N49lRzlQ?si=hnv1a1Ya2w6zy7NJ) tutorial by [Fusion Automate](https://fusionautomate.in/logging-sensor-data-to-cloud-postgresql-database-with-raspberry-pi-pico-w/). Thanks for creating.
[](https://youtu.be/MK_N49lRzlQ?si=hnv1a1Ya2w6zy7NJ)