/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-2017 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.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>sql statement (GNU Mailutils Manual)</title>

<meta name="description" content="sql statement (GNU Mailutils Manual)">
<meta name="keywords" content="sql statement (GNU Mailutils Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<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="The-sql-Statement"></a>
<h4 class="subsection">3.2.17 The <code>sql</code> Statement</h4>
<a name="SQL-Statement"></a><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>list</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>

<dl>
<dt><a name="index-password_002dencryption"></a>Configuration: <strong>password-encryption</strong> <em><var>arg</var>;</em></dt>
<dd><p>Defines type of encryption used by the password returned by
<code>getpass</code> query (see below).  Possible arguments are:
</p>
<dl compact="compact">
<dt>plain</dt>
<dd><p>Password is in plain text.
</p>
</dd>
<dt>crypt</dt>
<dt>hash</dt>
<dd><p>Password is encrypted by system <code>crypt</code> function
(see <a href="../crypt(3)/crypt.html#crypt">crypt</a> in <cite>crypt(3) man page</cite>).
</p>
</dd>
<dt>scrambled</dt>
<dd><p>Password is encrypted by MySQL <code>password</code> function.
</p></dd>
</dl>
</dd></dl>

<dl>
<dt><a name="index-getpwnam-1"></a>Configuration: <strong>getpwnam</strong> <em><var>query</var></em></dt>
<dd><p>Defines SQL query that returns information about the given user.  The
<var>query</var> is subject to variable expansion (see <a href="Variables.html#Variables">Variables</a>).  The
only variable defined is &lsquo;<samp>$user</samp>&rsquo;, which expands to the user name.
</p>
<a name="getpw-column-names"></a><p>The query should return a single row with the following columns:
</p>
<dl compact="compact">
<dt>name</dt>
<dd><p>User name.
</p></dd>
<dt>passwd</dt>
<dd><p>User password.
</p></dd>
<dt>uid</dt>
<dd><p>UID of the user.
</p></dd>
<dt>gid</dt>
<dd><p>GID of the primary group.
</p></dd>
<dt>gecos</dt>
<dd><p>Textual description of the user.
</p></dd>
<dt>dir</dt>
<dd><p>User&rsquo;s home directory
</p></dd>
<dt>shell</dt>
<dd><p>User&rsquo;s shell program.
</p></dd>
</dl>

<p>The following columns are optional:
</p>
<dl compact="compact">
<dt>mailbox</dt>
<dd><p>Full pathname of the user&rsquo;s mailbox.  If not returned or NULL, the
mailbox is determined using the default algorithm (see <a href="Mailbox.html#Mailbox">Mailbox</a>).
</p></dd>
<dt>quota</dt>
<dd><p>Upper limit on the size of the mailbox.  The value is either an
integer number optionally followed by one of the usual size suffixes:
&lsquo;<samp>K</samp>&rsquo;, &lsquo;<samp>M</samp>&rsquo;, &lsquo;<samp>G</samp>&rsquo;, or &lsquo;<samp>T</samp>&rsquo; (case-insensitive).
</p></dd>
</dl>
</dd></dl>

<dl>
<dt><a name="index-getpwuid-1"></a>Configuration: <strong>getpwuid</strong> <em><var>query</var></em></dt>
<dd><p>Defines SQL query that returns information about the given UID.  The
<var>query</var> is subject to variable expansion (see <a href="Variables.html#Variables">Variables</a>).  The
only variable defined is &lsquo;<samp>$user</samp>&rsquo;, which expands to the UID.
</p>
<p>The query should return a single row, as described for <code>getpwnam</code>.
</p></dd></dl>

<dl>
<dt><a name="index-getpass"></a>Configuration: <strong>getpass</strong> <em><var>query</var></em></dt>
<dd><p>Defines SQL query that returns the password of the given user.  The
<var>query</var> is subject to variable expansion (see <a href="Variables.html#Variables">Variables</a>).  The
only variable defined is &lsquo;<samp>$user</samp>&rsquo;, which expands to the user name.
</p>
<p>The query should return a row with a single column, which gives the
password.  The password can be encrypted as specified by the
<code>password-encryption</code> statement.
</p></dd></dl>

<dl>
<dt><a name="index-field_002dmap"></a>Configuration: <strong>field-map</strong> <em><var>list</var></em></dt>
<dd><p>Defines a translation map for column names.   The <var>list</var> is a
list of mappings.  Each mapping is a string
&lsquo;<samp><var>name</var>=<var>column</var></samp>&rsquo;, where <var>name</var> is one of the names
described in <a href="#getpw-column-names">getpw column names</a>, and <var>column</var> is the name of
the column in the returned row that should be used instead.  The effect of
this statement is similar to that of SQL <code>AS</code> keyword.  E.g. the
statement
</p>
<div class="example">
<pre class="example">field-map (uid=user_id);
</pre></div>

<p>has the same effect as using &lsquo;<samp>SELECT user_id AS uid</samp>&rsquo; in the SQL
statement.
</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:3.4-1 / usr / share / doc / mailutils-doc / mailutils.html / sql-statement.html
