d2sqlite3 0.5.3

A thin wrapper around SQLite3


To use this package, run the following command in your project's root directory:

Manual usage
Put the following dependency into your project's dependences section:

d2sqlite3

This is a small wrapper around for SQLite (version 3) for the D programming language. It provides a simple "object-oriented" interface to the SQLite database engine.

Features

  1. Database is wrapper around a database connection. The connection is open at the time of its creation and it is automatically closed when no more references exist.

  2. Database has facility functions create new functions, aggregates or collations.

  3. Query is a wrapper around prepared statements and their results, with functionality to bind parameters, iterate on result rows with a lazy input range interface and convert column value to a built-in type or a Variant.

  4. QueryCache is a helper struct that stores all the results of a query in memory in the form of a two-dimensional-array-like interface.

Synopsis

// Note: exception handling is left aside for clarity.

// Open a database in memory.
auto db = Database(":memory:");

// Create a table
db.execute(
    "CREATE TABLE person (
        id INTEGER PRIMARY KEY,
        last_name TEXT NOT NULL,
        first_name TEXT,
        score FLOAT,
        photo BLOB
     )"
);

// Populate the table.
auto query = db.query(
    "INSERT INTO person (last_name, first_name, score, photo)
     VALUES (:last_name, :first_name, :score, :photo)"
);

// Bind values.
query.bind(":last_name", "Smith");
query.bind(":first_name", "John");
query.bind(":score", 77.5);
query.bind(":photo", [0xDE, 0xEA, 0xBE, 0xEF]);
query.execute();

query.reset(); // Need to reset the query after execution.
query.bind(":last_name", "Doe");
query.bind(":first_name", "John");
query.bind(3, 46.8); // Use of index instead of name.
query.bind(":photo", null);
query.execute();

// Count the changes
assert(db.totalChanges == 2);

// Count the Johns in the table.
query = db.query("SELECT count(*) FROM person WHERE first_name == 'John'");
assert(query.oneValue!long == 2);

// Read the data from the table lazily
query = db.query("SELECT * FROM person");
foreach (row; query)
{
    // Retrieve "id", which is the column at index 0, and contains an int,
    // e.g. using the peek function (best performance).
    auto id = row.peek!long(0);

    // Retrieve "last_name" and "first_name", e.g. using opIndex(string),
    // which returns a ColumnData.
    auto name = format("%s, %s", row["last_name"].as!string, row["first_name"].as!string);

    // Retrieve "score", which is at index 3, e.g. using the peek function.
    auto score = row.peek!double("score");
    
    // Retrieve "photo", e.g. using opIndex(index),
    // which returns a ColumnData.
    auto photo = row[4].as!(ubyte[]);
    
    // ... and use all these data!
}

// Read all the table in memory at once
auto data = QueryCache(db.query("SELECT * FROM person"));
foreach (row; data)
{
    auto id = row[0].get!long;
    auto name = format("%s, %s", row["last_name"], row["first_name"]);
    auto score = row["score"].as!double;
    auto photo = row[4].as!(ubyte[]);
    // etc.
}

License: BSL 1.0

Copyright 2011-14, Nicolas Sicard

Authors:
  • Nicolas Sicard
Dependencies:
none
Versions:
1.0.0 2021-Jun-10
0.19.1 2020-Jul-21
0.19.0 2020-Jul-21
0.18.3 2019-Aug-06
0.18.2 2019-Jun-25
Show all 46 versions
Download Stats:
  • 14 downloads today

  • 129 downloads this week

  • 370 downloads this month

  • 40579 downloads total

Score:
4.2
Short URL:
d2sqlite3.dub.pm