Description

Instantiates an SQLite3 object and opens a connection to an
SQLite 3 database. If the build includes encryption, then it will attempt
to use the key.

Parameters

filename

Path to the SQLite database, or :memory: to use in-memory database.
If filename is an empty string, then a private, temporary on-disk
database will be created. This private database will be automatically
deleted as soon as the database connection is closed.

flags

Optional flags used to determine how to open the SQLite database. By
default, open uses SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE.

SQLITE3_OPEN_READONLY: Open the database for
reading only.

SQLITE3_OPEN_READWRITE: Open the database for
reading and writing.

SQLITE3_OPEN_CREATE: Create the database if it
does not exist.

encryption_key

An optional encryption key used when encrypting and decrypting an
SQLite database. If the SQLite encryption module is not installed,
this parameter will have no effect.

User Contributed Notes 2 notes

$encryption_key and all encryption features will be enabled only if the SQLite encryption module is installed. It's a proprietary, costly module. So if it's not present, supplying an encryption key will have absolutely no effect.

Note that the SQLITE3_OPEN_READONLY flag cannot be combined with the SQLITE3_OPEN_CREATE flag. If you combine both of these flags, a rather unhelpful "Unable to open database: out of memory" exception will be thrown.