輕如羽翼，超輕量的嵌入式數(shù)據(jù)庫！

FlashDB簡介

FlashDB 是一款超輕量級的嵌入式數(shù)據(jù)庫，專注于提供嵌入式產(chǎn)品的數(shù)據(jù)存儲方案。與傳統(tǒng)的基于文件系統(tǒng)的數(shù)據(jù)庫不同，F(xiàn)lashDB 結合了 Flash 的特性，具有較強的性能及可靠性。并在保證極低的資源占用前提下，盡可能延長 Flash 使用壽命。

FlashDB 提供兩種數(shù)據(jù)庫模式：

鍵值數(shù)據(jù)庫：是一種非關系數(shù)據(jù)庫，它將數(shù)據(jù)存儲為鍵值（Key-Value）對集合，其中鍵作為唯一標識符。KVDB 操作簡潔，可擴展性強。

時序數(shù)據(jù)庫：時間序列數(shù)據(jù)庫 （Time Series Database , 簡稱 TSDB），它將數(shù)據(jù)按照時間順序存儲。TSDB 數(shù)據(jù)具有時間戳，數(shù)據(jù)存儲量大，插入及查詢性能高。

https://gitee.com/armink/FlashDB

應用場景

如今，物聯(lián)網(wǎng)產(chǎn)品種類越來越多，運行時產(chǎn)生的數(shù)據(jù)種類及總量及也在不斷變大。FlashDB 提供了多樣化的數(shù)據(jù)存儲方案，不僅資源占用小，并且存儲容量大，非常適合用于物聯(lián)網(wǎng)產(chǎn)品。下面是主要應用場景：

鍵值數(shù)據(jù)庫 ：

• 產(chǎn)品參數(shù)存儲
• 用戶配置信息存儲
• 小文件管理

時序數(shù)據(jù)庫 ：

存儲動態(tài)產(chǎn)生的結構化數(shù)據(jù)：如 溫濕度傳感器采集的環(huán)境監(jiān)測信息，智能手環(huán)實時記錄的人體健康信息等記錄運行日志：存儲產(chǎn)品歷史的運行日志，異常告警的記錄等

主要特性

• • • 資源占用極低，內(nèi)存占用幾乎為

    0

    ;支持 多分區(qū)，多實例。數(shù)據(jù)量大時，可細化分區(qū)，降低檢索時間；支持磨損平衡，延長 Flash 壽命；支持掉電保護功能，可靠性高；支持 字符串及 blob 兩種 KV 類型，方便用戶操作；支持 KV增量升級，產(chǎn)品固件升級后， KVDB 內(nèi)容也支持自動升級；支持 修改每條 TSDB 記錄的狀態(tài)，方便用戶進行管理；

例子

使用鍵值數(shù)據(jù)庫存儲UUID

#include?<stdio.h>
#include?<pthread.h>
#include?<sys/stat.h>
#include?<sys/types.h>
#include?<flashdb.h>

#define?FDB_LOG_TAG?"[main]"

static?pthread_mutex_t?kv_locker;
static?uint32_t?init_data?=?0;
static?struct?fdb_kvdb?kvdb?=?{?0?};

static?struct?fdb_default_kv_node?default_kv_table[]?=?
{
????{"init_data",?&init_data,?sizeof(init_data)},?
};

static?void?lock(fdb_db_t?db)
{
????pthread_mutex_lock((pthread_mutex_t?*)db->user_data);
}

static?void?unlock(fdb_db_t?db)
{
????pthread_mutex_unlock((pthread_mutex_t?*)db->user_data);
}

