schemas/psql-initialize.sql

   1 -- $Id: psql-initialize.sql,v 1.13 2006-12-02 22:28:31 rurban Exp $
   2
   3 \set QUIET
   4
   5 --================================================================
   6 -- Prefix for table names.
   7 --
   8 -- You should set this to the same value you specify for
   9 -- DATABASE_PREFIX in config/config.ini
  10
  11 \set prefix     ''
  12
  13 --================================================================
  14 -- Which postgres user gets access to the tables?
  15 --
  16 -- You should set this to the name of the postgres
  17 -- user who will be accessing the tables.
  18 -- See DATABASE_DSN in config.ini
  19 --
  20 -- NOTE: To be able to vacuum the tables from ordinary page requests
  21 --       :httpd_user must be the table owner.
  22 --       To run autovacuum and disable page requests vacuums edit the
  23 --       pqsql backend optimize method.
  24 --
  25 -- Commonly, connections from php are made under
  26 -- the user name of 'nobody', 'apache' or 'www'.
  27
  28 \set httpd_user 'wikiuser'
  29
  30 --================================================================
  31 --
  32 -- Don't modify below this point unless you know what you are doing.
  33 --
  34 --================================================================
  35
  36 \set qprefix '\'' :prefix '\''
  37 \set qhttp_user '\'' :httpd_user '\''
  38
  39 \echo At first init the database with:
  40 \echo '$ createdb phpwiki'
  41 \echo '$ createuser -S -R -d ' :qhttp_user
  42 \echo '$ psql -U ' :qhttp_user ' phpwiki < /usr/share/postgresql/contrib/tsearch2.sql'
  43 \echo '$ psql -U ' :qhttp_user ' phpwiki < psql-initialize.sql'
  44
  45 \echo Initializing PhpWiki tables with:
  46 \echo '       prefix = ' :qprefix
  47 \echo '   httpd_user = ' :qhttp_user
  48 \echo
  49 \echo 'Expect some \'NOTICE:  CREATE ... will create implicit sequence/index ...\' messages '
  50
  51 \set page_tbl           :prefix 'page'
  52 \set page_id_seq        :prefix 'page_id_seq'
  53 \set page_id_idx        :prefix 'page_id_idx'
  54 \set page_name_idx      :prefix 'page_name_idx'
  55
  56 \set version_tbl        :prefix 'version'
  57 \set vers_id_idx        :prefix 'vers_id_idx'
  58 \set vers_mtime_idx     :prefix 'vers_mtime_idx'
  59
  60 \set recent_tbl         :prefix 'recent'
  61 \set recent_id_idx      :prefix 'recent_id_idx'
  62
  63 \set nonempty_tbl       :prefix 'nonempty'
  64 \set nonmt_id_idx       :prefix 'nonmt_id_idx'
  65
  66 \set link_tbl           :prefix 'link'
  67 \set link_from_idx      :prefix 'link_from_idx'
  68 \set link_to_idx        :prefix 'link_to_idx'
  69 \set relation_idx       :prefix 'relation_idx'
  70
  71 \set session_tbl        :prefix 'session'
  72 \set sess_id_idx        :prefix 'sess_id_idx'
  73 \set sess_date_idx      :prefix 'sess_date_idx'
  74 \set sess_ip_idx        :prefix 'sess_ip_idx'
  75
  76 \set pref_tbl           :prefix 'pref'
  77 \set pref_id_idx        :prefix 'pref_id_idx'
  78 --\set user_tbl                 :prefix 'users'
  79 --\set user_id_idx      :prefix 'users_id_idx'
  80 \set member_tbl         :prefix 'member'
  81 \set member_id_idx      :prefix 'member_id_idx'
  82 \set member_group_idx   :prefix 'member_group_idx'
  83
  84 \set rating_tbl         :prefix 'rating'
  85 \set rating_id_idx      :prefix 'rating_id_idx'
  86
  87 \set accesslog_tbl      :prefix 'accesslog'
  88 \set accesslog_time_idx :prefix 'log_time_idx'
  89 \set accesslog_host_idx :prefix 'log_host_idx'
  90
  91 \echo Creating :page_tbl
  92 CREATE TABLE :page_tbl (
  93         id              SERIAL PRIMARY KEY,
  94         pagename        VARCHAR(100) NOT NULL UNIQUE CHECK (pagename <> ''),
  95         hits            INT4 NOT NULL DEFAULT 0,
  96         pagedata        TEXT NOT NULL DEFAULT '',
  97         cached_html     bytea DEFAULT ''
  98 );
  99 -- CREATE UNIQUE INDEX :page_id_idx ON :page_tbl (id);
 100 -- CREATE UNIQUE INDEX :page_name_idx ON :page_tbl (pagename);
 101
 102 \echo Creating :version_tbl
 103 CREATE TABLE :version_tbl (
 104         id              INT4 REFERENCES :page_tbl ON DELETE CASCADE,
 105         version         INT4 NOT NULL,
 106         mtime           INT4 NOT NULL,
 107 -- FIXME: should use boolean, but that returns 't' or 'f'. not 0 or 1.
 108         minor_edit      INT2 DEFAULT 0,
 109 -- use bytea instead?
 110         content         TEXT NOT NULL DEFAULT '',
 111         versiondata     TEXT NOT NULL DEFAULT ''
 112 );
 113 CREATE UNIQUE INDEX :vers_id_idx ON :version_tbl (id, version);
 114 CREATE INDEX :vers_mtime_idx ON :version_tbl (mtime);
 115 -- deletion order: version, recent, nonempty
 116
 117 \echo Creating :recent_tbl
 118 CREATE TABLE :recent_tbl (
 119         id              INT4 REFERENCES :page_tbl ON DELETE CASCADE,
 120         latestversion   INT4,
 121         latestmajor     INT4,
 122         latestminor     INT4,
 123         FOREIGN KEY (id, latestversion) REFERENCES :version_tbl (id, version) ON DELETE CASCADE,
 124         CHECK (latestminor >= latestmajor)
 125 );
 126 CREATE UNIQUE INDEX :recent_id_idx ON :recent_tbl (id);
 127 CREATE INDEX recent_latestversion_idx ON :recent_tbl (latestversion);
 128
 129 \echo Creating :nonempty_tbl
 130 CREATE TABLE :nonempty_tbl (
 131         id              INT4 NOT NULL REFERENCES :page_tbl ON DELETE CASCADE
 132 );
 133 CREATE UNIQUE INDEX :nonmt_id_idx ON :nonempty_tbl (id);
 134
 135 \echo Creating experimental pagedata (not yet used)
 136 CREATE TABLE pagedata (
 137         id      INT4 NOT NULL REFERENCES :page_tbl ON DELETE CASCADE,
 138         date    INT4,
 139         locked  BOOLEAN,
 140         rest    TEXT NOT NULL DEFAULT ''
 141 );
 142 CREATE INDEX pagedata_id_idx ON pagedata (id);
 143
 144 \echo Creating experimental versiondata (not yet used)
 145 CREATE TABLE versiondata (
 146         id        INT4 NOT NULL,
 147         version   INT4 NOT NULL,
 148         markup    INT2 DEFAULT 2,
 149         author    VARCHAR(48),
 150         author_id VARCHAR(48),
 151         pagetype  VARCHAR(20) DEFAULT 'wikitext',
 152         rest      TEXT NOT NULL DEFAULT '',
 153         FOREIGN KEY (id, version) REFERENCES :version_tbl (id, version)
 154 );
 155 \echo Creating experimental pageperm (not yet used)
 156 CREATE TABLE pageperm (
 157         id       INT4 NOT NULL REFERENCES :page_tbl(id) ON DELETE CASCADE,
 158         -- view,edit,create,list,remove,change,dump
 159         access   CHAR(12) NOT NULL,
 160         groupname VARCHAR(48),
 161         allowed  BOOLEAN
 162 );
 163 CREATE INDEX pageperm_id_idx ON pageperm (id);
 164 CREATE INDEX pageperm_access_idx ON pageperm (access);
 165
 166 \echo Creating experimental page views (not yet used)
 167
 168 -- nonempty versiondata
 169 CREATE VIEW existing_page AS
 170   SELECT * FROM :page_tbl P INNER JOIN :nonempty_tbl N USING (id);
 171
 172 -- latest page version
 173 CREATE VIEW curr_page AS
 174   SELECT P.id,P.pagename,P.hits,P.pagedata,P.cached_html,
 175          V.version,V.mtime,V.minor_edit,V.content,V.versiondata
 176   FROM :page_tbl P
 177     JOIN :version_tbl V USING (id)
 178     JOIN :recent_tbl  R ON (V.id=R.id AND V.version=R.latestversion);
 179
 180 \echo Creating :link_tbl
 181 CREATE TABLE :link_tbl (
 182         linkfrom  INT4 NOT NULL REFERENCES :page_tbl,
 183         linkto    INT4 NOT NULL REFERENCES :page_tbl,
 184         relation  INT4
 185 );
 186 CREATE INDEX :link_from_idx ON :link_tbl (linkfrom);
 187 CREATE INDEX :link_to_idx   ON :link_tbl (linkto);
 188 CREATE INDEX :relation_idx  ON :link_tbl (relation);
 189 -- update:
 190 -- ALTER TABLE link DROP CONSTRAINT link_relation_fkey;
 191
 192 -- if you plan to use the wikilens theme
 193 \echo Creating :rating_tbl
 194 CREATE TABLE :rating_tbl (
 195         dimension    INTEGER NOT NULL,
 196         raterpage    INT8 NOT NULL REFERENCES :page_tbl ON DELETE CASCADE,
 197         rateepage    INT8 NOT NULL REFERENCES :page_tbl ON DELETE CASCADE,
 198         ratingvalue  FLOAT NOT NULL,
 199         rateeversion INT8 NOT NULL,
 200         tstamp       TIMESTAMP NOT NULL
 201 );
 202 CREATE UNIQUE INDEX :rating_id_idx ON :rating_tbl (dimension, raterpage, rateepage);
 203
 204 --================================================================
 205 -- end of page relations
 206 --================================================================
 207
 208 \echo Creating :session_tbl
 209 CREATE TABLE :session_tbl (
 210         sess_id         CHAR(32) PRIMARY KEY,
 211         sess_data       bytea NOT NULL,
 212         sess_date       INT4,
 213         sess_ip         CHAR(40) NOT NULL
 214 );
 215 -- CREATE UNIQUE INDEX :sess_id_idx ON :session_tbl (sess_id);
 216 CREATE INDEX :sess_date_idx ON :session_tbl (sess_date);
 217 CREATE INDEX :sess_ip_idx   ON :session_tbl (sess_ip);
 218
 219 -- Optional DB Auth and Prefs
 220 -- For these tables below the default table prefix must be used
 221 -- in the DBAuthParam SQL statements also.
 222
 223 \echo Creating :pref_tbl
 224 CREATE TABLE :pref_tbl (
 225         userid    CHAR(48) PRIMARY KEY,
 226         prefs     TEXT NULL DEFAULT '',
 227         passwd    CHAR(48) DEFAULT '',
 228         groupname CHAR(48) DEFAULT 'users'
 229 );
 230 -- CREATE UNIQUE INDEX :pref_id_idx ON :pref_tbl (userid);
 231 CREATE INDEX pref_group_idx ON :pref_tbl (groupname);
 232
 233 -- Use the member table, if you need it for n:m user-group relations,
 234 -- and adjust your DBAUTH_AUTH_ SQL statements.
 235 CREATE TABLE :member_tbl (
 236         userid    CHAR(48) NOT NULL REFERENCES :pref_tbl ON DELETE CASCADE,
 237         groupname CHAR(48) NOT NULL DEFAULT 'users'
 238 );
 239 CREATE INDEX :member_id_idx    ON :member_tbl (userid);
 240 CREATE INDEX :member_group_idx ON :member_tbl (groupname);
 241
 242 -- if ACCESS_LOG_SQL > 0
 243 -- only if you need fast log-analysis (spam prevention, recent referrers)
 244 -- see http://www.outoforder.cc/projects/apache/mod_log_sql/docs-2.0/#id2756178
 245 \echo Creating :accesslog_tbl
 246 CREATE TABLE :accesslog_tbl (
 247         time_stamp       INT,
 248         remote_host      VARCHAR(50),
 249         remote_user      VARCHAR(50),
 250         request_method   VARCHAR(10),
 251         request_line     VARCHAR(255),
 252         request_args     VARCHAR(255),
 253         request_file     VARCHAR(255),
 254         request_uri      VARCHAR(255),
 255         request_time     CHAR(28),
 256         status           INT2,
 257         bytes_sent       INT4,
 258         referer          VARCHAR(255),
 259         agent            VARCHAR(255),
 260         request_duration FLOAT
 261 );
 262 CREATE INDEX :accesslog_time_idx ON :accesslog_tbl (time_stamp);
 263 CREATE INDEX :accesslog_host_idx ON :accesslog_tbl (remote_host);
 264 -- create extra indices on demand (usually referer. see plugin/AccessLogSql)
 265
 266 --================================================================
 267
 268 -- Use the tsearch2 fulltextsearch extension: (recommended) 7.4, 8.0, 8.1
 269 -- at first init it for the database:
 270 -- $ psql phpwiki < /usr/share/postgresql/contrib/tsearch2.sql
 271
 272 -- example of ISpell dictionary
 273 --   UPDATE pg_ts_dict SET dict_initoption='DictFile="/usr/local/share/ispell/russian.dict" ,AffFile ="/usr/local/share/ispell/russian.aff", StopFile="/usr/local/share/ispell/russian.stop"' WHERE dict_name='ispell_template';
 274 -- example of synonym dict
 275 --   UPDATE pg_ts_dict SET dict_initoption='/usr/local/share/ispell/english.syn' WHERE dict_id=5;
 276
 277 \echo Initializing tsearch2 indices
 278 GRANT SELECT ON pg_ts_dict, pg_ts_parser, pg_ts_cfg, pg_ts_cfgmap TO :httpd_user;
 279 ALTER TABLE :version_tbl ADD COLUMN idxFTI tsvector;
 280 UPDATE :version_tbl SET idxFTI=to_tsvector('default', content);
 281 VACUUM FULL ANALYZE;
 282 CREATE INDEX idxFTI_idx ON :version_tbl USING gist(idxFTI);
 283 VACUUM FULL ANALYZE;
 284 CREATE TRIGGER tsvectorupdate BEFORE UPDATE OR INSERT ON :version_tbl
 285        FOR EACH ROW EXECUTE PROCEDURE tsearch2(idxFTI, content);
 286
 287 --================================================================
 288
 289 \echo You might want to ignore the following errors or run
 290 \echo /usr/sbin/createuser -S -R -d  :httpd_user
 291
 292 \echo Applying permissions for role :httpd_user
 293 GRANT SELECT,INSERT,UPDATE,DELETE ON :page_tbl          TO :httpd_user;
 294 GRANT SELECT,INSERT,UPDATE,DELETE ON :version_tbl       TO :httpd_user;
 295 GRANT SELECT,INSERT,UPDATE,DELETE ON :recent_tbl        TO :httpd_user;
 296 GRANT SELECT,INSERT,UPDATE,DELETE ON :nonempty_tbl      TO :httpd_user;
 297 GRANT SELECT,INSERT,UPDATE,DELETE ON :link_tbl          TO :httpd_user;
 298
 299 GRANT SELECT,INSERT,UPDATE,DELETE ON :session_tbl       TO :httpd_user;
 300 -- you may want to fine tune this:
 301 GRANT SELECT,INSERT,UPDATE,DELETE ON :pref_tbl          TO :httpd_user;
 302 -- GRANT SELECT ON :user_tbl    TO :httpd_user;
 303 GRANT SELECT ON :member_tbl     TO :httpd_user;
 304 GRANT SELECT,INSERT,UPDATE,DELETE ON :rating_tbl        TO :httpd_user;
 305 GRANT SELECT,INSERT,UPDATE,DELETE ON :accesslog_tbl     TO :httpd_user;
 306
 307 --================================================================
 308 -- some stored procedures to put unneccesary syntax into the server
 309
 310 \echo Initializing stored procedures
 311
 312 DROP FUNCTION update_recent (INT4, INT4);
 313 -- id, version
 314 CREATE OR REPLACE FUNCTION update_recent (INT4, INT4)
 315         RETURNS integer AS $$
 316 DELETE FROM recent WHERE id = $1;
 317 INSERT INTO recent (id, latestversion, latestmajor, latestminor)
 318   SELECT id, MAX(version) AS latestversion,
 319              MAX(CASE WHEN minor_edit =  0 THEN version END) AS latestmajor,
 320              MAX(CASE WHEN minor_edit <> 0 THEN version END) AS latestminor
 321     FROM version WHERE id = $2 GROUP BY id;
 322 DELETE FROM nonempty WHERE id = $1;
 323 INSERT INTO nonempty (id)
 324   SELECT recent.id
 325     FROM recent, version
 326     WHERE recent.id = version.id
 327           AND version = latestversion
 328           AND content <> ''
 329           AND recent.id = $1;
 330 SELECT id FROM nonempty WHERE id = $1;
 331 $$ LANGUAGE SQL;
 332
 333 DROP FUNCTION prepare_rename_page (INT4, INT4);
 334 -- oldid, newid
 335 CREATE OR REPLACE FUNCTION prepare_rename_page (INT4, INT4)
 336         RETURNS void AS $$
 337 DELETE FROM page     WHERE id = $2;
 338 DELETE FROM version  WHERE id = $2;
 339 DELETE FROM recent   WHERE id = $2;
 340 DELETE FROM nonempty WHERE id = $2;
 341 -- We have to fix all referring tables to the old id
 342 UPDATE link SET linkfrom = $1 WHERE linkfrom = $2;
 343 UPDATE link SET linkto = $1   WHERE linkto = $2;
 344 $$ LANGUAGE SQL;