Go to file
2023-03-20 16:31:41 +13:00
_config Added quotes to values in connectors.yml 2019-01-09 00:17:49 +01:00
.github/workflows MNT Use gha-dispatch-ci (#71) 2023-03-20 16:31:41 +13:00
code switch back to null 2022-08-31 09:00:08 +02:00
_config.php fix: remove deprecated function 2023-01-24 20:04:50 +13:00
_configure_database.php MNT Standardise modules 2022-08-01 16:23:18 +12:00
_register_database.php MNT Standardise modules 2022-08-01 16:23:18 +12:00
.editorconfig Added standard .editorconfig file 2015-12-17 10:06:47 +13:00
.gitattributes Added standard .gitattributes file 2016-01-16 19:32:49 +13:00
.upgrade.yml API Apply SilverStripe\SQLite namespace to module 2016-06-29 13:55:45 +12:00
code-of-conduct.md Added standard code of conduct file 2016-02-16 11:42:22 +13:00
composer.json MNT Add codesniffer 2022-08-05 12:33:00 +12:00
LICENSE Create LICENSE 2013-09-02 21:20:35 +12:00
phpcs.xml.dist MNT Standardise modules 2022-08-01 16:23:18 +12:00
README.md MNT Standardise modules 2022-08-01 16:23:18 +12:00

SQLite3 Module

CI Silverstripe supported 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