mirror of
https://github.com/silverstripe/silverstripe-sqlite3
synced 2024-10-22 17:05:37 +02:00
63 lines
2.3 KiB
Plaintext
63 lines
2.3 KiB
Plaintext
SQLite3 Module
|
|
==============
|
|
|
|
Maintainer Contact
|
|
------------------
|
|
Andreas Piening (Nickname: apiening)
|
|
<andreas (at) silverstripe (dot) com>
|
|
|
|
|
|
Requirements
|
|
------------
|
|
SilverStripe 2.4 or newer
|
|
|
|
|
|
Installation
|
|
------------
|
|
copy the sqlite3 folder to your project root so that it becomes a sibling of cms, sapphire and co
|
|
add this to your _config.php (right after "require_once("conf/ConfigureFromEnv.php");" if you are using _ss_environment.php)
|
|
|
|
$databaseConfig['type'] = 'SQLiteDatabase';
|
|
|
|
you are done!
|
|
|
|
|
|
Config
|
|
------
|
|
you can set the path for storing your SQLite db file or make use of the :memory: feature in sqlite3/_config.php like this:
|
|
|
|
$databaseConfig = array(
|
|
'path' => '/some/path',
|
|
'memory' => true,
|
|
);
|
|
|
|
make sure the webserver has sufficient privileges to write to that folder and that it is protected from external access.
|
|
|
|
|
|
URL parameter
|
|
-------------
|
|
If you're trying change a field constrain to NOT NULL on a field that contains NULLs it aborts the action because it might corrupt existing records. In order to perform the action anyway add the URL parameter 'avoidConflict' when running dev/build which temporarily adds a conflict clause to the field spec.
|
|
E.g.: http://www.my-project.com/?avoidConflict=1
|
|
|
|
Tested stacks
|
|
-------------
|
|
OSX leopard, XAMPP with PHP 5.3.0, SQLite3.6.3
|
|
Ubuntu, PHP 5.2.4, SQLite3.4.2
|
|
WinXP, XAMPP with PHP 5.3.0, SQLite3.6.16
|
|
|
|
|
|
Open Issues
|
|
-----------
|
|
- SQLite3 may not work with certain modules as they are using custom SQL statements passed to the DB class directly ;(
|
|
- there is no real fulltext search yet and the build-in search engine is not ordering by relevance, check out fts3
|
|
|
|
Things to note when using SQLite3
|
|
---------------------------------
|
|
- small, fast, zero configuration, single cross-platform disk file, comes with a CLI and In-Memory database feature
|
|
- sometimes the only feasible solution when you don't have access to the usual DBMSs like MySQL
|
|
- weakly and dynamically typed although this should have been caught in the adapter
|
|
- does not fully implement SQL-92 standard, e.g. the ALTER TABLE syntax is limited to adding and renaming fields
|
|
- references for sqlite are e.g. ADOBE (Photoshop Lightroom), Apple (Safari, Mail, iPod, iPhone) Mozilla (Firefox, Thunderbird), Google (Chrome)
|
|
- if you are looking for a SQLite client for debugging, the SQLite plugin for firefox may be worth a try
|
|
|