From 0a6a45bf09ad2b58b77f9fa73352fefeaa98c81b Mon Sep 17 00:00:00 2001 From: Badlop Date: Fri, 8 Feb 2008 18:28:36 +0000 Subject: [PATCH] * src/ejabberd.cfg.example: Document options to SQL keep alive interval and pool size (EJAB-206) * doc/guide.tex: Likewise * doc/guide.html: Likewise SVN Revision: 1178 --- ChangeLog | 7 +++++ doc/guide.html | 47 +++++++++++++++++++++++++----- doc/guide.tex | 63 ++++++++++++++++++++++++++++++++++++++-- src/ejabberd.cfg.example | 11 +++++++ 4 files changed, 118 insertions(+), 10 deletions(-) diff --git a/ChangeLog b/ChangeLog index 48b6091cd..b8c5df8a8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2008-02-08 Badlop + + * src/ejabberd.cfg.example: Document options to SQL keep alive + interval and pool size (EJAB-206) + * doc/guide.tex: Likewise + * doc/guide.html: Likewise + 2008-02-06 Mickael Remond * src/mod_pubsub/node_buddy.erl: Fixed typo diff --git a/doc/guide.html b/doc/guide.html index 30cc3a863..d617bed1c 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -1108,7 +1108,15 @@ database creation. Check the MySQL documentation and the tutorial {odbc_pool_size, 10}. +

You can configure an interval to make a dummy SQL request +to keep alive the connections to the database. +The default value is ’undefined’, so no keepalive requests are made. +Specify in seconds: for example 28800 means 8 hours. +

{odbc_keepalive_interval, undefined}.
+

Driver Compilation

You can skip this step if you installed ejabberd using a binary installer or @@ -1161,7 +1169,15 @@ tutorial {odbc_pool_size, 10}. +

You can configure an interval to make a dummy SQL request +to keep alive the connections to the database. +The default value is ’undefined’, so no keepalive requests are made. +Specify in seconds: for example 28800 means 8 hours. +

{odbc_keepalive_interval, undefined}.
+

Driver Compilation

You can skip this step if you installed ejabberd using a binary installer or @@ -1192,14 +1208,23 @@ and database creation. Check the PostgreSQL documentation and the tutorial 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.

+you can find information to update your database schema.

By default ejabberd opens 10 connections to the database for each virtual host. +Use this option to modify the value: +

{odbc_pool_size, 10}.
+

You can configure an interval to make a dummy SQL request +to keep alive the connections to the database. +The default value is ’undefined’, so no keepalive requests are made. +Specify in seconds: for example 28800 means 8 hours. +

{odbc_keepalive_interval, undefined}.
+

Driver Compilation

You can skip this step if you installed ejabberd using a binary installer or if the binary packages of ejabberd you are using include support for PostgreSQL.

  1. -First, install the Erlang PgSQL library from -Jungerl. Make sure the compiled +First, install the Erlang pgsql library from +ejabberd-modules SVN repository. +Make sure the compiled files are in your Erlang path; you can put them for example in the same directory as your ejabberd .beam files.
  2. Then, configure, compile and install ejabberd with ODBC support enabled @@ -1244,8 +1269,16 @@ Keep in mind that you cannot have several variants of the same module loaded!

    Using ejabberd with MySQL native driver also can help you. Note that the tutorial contains information about ejabberd’s configuration which is duplicate to -this section.

    -

    Compilation

    +this section.

    By default ejabberd opens 10 connections to the database for each virtual host. +Use this option to modify the value: +

    {odbc_pool_size, 10}.
+

    You can configure an interval to make a dummy SQL request +to keep alive the connections to the database. +The default value is ’undefined’, so no keepalive requests are made. +Specify in seconds: for example 28800 means 8 hours. +

    {odbc_keepalive_interval, undefined}.
