diff options
Diffstat (limited to 'doc/vmod-dbrw.3')
-rw-r--r-- | doc/vmod-dbrw.3 | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/vmod-dbrw.3 b/doc/vmod-dbrw.3 index 139fbab..6f1dba8 100644 --- a/doc/vmod-dbrw.3 +++ b/doc/vmod-dbrw.3 @@ -10,13 +10,13 @@ .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with vmod-dbrw. If not, see <http://www.gnu.org/licenses/>. -.TH VMOD-DBRW 1 "August 5, 2017" "VMOD-DBRW" "User Reference" +.TH VMOD-DBRW 1 "January 30, 2018" "VMOD-DBRW" "User Reference" .SH NAME vmod-dbrw \- Database-driven rewrite rules for Varnish Cache .SH SYNOPSIS .B import dbrw; .PP .BI "VOID dbrw.config(STRING " dbtype ", STRING " params ", STRING " query ");" @@ -96,12 +96,24 @@ options file supplied with the \fBconfig\fR parameter. Default section name is \fBclient\fR. .TP \fBcacert\fR=\fIFILE\fR Use secure connection to the database server via SSL. The \fIFILE\fR is a full pathname to the certificate authority file. .TP +\fBtimeout\fR=\fIN\fR +Sets idle timeout for a single connection (seconds). The connection +will be closed and opened again if the module is to use it after +\fIN\fR or more seconds since its last use. Set \fBtimeout=-1\fR to +disable idle timeout (sessions will remain open until the SQL +server closes them). Set \fBtimeout=0\fR to close the connection after +each request (not recommended). + +The default depends on the selected SQL backend. For MySQL, it equals +the value of the \fBwait_timeout\fR global variable. For PostgreSQL, +it is \fB-1\fR. +.TP \fBoptions\fR=\fISTRING\fR (\fBPostgres\fR-specific) Connection options. .TP \fBuser\fR=\fINAME\fR Database user name. .TP |