Post topics, source code that relate to the Arduino Platform
User avatar
By arundale
#78572 Sqlite3 Arduino library for ESP8266

Github URL: https://github.com/siara-cc/esp_arduino_sqlite3_lib/

This library enables access to SQLite database files from SPIFFS or Micro SD Card through ESP8266 SoC using WeMos D1 mini and Micro SD Card Shield (shown below) or NodeMCU v1.0 with separate MicroSD Module.

Image

Usage

Sqlite3 C API such as sqlite3_open can be directly invoked. Before calling please invoke:

Code: Select all   vfs_mount("/SD0", SS); // for Micro SD Shield
   File db_file_obj_1; vfs_set_spiffs_file_obj(&db_file_obj_1); // For SPIFFS

apart from
Code: Select allSPI.begin()
or
Code: Select allSPIFFS.begin()
as appropriate.

The SS Pin is D8 on the Micro SD Shield for WeMos D1 mini. It can be changed accordingly.

Please see the examples for full illustration of usage for the two file systems. The databases need to be copied to the Micro SD card root folder before the SD example can be used. Please see the comments section of the example.

Installation

Please download this library, unzip it to the libraries folder of your ESP8266 sdk location. The location varies according to your OS. For example, it is usually found in the following locations:

Code: Select allWindows: C:\Users\(username)\AppData\Roaming\Arduino15
Linux: /home/<username>/.arduino15
MacOS: /home/<username>/Library/Arduino15

Under Arduino15 folder please navigate to
Code: Select allpackages/esp8266/hardware/esp8266/<version>/libraries


If you do not have the ESP8266 sdk for Arduino, please see http://esp8266.github.io/Arduino/versions/2.0.0/doc/installing.html for installing it.

Dependencies / pre-requisites

The SdFat library is required for accessing MicroSD card. This library can be downloaded from https://github.com/greiman/SdFat.

The Sqlite3 code is included with the library.

The stack size of ESP8266 Arduino core is to be increased to atleast 6144 bytes to retrieve data from the sample databases as they are fairly large. Please change CONT_STACKSIZE in cont.h under cores/esp8266.

Limitations on ESP8266

  • The default page size of 4096 leads to "Out of memory" as the size increases over 500 records. Please use page size of 512 using the commands PRAGMA page_size=512; VACUUM;, if you are planning to use your own sqlite3 files.
  • Inserting records over a 1000 records gives "Out of memory"
  • These problems exist on NodeMCU as well due to low memory on ESP8266
  • Retrieving from db having 10 million records has been tested. But it needs stack space to be increased to atleast 6144 bytes. Please modify cores/esp8266/cont.h to increase stack size.
  • It takes around 1 second to retrieve from such dataset, even using the index.

Limitations of this library

  • Although multiple SD Cards are feasible (using multiple CS Pins), as of now only one SD Card is supported (/SD0).
  • Before opening database files from SPIFFS, the
    Code: Select allvfs_set_spiffs_file_obj()
    should be called with a reference to SPIFFS file object
  • A prefix (in front of filenames) such as
    /FLASH/
    is to be used for SPIFFS and
    Code: Select all/SD0/
    is to be used for Micro SD, for opening databases.

Acknowledgements

  • This library was developed by modifying the VFS layer for Sqlite3 developed by Luiz Felipe Silva. The documentation can be found here.
  • The census2000 and baby names databases were taken from here: http://2016.padjo.org/tutorials/sqlite- ... rterpacks/. But no license information is available.
  • The mdr512.db (Million Domain Rank database) was created with data from The Majestic Million and is provided under CC 3.0 Attribution license.
  • The ESP8266 core for Arduino
  • The Arduino platform

Screenshot (output of Micro SD example)

Image

Issues

Please contact the author (Arundale Ramanathan) at arun@siara.cc if you find any problem (or create issue on github).