/usr/share/doc/mailutils-doc/mailutils.html/SQL-Statement.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Published by the Free Software Foundation,
51 Franklin Street, Fifth Floor
Boston, MA 02110-1301, USA

Copyright (C) 1999-2004, 2008-2012, 2014-2015 Free Software
Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover, and no Back-Cover texts.
A copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 6.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Mailutils Manual: SQL Statement</title>

<meta name="description" content="GNU Mailutils Manual: SQL Statement">
<meta name="keywords" content="GNU Mailutils Manual: SQL Statement">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="configuration.html#configuration" rel="up" title="configuration">
<link href="LDAP-Statement.html#LDAP-Statement" rel="next" title="LDAP Statement">
<link href="Radius-Statement.html#Radius-Statement" rel="prev" title="Radius Statement">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="SQL-Statement"></a>
<div class="header">
<p>
Next: <a href="LDAP-Statement.html#LDAP-Statement" accesskey="n" rel="next">LDAP Statement</a>, Previous: <a href="Radius-Statement.html#Radius-Statement" accesskey="p" rel="prev">Radius Statement</a>, Up: <a href="configuration.html#configuration" accesskey="u" rel="up">configuration</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="SQL-Statement-1"></a>
<h4 class="subsection">2.2.15 SQL Statement</h4>

<table class="cartouche" border="1"><tr><td>
<div align="center"><strong>Editor&rsquo;s note:</strong>
</div><p>The information in this node may be obsolete or
otherwise inaccurate.  This message will disappear, once this node revised.
</p></td></tr></table>
<a name="index-sql"></a>
<a name="Syntax-13"></a>
<h4 class="subheading">Syntax</h4>
<div class="example">
<pre class="example">sql {
  # <span class="roman">Set SQL interface to use.</span>
  interface &lsquo;<samp>mysql|odbc|postgres</samp>&rsquo;;
  # <span class="roman">SQL server host name.</span>
  host <var>arg</var>;
  # <span class="roman">SQL user name.</span>
  user <var>arg</var>;
  # <span class="roman">Password for the SQL user.</span>
  passwd <var>arg</var>;
  # <span class="roman">SQL server port.</span>
  port <var>arg</var>;
  # <span class="roman">Database name.</span>
  db <var>arg</var>;
  # <span class="roman">Type of password returned by getpass query.</span>
  password-type &lsquo;<samp>plain | hash | scrambled</samp>&rsquo;;
  # <span class="roman">Set a field-map for parsing SQL replies.</span>
  field-map <var>map</var>;
  # <span class="roman">SQL query returning the user&rsquo;s password.</span>
  getpass <var>query</var>;
  # <span class="roman">SQL query to use for getpwnam requests.</span>
  getpwnam <var>query</var>;
  # <span class="roman">SQL query to use for getpwuid requests.</span>
  getpwuid <var>query</var>;
}
</pre></div>
<a name="Description-11"></a>
<h4 class="subheading">Description</h4>

<p>The <code>sql</code> statement configures access credentials to
<acronym>SQL</acronym> database and the queries for authentication and
authorization.
</p>
<p>GNU Mailutils supports three types of <acronym>SQL</acronym> interfaces:
MySQL, PostgreSQL and ODBC.  The latter is a standard API for using
database management systems, which can be used to communicate with a
wide variety of DBMS.
</p>
<dl>
<dt><a name="index-interface"></a>Configuration: <strong>interface</strong> <em><var>type</var></em></dt>
<dd><p>Configures type of DBMS interface.  Allowed values for <var>type</var> are:
</p>
<dl compact="compact">
<dt>mysql</dt>
<dd><p>Interface with a MySQL server (<a href="http://www.mysql.org">http://www.mysql.org</a>).
</p>
</dd>
<dt>odbc</dt>
<dd><p>Use ODBC interface.  See <a href="http://www.unixodbc.org">http://www.unixodbc.org</a>, for a detailed
description of ODBC configuration.
</p>
</dd>
<dt>postgres</dt>
<dd><p>Interface with a PostgreSQL server (<a href="http://www.postgres.org">http://www.postgres.org</a>).
</p></dd>
</dl>
</dd></dl>

<p>The database and database access credentials are configured using the
following statements:
</p>
<dl>
<dt><a name="index-host"></a>Configuration: <strong>host</strong> <em><var>arg</var></em></dt>
<dd><p>The host running the <acronym>SQL</acronym> server.  The value can be either a
host name or an IP address in dotted-quad notation, in which case an
<acronym>INET</acronym> connection is used, or a full pathname to a file, in
which case a connection to <acronym>UNIX</acronym> socket is used.
</p></dd></dl>

<dl>
<dt><a name="index-port-1"></a>Configuration: <strong>port</strong> <em><var>arg</var></em></dt>
<dd><p>TCP port the server is listening on (for <acronym>INET</acronym>
connections).  This parameter is optional.  Its default value depends on
the type of database being used.
</p></dd></dl>

<dl>
<dt><a name="index-db"></a>Configuration: <strong>db</strong> <em><var>arg</var>;</em></dt>
<dd><p>Name of the database.
</p></dd></dl>

<dl>
<dt><a name="index-user"></a>Configuration: <strong>user</strong> <em><var>arg</var></em></dt>
<dd><p><acronym>SQL</acronym> user name.
</p></dd></dl>
  
<dl>
<dt><a name="index-passwd"></a>Configuration: <strong>passwd</strong> <em><var>arg</var>;</em></dt>
<dd><p>Password to access the database.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="LDAP-Statement.html#LDAP-Statement" accesskey="n" rel="next">LDAP Statement</a>, Previous: <a href="Radius-Statement.html#Radius-Statement" accesskey="p" rel="prev">Radius Statement</a>, Up: <a href="configuration.html#configuration" accesskey="u" rel="up">configuration</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
mailutils-doc 1:2.99.99-1ubuntu2 / usr / share / doc / mailutils-doc / mailutils.html / SQL-Statement.html
