From a599b5380963095dd68775d4f63a6c3cb58df47e Mon Sep 17 00:00:00 2001 From: Damian Mooyman Date: Fri, 11 Jul 2014 08:47:18 +1200 Subject: [PATCH] Update docs and alias dev-master as 1.4 --- README.md | 83 ++++++++++++++++++++++++++++----------------------- composer.json | 25 +++++++++------- 2 files changed, 59 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 6c6297f..2bfb5e0 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,73 @@ -SQLite3 Module -============== +# SQLite3 Module [![Build Status](https://travis-ci.org/silverstripe-labs/silverstripe-sqlite3.png?branch=master)](https://travis-ci.org/silverstripe-labs/silverstripe-sqlite3) -Maintainer Contact ------------------- +## Maintainer Contact + Andreas Piening (Nickname: apiening) +## Requirements -Requirements ------------- -SilverStripe 3.0 or newer + * SilverStripe 3.2 or newer +## Installation -Installation ------------- -Download, unzip and copy the sqlite3 folder to your project root so that it becomes a sibling of `framework/`. + * If using composer, run `composer require silverstripe/sqlite3 1.4.*-dev`. + * Otherwise, download, unzip and copy the sqlite3 folder to your project root so that it becomes a + sibling of `framework/`. -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) +## 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'] = 'SQLiteDatabase'; $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. +Make sure the webserver has sufficient privileges to write to that folder and that it is protected from +external access. -Sample mysite/_config.php -------------------------- +### Sample mysite/_config.php - 'SQLiteDatabase', + "server" => 'none', + "username" => 'none', + "password" => 'none', + "database" => $database, + "path" => "/path/to/my/database/file", +); - $databaseConfig = array( - "type" => 'SQLiteDatabase', - "server" => 'none', - "username" => 'none', - "password" => 'none', - "database" => $database, - "path" => "/path/to/my/database/file", - ); +SSViewer::set_theme('blackcandy'); +SiteTree::enable_nested_urls(); +``` - SSViewer::set_theme('blackcandy'); - SiteTree::enable_nested_urls(); +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) -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 -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. +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 ;( +## 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 diff --git a/composer.json b/composer.json index 1619800..2383ff7 100644 --- a/composer.json +++ b/composer.json @@ -4,18 +4,21 @@ "type": "silverstripe-module", "keywords": ["silverstripe", "sqlite3", "database"], "authors": [ - { - "name": "Ingo Schommer", - "email": "ingo@silverstripe.com" - }, - { - "name": "Sean Harvey", - "email": "sean@silverstripe.com" - } + { + "name": "Ingo Schommer", + "email": "ingo@silverstripe.com" + }, + { + "name": "Sean Harvey", + "email": "sean@silverstripe.com" + } ], - - "require": - { + "require": { "silverstripe/framework": "~3.2" + }, + "extra": { + "branch-alias": { + "dev-master": "1.4.x-dev" + } } }