From 33feca74ecd92c2907290f55f37b7736b4b37ec3 Mon Sep 17 00:00:00 2001 From: Badlop Date: Thu, 10 Mar 2011 20:28:46 +0100 Subject: [PATCH] Document that ODBC tables are created by ejabberd itself (EJAB-1421) --- doc/guide.tex | 30 +++++++++++++++--------------- doc/release_notes_3.0.0.txt | 6 +++--- src/odbc/mssql2000.sql | 5 +++++ src/odbc/mssql2005.sql | 5 +++++ src/odbc/mysql.sql | 5 +++++ src/odbc/pg.sql | 5 +++++ 6 files changed, 38 insertions(+), 18 deletions(-) diff --git a/doc/guide.tex b/doc/guide.tex index 381eef342..58f11f76a 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -1920,7 +1920,9 @@ produces this result after being interpreted: \ind{database} %TODO: this whole section is not yet 100% optimized -\ejabberd{} uses its internal Mnesia database by default. However, it is +\ejabberd{} uses the Erlang/OTP internal +\footahref{http://www.erlang.org/doc/apps/mnesia/index.html}{Mnesia} +database by default. However, it is possible to use a relational database or an LDAP server to store persistent, long-living data. \ejabberd{} is very flexible: you can configure different authentication methods for different virtual hosts, you can configure different @@ -1929,13 +1931,13 @@ different storage systems for modules, and so forth. The following databases are supported by \ejabberd{}: \begin{itemize} -\item \footahref{http://www.microsoft.com/sql/}{Microsoft SQL Server} -\item \footahref{http://www.erlang.org/doc/apps/mnesia/index.html}{Mnesia} -\item \footahref{http://www.mysql.com/}{MySQL} -\item \footahref{http://en.wikipedia.org/wiki/Open\_Database\_Connectivity}{Any ODBC compatible database} -\item \footahref{http://www.postgresql.org/}{PostgreSQL} +\item \footahref{http://www.mysql.com/}{MySQL}, see section~\ref{mysql} +\item \footahref{http://www.postgresql.org/}{PostgreSQL}, see section~\ref{pgsql} +\item \footahref{http://www.microsoft.com/sql/}{Microsoft SQL Server}, see section~\ref{mssql} +\item \footahref{http://en.wikipedia.org/wiki/Open\_Database\_Connectivity}{Any ODBC compatible database}, see section~\ref{odbc} \end{itemize} +For LDAP configuration details, see section~\ref{ldap}. The following LDAP servers are tested with \ejabberd{}: \begin{itemize} \item \footahref{http://www.microsoft.com/activedirectory/}{Active Directory} @@ -1970,9 +1972,8 @@ database creation. Check the MySQL documentation and the tutorial \footahref{htt Note that the tutorial contains information about \ejabberd{}'s configuration which is duplicate to this section. -Moreover, the file mysql.sql in the directory src/odbc might be interesting for -you. This file contains the \ejabberd{} schema for MySQL. At the end of the file -you can find information to update your database schema. +ejabberd automatically creates the tables and updates their schema if needed. +The file mysql.sql in the directory src/odbc is provided only as reference. \makesubsubsection{compilemysql}{Driver Compilation} @@ -2063,9 +2064,8 @@ tutorial \footahref{http://support.process-one.net/doc/display/MESSENGER/Using+e Note that the tutorial contains information about \ejabberd{}'s configuration which is duplicate to this section. -Moreover, the file mssql.sql in the directory src/odbc might be interesting for -you. This file contains the \ejabberd{} schema for Microsoft SQL Server. At the end -of the file you can find information to update your database schema. +ejabberd automatically creates the tables and updates their schema if needed. +The file mssql.sql in the directory src/odbc is provided only as reference. \makesubsubsection{compilemssql}{Driver Compilation} @@ -2115,9 +2115,8 @@ and database creation. Check the PostgreSQL documentation and the tutorial \foot Note that the tutorial contains information about \ejabberd{}'s configuration which is duplicate to this section. -Also the file pg.sql in the directory src/odbc might be interesting for you. -This file contains the \ejabberd{} schema for PostgreSQL. At the end of the file -you can find information to update your database schema. +ejabberd automatically creates the tables and updates their schema if needed. +The file pg.sql in the directory src/odbc is provided only as reference. \makesubsubsection{compilepgsql}{Driver Compilation} @@ -2204,6 +2203,7 @@ of your database. Check the documentation of your database. The tutorial \footah contains information about \ejabberd{}'s configuration which is duplicate to this section. +ejabberd automatically creates the tables and updates their schema if needed. \makesubsubsection{compileodbc}{Driver Compilation} diff --git a/doc/release_notes_3.0.0.txt b/doc/release_notes_3.0.0.txt index 0791ac995..e33cfcbe0 100644 --- a/doc/release_notes_3.0.0.txt +++ b/doc/release_notes_3.0.0.txt @@ -37,9 +37,9 @@ ejabberd 3.0.0 includes three major changes: * gen_storage (abbreviated GS) provides a database abstraction layer, which supports storage in Mnesia and in ODBC databases. Several ejabberd modules use GS, like mod_roster and ejabberd_auth_storage. - The schema of the tables stored by those modules have changed, - and ejabberd migrates automatically your mnesia and ODBC - tables from previous ejabberd releases. + The schema of the tables stored by those modules have changed. + ejabberd automatically creates mnesia and ODBC tables, + and migrates them from a previous ejabberd version. * Massive Hosting (abbreviated MH) is preliminary implemented in ejabberd, but it is still incomplete, untested and undocumented. diff --git a/src/odbc/mssql2000.sql b/src/odbc/mssql2000.sql index f8c456970..da38f5076 100644 --- a/src/odbc/mssql2000.sql +++ b/src/odbc/mssql2000.sql @@ -18,6 +18,11 @@ * */ +/* WARNING !!! + * ejabberd creates the tables automatically. + * This file is obsolete. + * Read the ejabberd modules source code for up-to-date table schema. */ + SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON diff --git a/src/odbc/mssql2005.sql b/src/odbc/mssql2005.sql index 8420b7690..b9053d89e 100644 --- a/src/odbc/mssql2005.sql +++ b/src/odbc/mssql2005.sql @@ -18,6 +18,11 @@ * */ +/* WARNING !!! + * ejabberd creates the tables automatically. + * This file is obsolete. + * Read the ejabberd modules source code for up-to-date table schema. */ + SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON diff --git a/src/odbc/mysql.sql b/src/odbc/mysql.sql index 2e2d672fb..891b4a3ee 100644 --- a/src/odbc/mysql.sql +++ b/src/odbc/mysql.sql @@ -17,6 +17,11 @@ -- 02111-1307 USA -- +-- WARNING !!! +-- ejabberd creates the tables automatically. +-- This file is obsolete. +-- Read the ejabberd modules source code for up-to-date table schema. + -- Needs MySQL (at least 4.0.x) with innodb back-end SET table_type=InnoDB; diff --git a/src/odbc/pg.sql b/src/odbc/pg.sql index 1cbd220a6..91ccc24fd 100644 --- a/src/odbc/pg.sql +++ b/src/odbc/pg.sql @@ -17,6 +17,11 @@ -- 02111-1307 USA -- +-- WARNING !!! +-- ejabberd creates the tables automatically. +-- This file is obsolete. +-- Read the ejabberd modules source code for up-to-date table schema. + CREATE TABLE users ( username text NOT NULL, host text NOT NULL,