NativeSQLite.NET

A SQLite .NET Library using P/Invoke for x64 and x86 Windows operating systems.

Table of Contents

• Current Release
• Usage
• Native SQLite
• Namespace, Class & File Structure
• Naming Conventions
• Bugs
• Todo

Current Release

v0.2-beta
This release is not stable yet. The basic usage scenario should work though.

Usage

// HelloSQLite.cs
// compile: csc /reference:SQLite.NET.dll HelloSQLite.cs
using System;
using UrbanSoft.Data.SQLite;

namespace SQLiteTest
{
  public class SQLiteProgram
  {
    public static void Main()
    {
      using (var sqlite = new SQLite3("sqlite.db"))
      {
        sqlite.execute(@"
          CREATE TABLE IF NOT EXISTS hello_world (
          id  INTEGER PRIMARY KEY,
          msg TEXT)
        ");

     // using (var transaction = new SQLiteTransaction(sqlite))
        using (var transaction = sqlite.beginTransaction())
        {
          sqlite.execute(@"
            INSERT INTO hello_world(msg)
            VALUES ('Hello World!');
          ");
          sqlite.execute(@"
            INSERT INTO hello_world(msg)
            VALUES ('Hello SQLite!');
          ");
          // throw new Exception("ROLLBACK");
        } // implicit commit or rollback

        sqlite.query("SELECT * FROM hello_world");
        foreach(var row in sqlite.LastQuery)
        {
          foreach(var kv in row)
          {
            Console.WriteLine("{0}: {1}", kv.Key, kv.Value);
          }
          Console.WriteLine("--");
        }
      }
    }
  }
}

Native SQLite

• Current version: 3.24.0
• Source code: SQLite Amalgamation
• #define SQLITE_API __declspec(dllexport)
• View expoted functions: dumpbin /exports sqlite3.dll

Namespaces / Classes / Files

• UrbanSoft
  • Data
    • SQLite
      • SQLite3
      • SQLiteException
      • SQLitePInvoke
      • SQLiteTransaction
      • SQLiteTransactionBehavior
      • sqlite3_x64.dll
      • sqlite3_x86.dll
  • Extension
    • Extension
  • Windows
    • Native
      • Win32

Naming Conventions

In general all members and namespaces are written using camelCase.
(Other rules might overrule this one.)

Namespaces

• All namespaces start with an upper case regardless of any proper names.
• A part from that follow the Microsoft guidelines.
• <Company>.(<Product>|<Technology>)[.<Feature>][.<Subnamespace>]

Classes and its Members

Methods

• Non static methods start with a lower case.
  • E.g.: private void start()
• static methods start with an upper case.
  • E.g.: public static void Start()
• Properties start with an upper case.
  • E.g.: protected string Start
• Constants only consist of upper case and optional underscores (_) to separate words and increase the readability.
  • E.g.: internal const string START_NOW = "constant"

Bugs

• Beware UTF-8 filenames they are not tested but are likely to cause problems.

Todo

• Implement the SQLiteException class. Let the SQLitePInvoke do the error handling.