+
    +

    Driver Compilation

    You can skip this step if you installed ejabberd using a binary installer or if the binary packages of ejabberd you are using include support for ODBC.

    1. diff --git a/doc/guide.tex b/doc/guide.tex index 630fb7fde..e172448fe 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -1317,6 +1317,20 @@ 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. +By default \ejabberd{} opens 10 connections to the database for each virtual host. +Use this option to modify the value: +\begin{verbatim} +{odbc_pool_size, 10}. +\end{verbatim} + +You can configure an interval to make a dummy SQL request +to keep alive the connections to the database. +The default value is 'undefined', so no keepalive requests are made. +Specify in seconds: for example 28800 means 8 hours. +\begin{verbatim} +{odbc_keepalive_interval, undefined}. +\end{verbatim} + \subsubsection{Driver Compilation} \label{compilemysql} \ind{MySQL!Driver Compilation} @@ -1404,6 +1418,20 @@ 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. +By default \ejabberd{} opens 10 connections to the database for each virtual host. +Use this option to modify the value: +\begin{verbatim} +{odbc_pool_size, 10}. +\end{verbatim} + +You can configure an interval to make a dummy SQL request +to keep alive the connections to the database. +The default value is 'undefined', so no keepalive requests are made. +Specify in seconds: for example 28800 means 8 hours. +\begin{verbatim} +{odbc_keepalive_interval, undefined}. +\end{verbatim} + \subsubsection{Driver Compilation} \label{compilemssql} \ind{Microsoft SQL Server!Driver Compilation} @@ -1454,6 +1482,20 @@ 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. +By default \ejabberd{} opens 10 connections to the database for each virtual host. +Use this option to modify the value: +\begin{verbatim} +{odbc_pool_size, 10}. +\end{verbatim} + +You can configure an interval to make a dummy SQL request +to keep alive the connections to the database. +The default value is 'undefined', so no keepalive requests are made. +Specify in seconds: for example 28800 means 8 hours. +\begin{verbatim} +{odbc_keepalive_interval, undefined}. +\end{verbatim} + \subsubsection{Driver Compilation} \label{compilepgsql} \ind{PostgreSQL!Driver Compilation} @@ -1463,8 +1505,9 @@ if the binary packages of \ejabberd{} you are using include support for PostgreSQL. \begin{enumerate} -\item First, install the Erlang PgSQL library from - \footahref{http://jungerl.sourceforge.net/}{Jungerl}. Make sure the compiled +\item First, install the Erlang pgsql library from + \footahref{http://www.ejabberd.im/ejabberd-modules/}{ejabberd-modules SVN repository}. + Make sure the compiled files are in your Erlang path; you can put them for example in the same directory as your \ejabberd{} .beam files. \item Then, configure, compile and install \ejabberd{} with ODBC support enabled @@ -1537,7 +1580,21 @@ of your database. Check the documentation of your database. The tutorial \footah contains information about \ejabberd{}'s configuration which is duplicate to this section. -\subsubsection{Compilation} +By default \ejabberd{} opens 10 connections to the database for each virtual host. +Use this option to modify the value: +\begin{verbatim} +{odbc_pool_size, 10}. +\end{verbatim} + +You can configure an interval to make a dummy SQL request +to keep alive the connections to the database. +The default value is 'undefined', so no keepalive requests are made. +Specify in seconds: for example 28800 means 8 hours. +\begin{verbatim} +{odbc_keepalive_interval, undefined}. +\end{verbatim} + +\subsubsection{Driver Compilation} \label{compileodbc} You can skip this step if you installed \ejabberd{} using a binary installer or diff --git a/src/ejabberd.cfg.example b/src/ejabberd.cfg.example index 8e957f38d..faa8f78fa 100644 --- a/src/ejabberd.cfg.example +++ b/src/ejabberd.cfg.example @@ -286,6 +286,17 @@ %% %%{odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}. +%% +%% Number of connections to open to the database for each virtual host +%% +%%{odbc_pool_size, 10}. + +%% +%% Interval to make a dummy SQL request to keep alive the connections +%% to the database. Specify in seconds: for example 28800 means 8 hours +%% +%%{odbc_keepalive_interval, undefined}. + %%% =============== %%% TRAFFIC SHAPERS