Change log, license and readme files included

This commit is contained in:
Geoff Munn 2009-12-03 21:15:11 +00:00
parent 7ea01e108e
commit f1b2bfcfe3
3 changed files with 74 additions and 0 deletions

3
CHANGELOG Normal file
View File

@ -0,0 +1,3 @@
0.9.0
Released December 4 2009
Initial release of the PostgreSQL module

24
LICENSE Normal file
View File

@ -0,0 +1,24 @@
* Copyright (c) 2009, Silverstripe Ltd.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the <organization> nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY Silverstripe Ltd. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL Silverstripe Ltd. BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

47
README Normal file
View File

@ -0,0 +1,47 @@
###############################################
PostgreSQL Module
###############################################
Maintainer Contact
-----------------------------------------------
Geoff Munn (Nickname: gmunn)
<geoff (at) silverstripe (dot) com>
Requirements
-----------------------------------------------
- PostgreSQL 8.3.x or greater must be installed
- PostgreSQL <8.3.0 may work if T-Search is manually installed
- Known to work on OS X Leopard, Windows Server 2008 R2 and probably Linux
Documentation
-----------------------------------------------
http://doc.silverstripe.org/doku.php?id=postgres
Installation Instructions
-----------------------------------------------
Move the 'postgres' folder to the root level of the project.
You'll need to create a database with the desired name manually.
Run dev/build and you should be set.
Usage Overview
-----------------------------------------------
See the documentation link for examples of PostgreSQL-specific functionality.
Known issues:
-----------------------------------------------
When you're setting this up for the first time, you will need to manually create the database 'SS_project' or whatever it's called.
I haven't implemented the automatic database creation logic yet.
All column and table names must be double-quoted. PostgreSQL automatically lower-cases columns, and your queries will fail if you don't.
Ts_vector columns are not automatically detected by the built-in search filters.
That means if you're doing a search through the CMS on a ModelAdmin object, it will use LIKE queries which are very slow.
If you're writing your own front-end search system, you can specify the columns to use for search purposes, and you get the full benefits of T-Search.
Most other modules probably don't work. There are many instances of MySQL-compatible backticks '`' littering existing modules,
and these need to be changed to double-quotes.
There may also be instances of MySQL-specific SQL queries which will need to be made database-agnostic where possible.