Quick start

    • Key-Value Database (KVDB): It is a non-relational database that stores data as a collection of key-value pairs, where the key is used as a unique identifier. KVDB has simple operation and strong scalability.
    • Time series log (TSL): TSL (Time series log) is the abbreviation of each record in TSDB.
    • Blob: In a computer, blob is often a field type used to store binary files in a database. In FlashDB, both KV and TSL use the blob type for storage, which can be compatible with any variable type.
    • Iterator: It allows users to visit every element in the container through a specific interface without knowing the underlying implementation. Both TSDB and KVDB support traversal access to the database through iterators.

    Functional block diagram

    Through the following functional block diagram, you can roughly understand the FlashDB functional module division

    The demo project provided by FlashDB supports two projects by default:

    • RT-Studio: Free to use, easy to use, download address:

    Serial port tool

    Prepare or Serial terminal tool, and you need to use it when viewing the running log later

    Get the source code

    In the demos directory of the project, the following demonstration platforms are currently provided. You can choose a platform and experience the running process of FlashDB on a real machine.

    For more detailed introduction, click on the instructions in the table below to view.

    View sample description

    Sample file Description Detailed explanation
    KVDB basic example click to view
    samples/kvdb_type_string_sample.c KV example of string type
    samples/kvdb_type_blob_sample.c Blob type KV example click to view
    samples/tsdb_sample.c TSDB basic example