int?main(void)
{
????fdb_err_t?result;
????bool?file_mode?=?true;
????uint32_t?sec_size?=?4096,?db_size?=?sec_size?*?4;
????struct?fdb_default_kv?default_kv;
????struct?fdb_blob?blob;

????//?默認?KV?集合
????default_kv.kvs?=?default_kv_table;
????default_kv.num?=?sizeof(default_kv_table)?/?sizeof(default_kv_table[0]);

????//?設置加解鎖函數(shù)
????pthread_mutex_init(&kv_locker,?NULL);
????fdb_tsdb_control(&tsdb,?FDB_TSDB_CTRL_SET_LOCK,?(void?*)lock);
????fdb_tsdb_control(&tsdb,?FDB_TSDB_CTRL_SET_UNLOCK,?(void?*)unlock);

????//?設置扇區(qū)
????fdb_kvdb_control(&kvdb,?FDB_KVDB_CTRL_SET_SEC_SIZE,?&sec_size);

????//?設置數(shù)據(jù)庫最大大小
????fdb_kvdb_control(&kvdb,?FDB_KVDB_CTRL_SET_MAX_SIZE,?&db_size);
????
????//?設置文件模式
????fdb_kvdb_control(&kvdb,?FDB_KVDB_CTRL_SET_FILE_MODE,?&file_mode);
????
????//?設置數(shù)據(jù)庫文件夾
????mkdir("fdb_kvdb1",?0777);

????//?初始化KV數(shù)據(jù)庫
????result?=?fdb_kvdb_init(&kvdb,?"env",?"fdb_kvdb1",?&default_kv,?&kv_locker);
????if?(result?!=?FDB_NO_ERR)?
????{
????????return?-1;
????}

????//?寫入UUID
????char?uuid_str[64]?=?"3F2504E0-4F89-11D3-9A0C-0305E82C3301";
????fdb_kv_set(&kvdb,?"uuid",?uuid_str);
????FDB_INFO("create?the?'uuid'?blob?KV,?value?is:?%sn",?uuid_str);

????//?讀取UUID
????char?*return_value?=?NULL;
????char?dst_uuid_str[64]?=?{0};
????return_value?=?fdb_kv_get(&kvdb,?"uuid");
????if?(return_value?!=?NULL)?
????{
????????strncpy(dst_uuid_str,?return_value,?sizeof(dst_uuid_str));
????????FDB_INFO("get?the?'uuid'?value?is:?%sn",?dst_uuid_str);
????}

????return?0;
}

fdb_kvdb_init為初始化kv數(shù)據(jù)庫的接口，需要傳參：

在初始化kv數(shù)據(jù)庫之前，可根據(jù)實際需要調(diào)用fdb_kvdb_control接口對數(shù)據(jù)庫進行一些控制設置操作。支持的命令控制字如下：

#define?FDB_KVDB_CTRL_SET_SEC_SIZE?????0x00?????????????/**<?設置扇區(qū)大小，需要在數(shù)據(jù)庫初始化前配置?*/
#define?FDB_KVDB_CTRL_GET_SEC_SIZE?????0x01?????????????/**<?獲取扇區(qū)大小?*/
#define?FDB_KVDB_CTRL_SET_LOCK?????????0x02?????????????/**<?設置加鎖函數(shù)?*/
#define?FDB_KVDB_CTRL_SET_UNLOCK???????0x03?????????????/**<?設置解鎖函數(shù)?*/
#define?FDB_KVDB_CTRL_SET_FILE_MODE????0x09?????????????/**<?設置文件模式，需要在數(shù)據(jù)庫初始化前配置?*/
#define?FDB_KVDB_CTRL_SET_MAX_SIZE?????0x0A?????????????/**<?在文件模式下，設置數(shù)據(jù)庫最大大小，需要在數(shù)據(jù)庫初始化前配置?*/
#define?FDB_KVDB_CTRL_SET_NOT_FORMAT???0x0B?????????????/**<?設置初始化時不進行格式化，需要在數(shù)據(jù)庫初始化前配置?*/

這個demo基于Linux系統(tǒng)運行，需要設置成文件模式，存儲到文件中進行測試。

初始化 KVDB 前通常需要通過 control 函數(shù)設置 加鎖回調(diào) 與 解鎖回調(diào) 。對于裸機平臺，加鎖與解鎖回調(diào)通常設置為關中斷與開中斷函數(shù)。而 RTOS 平臺一般使用 mutex 互斥鎖或 二值信號量 的 take 及 release 動作作為加鎖與解鎖的方式。

更多例子及說明可以查閱源碼及相關文檔：https://github.com/armink/FlashDB