File: msearch-cmdref-dbaddr.html

package info (click to toggle)
mnogosearch 3.3.7-3
links: PTS, VCS
area: main
in suites: lenny
size: 17,484 kB
ctags: 4,565
sloc: ansic: 94,097; xml: 16,864; sh: 8,915; makefile: 1,727; perl: 801; php: 561; sql: 15
file content (840 lines) | stat: -rw-r--r-- 15,477 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>DBAddr</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="mnoGoSearch 3.3.7 reference manual"
HREF="index.html"><LINK
REL="UP"
TITLE="mnoGoSearch commands reference"
HREF="msearch-cmdref.html"><LINK
REL="PREVIOUS"
TITLE="DateFormat"
HREF="msearch-cmdref-dateformat.html"><LINK
REL="NEXT"
TITLE="DefaultContentType"
HREF="msearch-cmdref-defaultcontenttype.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="mnogo.css"><META
NAME="Description"
CONTENT="mnoGoSearch - Full Featured Web site Open Source Search Engine Software over the Internet and Intranet Web Sites Based on SQL Database. It is a Free search software covered by GNU license."><META
NAME="Keywords"
CONTENT="shareware, freeware, download, internet, unix, utilities, search engine, text retrieval, knowledge retrieval, text search, information retrieval, database search, mining, intranet, webserver, index, spider, filesearch, meta, free, open source, full-text, udmsearch, website, find, opensource, search, searching, software, udmsearch, engine, indexing, system, web, ftp, http, cgi, php, SQL, MySQL, database, php3, FreeBSD, Linux, Unix, mnoGoSearch, MacOS X, Mac OS X, Windows, 2000, NT, 95, 98, GNU, GPL, url, grabbing"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#EEEEEE"
TEXT="#000000"
LINK="#000080"
VLINK="#800080"
ALINK="#FF0000"
><!--#include virtual="body-before.html"--><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>mnoGoSearch 3.3.7 reference manual: Full-featured search engine software</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="msearch-cmdref-dateformat.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="msearch-cmdref-defaultcontenttype.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="cmdref-dbaddr"
></A
>DBAddr</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN5060"
></A
><H2
>Name</H2
>DBAddr&nbsp;--&nbsp;sets database address<P
><B
></B
><SPAN
CLASS="application"
>indexer.conf</SPAN
> <SPAN
CLASS="application"
>search.htm</SPAN
></P
></DIV
><DIV
CLASS="refsynopsisdiv"
><A
NAME="AEN5066"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="command"
>DBAddr</B
>  {type://[user[:password]@]hostname[:port]/dbname/[?DBMode=mode][&#38;param1=value1...]}</P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN5070"
></A
><H2
>Description</H2
><P
>The <B
CLASS="command"
>DBAddr</B
> command defines a database
<SPAN
CLASS="application"
>mnoGoSearch</SPAN
> will use for indexing or search,
using URL-style notation. It must be used before any other commands,
and has global effect on the entire configuration file. Multiple
<B
CLASS="command"
>DBAddr</B
> entries are possible in the case of
a distributed search engine (see <A
HREF="msearch-cluster.html"
>the Section called <I
>mnoGoSearch cluster</I
> in Chapter 5</A
>).
</P
><P
>&#13;<SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>Type</I
></SPAN
>,
<SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>hostname</I
></SPAN
>,
<SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>dbname</I
></SPAN
>,
<SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>user</I
></SPAN
>,
<SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>password</I
></SPAN
> and
<SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>port</I
></SPAN
> are the most important
parts of a <B
CLASS="command"
>DBAddr</B
> command.
The main part of a <B
CLASS="command"
>DBAddr</B
> command can also be
followed by a number of additional parameters,
like <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>DBMode</I
></SPAN
>.
</P
><P
>&#13; The main part is separated
from the parameters part using the <TT
CLASS="literal"
>QUESTION MARK</TT
> (?),
and the parameters are separated from each other using the
<TT
CLASS="literal"
>AMPERSAND SIGN</TT
> (&#38;).
</P
><DIV
CLASS="refsect2"
><A
NAME="AEN5090"
></A
><H3
>Notes on <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>type</I
></SPAN
></H3
><P
>Currently supported <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>type</I
></SPAN
> values are
mysql, pgsql, mssql, sybase, oracle, ibase, db2, mimer, sqlite, sqlite3, cache.
</P
></DIV
><DIV
CLASS="refsect2"
><A
NAME="AEN5095"
></A
><H3
>Notes on <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>hostname</I
></SPAN
></H3
><P
>An empty host name with PostgreSQL, e.g.
<PRE
CLASS="programlisting"
>&#13;pgsql://user:password@/dbname/
</PRE
>
means that mnoGoSearch will communicate with PostgreSQL server
using a Unix socket rather than a TCP port.
</P
><P
>&#13;Hostname is not important when describing an ODBC database
(e.g. on Windows, or on Unix when mnoGoSearch is compiled
with UnixODBC or iODBC support).
Specifying ODBC Data Source Name (DSN) in the <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>dbname</I
></SPAN
> is enough,
so the <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>hostname</I
></SPAN
> can be either omitted or can be set to
"<TT
CLASS="literal"
>localhost</TT
>":
<PRE
CLASS="programlisting"
>&#13;mysql://root@/myodbc/
mysql://root@localhost/myodbc/
</PRE
>
</P
></DIV
><DIV
CLASS="refsect2"
><A
NAME="AEN5105"
></A
><H3
>Special characters in <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>user</I
></SPAN
> and <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>password</I
></SPAN
></H3
><P
>Some special characters, if they appear as a user name or in a password,
need to be escaped using %XX notation, where XX is a hex code.
Use %3A for ":", %3B for ";", %3C for "&#60;", %3D for "=", %3E 
for "&#62;", %3F for "?" and %40 for "@" characters. For example,
<PRE
CLASS="programlisting"
>&#13;DBAddr pgsql://user:pwd%3Awith%40special%3Cchars@/search/
</PRE
>
corresponds to the local PostgreSQL database "search" with
user name "user" and password "pwd:with@special&#60;chars".
</P
></DIV
><DIV
CLASS="refsect2"
><A
NAME="AEN5111"
></A
><H3
>The <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>DBMode</I
></SPAN
> parameter</H3
><P
>The "DBMode" optional parameter can be set to on
of the three values: "single", "multi" or "blob".
The default value is "single". See <A
HREF="msearch-howstore.html#sql-stor"
>the Section called <I
>SQL storage types</I
> in Chapter 5</A
> for details.
</P
></DIV
><DIV
CLASS="refsect2"
><A
NAME="AEN5116"
></A
><H3
>The <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>Socket</I
></SPAN
> parameter</H3
><P
>MySQL and PostgreSQL users can specify a path to Unix socket
when connecting to a server running on the local machine:
<PRE
CLASS="programlisting"
>&#13;DBAddr mysql://foo:bar@localhost/mnogosearch/?socket=/tmp/mysql.sock
DBAddr pgsql://foo:bar@/mnogosearch/?socket=/tmp/s.PGSQL.5432
</PRE
>
</P
></DIV
><DIV
CLASS="refsect2"
><A
NAME="AEN5121"
></A
><H3
>The <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>SetNames</I
></SPAN
> parameter</H3
><P
>MySQL and PostgreSQL users can set connection character set
by specifying the <TT
CLASS="literal"
>setnames</TT
> parameter. It is
important if the default MySQL or PostgreSQL client character set
settings do not correspond to the <A
HREF="msearch-cmdref-localcharset.html"
>LocalCharset</A
>
setting of <SPAN
CLASS="application"
>mnoGoSearch</SPAN
>.
<PRE
CLASS="programlisting"
>&#13;LocalCharset utf8
DBAddr http://root@localhost/test/?setnames=utf8
</PRE
>
If a non-empty <TT
CLASS="literal"
>setnames</TT
> value is specified,
MySQL and PostgreSQL drivers will send a <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>SET NAMES</I
></SPAN
>
query after connection is established.
</P
></DIV
><DIV
CLASS="refsect2"
><A
NAME="AEN5131"
></A
><H3
>Parameters affecting score
 (<SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>wf</I
></SPAN
> and <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>nwf</I
></SPAN
>)
</H3
><P
>Starting with 3.3.0 its possible to specify wf=XXXX parameter
for <B
CLASS="command"
>DBAddr</B
> command in search.htm.
Starting from 3.3.3, nwf=XXXX is also allowed.
These parameters are useful if you merge two or more
databases and want to give more score to results coming from a desired
database. The DBAddr parameters have higher precedence over the search query
parameters, e.g. if "wf" is specified as a DBAddr parameter, then the global
"wf" values (specified in QUERY_STRING or using <A
HREF="msearch-cmdref-wf.html"
>wf</A
>
search.htm command) are not used anymore.
Format of the "wf" and "nwf" DBAddr parameters is similar to the one described 
in <A
HREF="msearch-doingsearch.html#search-changeweight"
>the Section called <I
>Changing different document parts weights at search time</I
> in Chapter 8</A
>.
<PRE
CLASS="programlisting"
>&#13;DBAddr mysql://root@localhost/db1/?wf=FFFF
DBAddr mysql://root@localhost/db2/?wf=1111
DBAddr mysql://root@localhost/db3/?wf=1111
</PRE
>
</P
></DIV
><DIV
CLASS="refsect2"
><A
NAME="AEN5140"
></A
><H3
>The <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>MaxResults</I
></SPAN
> parameter</H3
><P
>Starting with 3.3.0, the MaxResults=num parameter was added for
DBAddr search.htm command - to specify the maxumn number of search
results to return from the database. It can be useful to add
a limited number of sponsored links in the top of search results:
<PRE
CLASS="programlisting"
>&#13;DBAddr mysql://root@localhost/avd/?wf=FFFF=1&#38;MaxResults=1
DBAddr mysql://root@localhost/db1/?wf=1111
DBAddr mysql://root@localhost/db2/?wf=1111
</PRE
>
</P
></DIV
><DIV
CLASS="refsect2"
><A
NAME="AEN5145"
></A
><H3
>The <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>DebugSQL</I
></SPAN
> parameter</H3
><P
>Starting from 3.3.3, the DebugSQL=yes/no parameter is understood.
When DebugSQL is set to <TT
CLASS="literal"
>yes</TT
>, 
<SPAN
CLASS="application"
>indexer</SPAN
> and <SPAN
CLASS="application"
>search.cgi</SPAN
>
will print all SQL queries sent to the database. mnoGoSearch must be
compiled with <TT
CLASS="literal"
>--with-debug</TT
>, otherwise DebugSQL=yes
is ignored.
<PRE
CLASS="programlisting"
>&#13;DBAddr mysql://root@localhost/test/?DebugSQL=yes
</PRE
>
</P
></DIV
><DIV
CLASS="refsect2"
><A
NAME="AEN5154"
></A
><H3
>The <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>TrackQuery</I
></SPAN
> parameter</H3
><P
>&#13;Use trackquery=yes parameter to activate tracking of search
queries. Please refer to <A
HREF="msearch-track.html"
>the Section called <I
>Search query tracking
<A
NAME="AEN3948"
></A
></I
> in Chapter 8</A
> for details
on qiery tracking.
</P
></DIV
><DIV
CLASS="refsect2"
><A
NAME="AEN5159"
></A
><H3
>Parameters related to DBMode=blob</H3
><P
>Starting with 3.2.36 <B
CLASS="command"
>DBAddr</B
> supports Deflate=yes|no parameter.
With "Deflate=yes" specified, indexer compresses data when converting
with "indexer -Eblob", which makes smaller database size and faster
search. This option is effective for DBMode=blob only. There is no need
to specify this option in search template, mnogosearch will detect and
handle compressed data automatically while searching.
<PRE
CLASS="programlisting"
>&#13;DBAddr mysql://foo:bar@localhost/mnogosearch/?DBMode=blob&#38;Deflate=yes
</PRE
>
</P
><P
>Starting with 3.2.36 <B
CLASS="command"
>DBAddr</B
> supports zint4=yes|no parameter.
With "zint4=yes" specified, indexer compresses document IDs using 
a special compression method which we called "zint4".
This compression method is as effective as possible:
it compresses data up to 85% with relative good decompression speed. In
conjunction with Deflate=yes parameter, compression ratio can be up to
99.8%. This option is effective for DBMode=blob, for '#rec_id' field only.
<PRE
CLASS="programlisting"
>&#13;DBAddr mysql://foo:bar@localhost/mnogosearch/?DBMode=blob&#38;Deflate=yes&#38;zint4=yes
</PRE
>
</P
></DIV
><DIV
CLASS="refsect2"
><A
NAME="AEN5167"
></A
><H3
>MySQL specific parameters</H3
><DIV
CLASS="refsect3"
><A
NAME="AEN5169"
></A
><H4
><SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>MyCnfGroup</I
></SPAN
> - Loading <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>my.cnf</I
></SPAN
> file</H4
><P
>When initializing connection to MySQL, mnoGoSearch
forces loading of my.cnf configuration file with the "client"
option group by default. Use <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>MyCnfGroup=group</I
></SPAN
>
to load options from another group, or <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>MyCnfGroup=no</I
></SPAN
>
to prevent loading of my.cnf file:
<PRE
CLASS="programlisting"
>&#13;# Load options from another option group
DBAddr mysql://foo:bar@localhost/mnogosearch/?MyCnfGroup=mnogosearch

# Prevent loading my.cnf
DBAddr mysql://foo:bar@localhost/mnogosearch/?MyCnfGroup=no
</PRE
>

When connecting to MySQL, mnoGoSearch uses MySQL C API call
to tell the MySQL connection handler which option group to load
(unless <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>MyCnfGroup=no</I
></SPAN
> is specified):

<PRE
CLASS="programlisting"
>&#13;mysql_options(mysql, MYSQL_READ_DEFAULT_GROUP, MyCnfGroup);
</PRE
>
</P
></DIV
><DIV
CLASS="refsect3"
><A
NAME="AEN5179"
></A
><H4
><SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>SQLLog</I
></SPAN
> - Using general log</H4
><P
>MySQL users can specify whether to switch MySQL query
logging on/off using sqllog parameter:
<PRE
CLASS="programlisting"
>&#13;DBAddr mysql://foo:bar@localhost/mnogosearch/?sqllog=0
DBAddr mysql://foo:bar@localhost/mnogosearch/?sqllog=1
</PRE
>
If sqllog parameter is given, then mnoGoSearch will send
"SET SQL_LOG_OFF=X" query after connection is established.
Only users with MySQL <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>SUPER</I
></SPAN
> privilege can
use this parameter.
</P
></DIV
><DIV
CLASS="refsect3"
><A
NAME="AEN5185"
></A
><H4
><SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>SQLLogBin</I
></SPAN
> - Using binary log</H4
><P
>MySQL users can specify whether to do binary logging
by setting the <TT
CLASS="literal"
>sqllogbin</TT
> parameter:
<PRE
CLASS="programlisting"
>&#13;DBAddr mysql://foo:bar@localhost/mnogosearch/?sqllogbin=0
DBAddr mysql://foo:bar@localhost/mnogosearch/?sqllogbin=1
</PRE
>
If sqllog parameter is given, then mnoGoSearch will send
"SET SQL_LOG_BIN=X" after connection is established.
Only users with MySQL <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>SUPER</I
></SPAN
> privilege can
use this parameter.
</P
></DIV
></DIV
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN5192"
></A
><H2
>Examples</H2
><DIV
CLASS="informalexample"
><P
></P
><A
NAME="AEN5194"
></A
><PRE
CLASS="programlisting"
>&#13;DBAddr mysql://foo:bar@localhost/mnogosearch/?DBMode=multi
DBAddr mysql://foo:pwd%3Awith%40special%3Cchars@localhost/mnogosearch/
</PRE
><P
></P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="msearch-cmdref-dateformat.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="msearch-cmdref-defaultcontenttype.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>DateFormat</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="msearch-cmdref.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>DefaultContentType</TD
></TR
></TABLE
></DIV
><!--#include virtual="body-after.html"--></BODY
></HTML
>