schemas/psql-initialize.sql

   1 -- $Id$
   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 in lib/WikiDB/backend/*_psql.php
  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/pgsql/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 \set recent_lv_idx      :prefix 'recent_lv_idx'
  63
  64 \set nonempty_tbl       :prefix 'nonempty'
  65 \set nonmt_id_idx       :prefix 'nonmt_id_idx'
  66
  67 \set link_tbl           :prefix 'link'
  68 \set link_from_idx      :prefix 'link_from_idx'
  69 \set link_to_idx        :prefix 'link_to_idx'
  70 \set relation_idx       :prefix 'relation_idx'
  71
  72 \set pagedata_tbl       :prefix 'pagedata'
  73 \set pagedata_id_idx    :prefix 'pagedata_id_idx'
  74 \set versiondata_tbl    :prefix 'versiondata'
  75 \set pageperm_tbl       :prefix 'pageperm'
  76 \set pageperm_id_idx    :prefix 'pageperm_id_idx'
  77 \set pageperm_access_idx :prefix 'pageperm_access_idx'
  78 \set existing_page_view :prefix 'existing_page'
  79 \set curr_page_view     :prefix 'curr_page'
  80
  81 \set session_tbl        :prefix 'session'
  82 \set sess_id_idx        :prefix 'sess_id_idx'
  83 \set sess_date_idx      :prefix 'sess_date_idx'
  84 \set sess_ip_idx        :prefix 'sess_ip_idx'
  85
  86 \set pref_tbl           :prefix 'pref'
  87 \set pref_id_idx        :prefix 'pref_id_idx'
  88 --\set user_tbl                 :prefix 'users'
  89 --\set user_id_idx      :prefix 'users_id_idx'
  90 \set member_tbl         :prefix 'member'
  91 \set member_id_idx      :prefix 'member_id_idx'
  92 \set member_group_idx   :prefix 'member_group_idx'
  93
  94 \set rating_tbl         :prefix 'rating'
  95 \set rating_id_idx      :prefix 'rating_id_idx'
  96
  97 \set accesslog_tbl      :prefix 'accesslog'
  98 \set accesslog_time_idx :prefix 'log_time_idx'
  99 \set accesslog_host_idx :prefix 'log_host_idx'
 100
 101 \set update_recent_fn   :prefix 'update_recent'
 102 \set prepare_rename_fn  :prefix 'prepare_rename_page'
 103
 104 \echo Creating :page_tbl
 105 CREATE TABLE :page_tbl (
 106         id              SERIAL PRIMARY KEY,
 107         pagename        VARCHAR(100) NOT NULL UNIQUE CHECK (pagename <> ''),
 108         hits            INT4 NOT NULL DEFAULT 0,
 109         pagedata        TEXT NOT NULL DEFAULT '',
 110         --cached_html   bytea DEFAULT ''
 111         cached_html     TEXT DEFAULT ''
 112 );
 113 -- CREATE UNIQUE INDEX :page_id_idx ON :page_tbl (id);
 114 -- CREATE UNIQUE INDEX :page_name_idx ON :page_tbl (pagename);
 115
 116 -- we use 0 <=> global_data to satisfy the relation = 0 constraint
 117 INSERT INTO :page_tbl VALUES (0,'global_data',0,'','');
 118
 119 \echo Creating :version_tbl
 120 CREATE TABLE :version_tbl (
 121         id              INT4 REFERENCES :page_tbl,
 122         version         INT4 NOT NULL,
 123         mtime           INT4 NOT NULL,
 124 -- FIXME: should use boolean, but that returns 't' or 'f'. not 0 or 1.
 125         minor_edit      INT2 DEFAULT 0,
 126 -- use bytea instead?
 127         content         TEXT NOT NULL DEFAULT '',
 128         versiondata     TEXT NOT NULL DEFAULT ''
 129 );
 130 CREATE UNIQUE INDEX :vers_id_idx ON :version_tbl (id, version);
 131 CREATE INDEX :vers_mtime_idx ON :version_tbl (mtime);
 132 -- deletion order: version, recent, nonempty
 133
 134 \echo Creating :recent_tbl
 135 CREATE TABLE :recent_tbl (
 136         id              INT4 REFERENCES :page_tbl,
 137         latestversion   INT4,
 138         latestmajor     INT4,
 139         latestminor     INT4,
 140         FOREIGN KEY (id, latestversion) REFERENCES :version_tbl (id, version),
 141         CHECK (latestminor >= latestmajor)
 142 );
 143 CREATE UNIQUE INDEX :recent_id_idx ON :recent_tbl (id);
 144 CREATE INDEX :recent_lv_idx ON :recent_tbl (latestversion);
 145
 146 \echo Creating :nonempty_tbl
 147 CREATE TABLE :nonempty_tbl (
 148         id              INT4 NOT NULL REFERENCES :page_tbl
 149 );
 150 CREATE UNIQUE INDEX :nonmt_id_idx ON :nonempty_tbl (id);
 151
 152 \echo Creating experimental pagedata (not yet used)
 153 CREATE TABLE :pagedata_tbl (
 154         id      INT4 NOT NULL REFERENCES :page_tbl,
 155         date    INT4,
 156         locked  BOOLEAN,
 157         rest    TEXT NOT NULL DEFAULT ''
 158 );
 159 CREATE INDEX :pagedata_id_idx ON pagedata (id);
 160
 161 \echo Creating experimental versiondata (not yet used)
 162 CREATE TABLE :versiondata_tbl (
 163         id        INT4 NOT NULL,
 164         version   INT4 NOT NULL,
 165         markup    INT2 DEFAULT 2,
 166         author    VARCHAR(48),
 167         author_id VARCHAR(48),
 168         pagetype  VARCHAR(20) DEFAULT 'wikitext',
 169         rest      TEXT NOT NULL DEFAULT '',
 170         FOREIGN KEY (id, version) REFERENCES :version_tbl (id, version)
 171 );
 172 \echo Creating experimental pageperm (not yet used)
 173 CREATE TABLE :pageperm_tbl (
 174         id       INT4 NOT NULL REFERENCES :page_tbl(id),
 175         -- view,edit,create,list,remove,change,dump
 176         access   CHAR(12) NOT NULL,
 177         groupname VARCHAR(48),
 178         allowed  BOOLEAN
 179 );
 180 CREATE INDEX :pageperm_id_idx ON pageperm (id);
 181 CREATE INDEX :pageperm_access_idx ON pageperm (access);
 182
 183 \echo Creating experimental page views (not yet used)
 184
 185 -- nonempty versiondata
 186 CREATE VIEW :existing_page_view AS
 187   SELECT * FROM :page_tbl P INNER JOIN :nonempty_tbl N USING (id);
 188
 189 -- latest page version
 190 CREATE VIEW :curr_page_view AS
 191   SELECT P.id,P.pagename,P.hits,P.pagedata,P.cached_html,
 192          V.version,V.mtime,V.minor_edit,V.content,V.versiondata
 193   FROM :page_tbl P
 194     JOIN :version_tbl V USING (id)
 195     JOIN :recent_tbl  R ON (V.id=R.id AND V.version=R.latestversion);
 196
 197 \echo Creating :link_tbl
 198 CREATE TABLE :link_tbl (
 199         linkfrom  INT4 NOT NULL REFERENCES :page_tbl,
 200         linkto    INT4 NOT NULL REFERENCES :page_tbl,
 201         relation  INT4
 202 );
 203 CREATE INDEX :link_from_idx ON :link_tbl (linkfrom);
 204 CREATE INDEX :link_to_idx   ON :link_tbl (linkto);
 205 CREATE INDEX :relation_idx  ON :link_tbl (relation);
 206 -- update:
 207 -- ALTER TABLE link DROP CONSTRAINT link_relation_fkey;
 208
 209 -- if you plan to use the wikilens theme
 210 \echo Creating :rating_tbl
 211 CREATE TABLE :rating_tbl (
 212         dimension    INTEGER NOT NULL,
 213         raterpage    INT8 NOT NULL REFERENCES :page_tbl,
 214         rateepage    INT8 NOT NULL REFERENCES :page_tbl,
 215         ratingvalue  FLOAT NOT NULL,
 216         rateeversion INT8 NOT NULL,
 217         tstamp       TIMESTAMP NOT NULL
 218 );
 219 CREATE UNIQUE INDEX :rating_id_idx ON :rating_tbl (dimension, raterpage, rateepage);
 220
 221 --================================================================
 222 -- end of page relations
 223 --================================================================
 224
 225 \echo Creating :session_tbl
 226 CREATE TABLE :session_tbl (
 227         sess_id         CHAR(32) PRIMARY KEY,
 228         sess_data       bytea NOT NULL,
 229         sess_date       INT4,
 230         sess_ip         CHAR(40) NOT NULL
 231 );
 232 -- CREATE UNIQUE INDEX :sess_id_idx ON :session_tbl (sess_id);
 233 CREATE INDEX :sess_date_idx ON :session_tbl (sess_date);
 234 CREATE INDEX :sess_ip_idx   ON :session_tbl (sess_ip);
 235
 236 -- Optional DB Auth and Prefs
 237 -- For these tables below the default table prefix must be used
 238 -- in the DBAuthParam SQL statements also.
 239
 240 \echo Creating :pref_tbl
 241 CREATE TABLE :pref_tbl (
 242         userid    CHAR(48) PRIMARY KEY,
 243         prefs     TEXT NULL DEFAULT '',
 244         passwd    CHAR(48) DEFAULT '',
 245         groupname CHAR(48) DEFAULT 'users'
 246 );
 247 -- CREATE UNIQUE INDEX :pref_id_idx ON :pref_tbl (userid);
 248 CREATE INDEX pref_group_idx ON :pref_tbl (groupname);
 249
 250 -- Use the member table, if you need it for n:m user-group relations,
 251 -- and adjust your DBAUTH_AUTH_ SQL statements.
 252 CREATE TABLE :member_tbl (
 253         userid    CHAR(48) NOT NULL REFERENCES :pref_tbl,
 254         groupname CHAR(48) NOT NULL DEFAULT 'users'
 255 );
 256 CREATE INDEX :member_id_idx    ON :member_tbl (userid);
 257 CREATE INDEX :member_group_idx ON :member_tbl (groupname);
 258
 259 -- if ACCESS_LOG_SQL > 0
 260 -- only if you need fast log-analysis (spam prevention, recent referrers)
 261 -- see http://www.outoforder.cc/projects/apache/mod_log_sql/docs-2.0/#id2756178
 262 \echo Creating :accesslog_tbl
 263 CREATE TABLE :accesslog_tbl (
 264         time_stamp       INT,
 265         remote_host      VARCHAR(100),
 266         remote_user      VARCHAR(50),
 267         request_method   VARCHAR(10),
 268         request_line     VARCHAR(255),
 269         request_args     VARCHAR(255),
 270         request_file     VARCHAR(255),
 271         request_uri      VARCHAR(255),
 272         request_time     CHAR(28),
 273         status           INT2,
 274         bytes_sent       INT4,
 275         referer          VARCHAR(255),
 276         agent            VARCHAR(255),
 277         request_duration FLOAT
 278 );
 279 CREATE INDEX :accesslog_time_idx ON :accesslog_tbl (time_stamp);
 280 CREATE INDEX :accesslog_host_idx ON :accesslog_tbl (remote_host);
 281 -- create extra indices on demand (usually referer. see plugin/AccessLogSql)
 282
 283 --================================================================
 284
 285 -- Use the tsearch2 fulltextsearch extension: (recommended) 7.4, 8.0, 8.1
 286 -- at first init it for the database:
 287 -- $ psql phpwiki < /usr/share/postgresql/contrib/tsearch2.sql
 288
 289 -- example of ISpell dictionary
 290 --   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';
 291 -- example of synonym dict
 292 --   UPDATE pg_ts_dict SET dict_initoption='/usr/local/share/ispell/english.syn' WHERE dict_id=5;
 293
 294 \echo Initializing tsearch2 indices
 295 GRANT SELECT ON pg_ts_dict, pg_ts_parser, pg_ts_cfg, pg_ts_cfgmap TO :httpd_user;
 296 ALTER TABLE :version_tbl ADD COLUMN idxFTI tsvector;
 297 UPDATE :version_tbl SET idxFTI=to_tsvector('default', content);
 298 VACUUM FULL ANALYZE;
 299 CREATE INDEX idxFTI_idx ON :version_tbl USING gist(idxFTI);
 300 VACUUM FULL ANALYZE;
 301 CREATE TRIGGER tsvectorupdate BEFORE UPDATE OR INSERT ON :version_tbl
 302        FOR EACH ROW EXECUTE PROCEDURE tsearch2(idxFTI, content);
 303
 304 -- this might be needed:
 305 -- see http://www.sai.msu.su/~megera/oddmuse/index.cgi/Tsearch_V2_Notes
 306 -- update pg_ts_cfg set locale='en_US.UTF-8' where ts_name='default';
 307
 308 --================================================================
 309
 310 \echo You might want to ignore the following errors or run
 311 \echo /usr/sbin/createuser -S -R -d  :httpd_user
 312
 313 \echo Applying permissions for role :httpd_user
 314 GRANT SELECT,INSERT,UPDATE,DELETE ON :page_tbl          TO :httpd_user;
 315 GRANT SELECT,INSERT,UPDATE,DELETE ON :version_tbl       TO :httpd_user;
 316 GRANT SELECT,INSERT,UPDATE,DELETE ON :recent_tbl        TO :httpd_user;
 317 GRANT SELECT,INSERT,UPDATE,DELETE ON :nonempty_tbl      TO :httpd_user;
 318 GRANT SELECT,INSERT,UPDATE,DELETE ON :link_tbl          TO :httpd_user;
 319
 320 GRANT SELECT,INSERT,UPDATE,DELETE ON :session_tbl       TO :httpd_user;
 321 -- you may want to fine tune this:
 322 GRANT SELECT,INSERT,UPDATE,DELETE ON :pref_tbl          TO :httpd_user;
 323 -- GRANT SELECT ON :user_tbl                            TO :httpd_user;
 324 GRANT SELECT ON :member_tbl                             TO :httpd_user;
 325 GRANT SELECT,INSERT,UPDATE,DELETE ON :rating_tbl        TO :httpd_user;
 326 GRANT SELECT,INSERT,UPDATE,DELETE ON :accesslog_tbl     TO :httpd_user;
 327
 328 --================================================================
 329 -- some stored procedures to put unneccesary syntax into the server
 330
 331 \echo Initializing stored procedures
 332
 333 -- id, version
 334 CREATE OR REPLACE FUNCTION :update_recent_fn (INT4, INT4)
 335         RETURNS integer AS $$
 336 DELETE FROM recent WHERE id = $1;
 337 INSERT INTO recent (id, latestversion, latestmajor, latestminor)
 338   SELECT id, MAX(version) AS latestversion,
 339              MAX(CASE WHEN minor_edit =  0 THEN version END) AS latestmajor,
 340              MAX(CASE WHEN minor_edit <> 0 THEN version END) AS latestminor
 341     FROM version WHERE id = $2 GROUP BY id;
 342 DELETE FROM nonempty WHERE id = $1;
 343 INSERT INTO nonempty (id)
 344   SELECT recent.id
 345     FROM recent, version
 346     WHERE recent.id = version.id
 347           AND version = latestversion
 348           AND content <> ''
 349           AND recent.id = $1;
 350 SELECT id FROM nonempty WHERE id = $1;
 351 $$ LANGUAGE SQL;
 352
 353 -- oldid, newid
 354 CREATE OR REPLACE FUNCTION :prepare_rename_fn (INT4, INT4)
 355         RETURNS void AS $$
 356 DELETE FROM page     WHERE id = $2;
 357 DELETE FROM version  WHERE id = $2;
 358 DELETE FROM recent   WHERE id = $2;
 359 DELETE FROM nonempty WHERE id = $2;
 360 -- We have to fix all referring tables to the old id
 361 UPDATE link SET linkfrom = $1 WHERE linkfrom = $2;
 362 UPDATE link SET linkto = $1   WHERE linkto = $2;
 363 $$ LANGUAGE SQL;