Merge branch 'master' into openid

[rails.git] / db / README

diff --git a/db/README b/db/README
index 447c63651f538952278eb69e10afb7dcbce6ffc3..db4f5c20ea23b4e6afa25259087e1556d83bd73b 100644 (file)
--- a/db/README
+++ b/db/README
@@ -25,12 +25,17 @@ $ mysql -u <uid> -p
 > flush privileges;
 > exit
 
-Creating functions
-====================
+Creating functions For MySQL
+==============================
 
 Run this command in the db/functions directory:
 
-$ make
+$ make libmyosm.so
+
+You might also need to install:
+- mysql client development libraries:  $ sudo apt-get install libmysqlclient16-dev 
+- ruby development libraries:          $ sudo apt-get install ruby1.8-dev
+for build to succeed.
 
 Make sure the db/functions directory is on the MySQL server's library
 path and restart the MySQL server. 
@@ -49,6 +54,27 @@ $ mysql -u <uid> -p openstreetmap
 > create function maptile_for_point returns integer soname 'libmyosm.so';
 > exit
 
+Creating functions for PgSQL
+==============================
+
+Run this command in the db/functions directory:
+
+$ make libpgosm.so
+
+You might also need to install:
+- postgresql development libraries:    $ sudo apt-get install postgresql-server-dev-8.3
+- ruby development libraries:          $ sudo apt-get install ruby1.8-dev
+for build to succeed.
+
+Now create the function as follows:
+
+$ psql openstreetmap
+(This may need authentication or a -u <dbowneruid>)
+
+> CREATE FUNCTION maptile_for_point(int8, int8, int4) RETURNS int4 
+  AS '/path/to/rails-port/db/functions/libpgosm.so', 'maptile_for_point'
+  LANGUAGE C STRICT;
+
 Creating database skeleton tables
 ===================================
 
@@ -57,3 +83,7 @@ Run this command from the root of your rails directory:
 $ rake db:migrate
 
 This will create the db for you
+
+You will need to make sure the database connection is configured in database.yml in config directory
+You might start with example configuration provided: 
+$ cp config/mysql.example.database.yml config/database.yml