Ecto SQLite3 Adapter#

An Ecto SQLite3 Adapter. Uses Exqlite as the driver to communicate with sqlite3.

Caveats and limitations#

Installation#

defp deps do
  [
    {:ecto_sqlite3, "~> 0.17"}
  ]
end

Usage#

Define your repo similar to this.

defmodule MyApp.Repo do
  use Ecto.Repo, otp_app: :my_app, adapter: Ecto.Adapters.SQLite3
end

Configure your repository similar to the following. If you want to know more about the possible options to pass the repository, checkout the documentation for Ecto.Adapters.SQLite. It will have more information on what is configurable.

config :my_app,
  ecto_repos: [MyApp.Repo]

config :my_app, MyApp.Repo,
  database: "path/to/my/database.db"

Type Extensions#

Type extensions allow custom data types to be stored and retrieved from an SQLite3 database.

This is done by implementing a module with the Ecto.Adapters.SQLite3.TypeExtension behaviour which maps types to encoder and decoder functions. Type extensions are activated by adding them to the ecto_sqlite3 configuration as a list of type extention modules assigned to the type_extensions key:

config :exqlite:
  type_extensions: [MyApp.TypeExtension]

config :ecto_sqlite3,
  type_extensions: [MyApp.TypeExtension]

Database Encryption#

As of version 0.9, exqlite supports loading database engines at runtime rather than compiling sqlite3.c itself. This can be used to support database level encryption via alternate engines such as SQLCipher or the Official SEE extension. Once you have either of those projects installed on your system, use the following environment variables during compilation:

# tell exqlite that we wish to use some other sqlite installation. this will prevent sqlite3.c and friends from compiling
export EXQLITE_USE_SYSTEM=1

# Tell exqlite where to find the `sqlite3.h` file
export EXQLITE_SYSTEM_CFLAGS=-I/usr/local/include/sqlcipher

# tell exqlite which sqlite implementation to use
export EXQLITE_SYSTEM_LDFLAGS=-L/usr/local/lib -lsqlcipher

Once you have exqlite configured, you can use the :key option in the database config to enable encryption:

config :my_app, MyApp.Repo,
  database: "path/to/my/encrypted-database.db",
  key: "supersecret'

Benchmarks#

We have some benchmarks comparing it against the MySQL and Postgres adapters.

You can read more about those at bench/README.md.

Running Tests#

Running unit tests

mix test

Running integration tests

EXQLITE_INTEGRATION=true mix test

Configure Feed