418c1178a1
Enum values are themselves enumerated in sqlite as they are not supported as a type. This leads to values being stored in their own table, and a regular TEXT field being used in a MySQL ENUM's stead. The default value for this field was being escaped with custom string replacement, and erroneously relacing the backslash (a redundant operation). This lead to invalid Fully Qualified Class Names in SilverStripe 4, which is a required trait for polymorphic relationships. As a result any polymorphic relationship not set on first write would then proceed to cause an execution error the next time the dataobject with the relationship was fetched from the database. By using the PHP supplied escape function for SQLite3 we can avoid this, and restore functionality. Relevant section of SQLite documentation to justify the removal of escaping various characters, such as the backslash: A string constant is formed by enclosing the string in single quotes ('). A single quote within the string can be encoded by putting two single quotes in a row - as in Pascal. C-style escapes using the backslash character are not supported because they are not standard SQL. https://www.sqlite.org/lang_expr.html |
||
---|---|---|
_config | ||
code | ||
_config.php | ||
_configure_database.php | ||
_register_database.php | ||
.editorconfig | ||
.gitattributes | ||
.scrutinizer.yml | ||
.travis.yml | ||
.upgrade.yml | ||
code-of-conduct.md | ||
composer.json | ||
LICENSE | ||
phpcs.xml.dist | ||
phpunit.xml.dist | ||
README.md |
SQLite3 Module
Maintainer Contact
Andreas Piening (Nickname: apiening) <andreas (at) silverstripe (dot) com>
Requirements
- SilverStripe 4.0 or newer
Installation
- Install using composer with
composer require silverstripe/sqlite3 ^2
.
Configuration
Either use the installer to automatically install SQLite or add this to your _config.php (right after "require_once("conf/ConfigureFromEnv.php");" if you are using _ss_environment.php)
$databaseConfig['type'] = 'SQLite3Database';
$databaseConfig['path'] = "/path/to/my/database/file";
Make sure the webserver has sufficient privileges to write to that folder and that it is protected from external access.
Sample mysite/_config.php
<?php
global $project;
$project = 'mysite';
global $database;
$database = 'SS_mysite';
require_once("conf/ConfigureFromEnv.php");
global $databaseConfig;
$databaseConfig = array(
"type" => 'SQLite3Database',
"server" => 'none',
"username" => 'none',
"password" => 'none',
"database" => $database,
"path" => "/path/to/my/database/file",
);
Again: make sure that the webserver has permission to read and write to the above path (/path/to/my/database/, 'file' would be the name of the sqlite db file)
URL parameter
If you're trying to change a field constrain to NOT NULL on a field that contains NULLs dev/build fails 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
Open Issues
- SQLite3 is supposed to work with all 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