home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _c26428b0bc4fdad360696b3a30de8d0c < prev    next >
Text File  |  2000-03-23  |  9KB  |  225 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>DBD::Proxy - A proxy driver for the DBI</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> DBD::Proxy - A proxy driver for the DBI</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#connecting to the database">CONNECTING TO THE DATABASE</A></LI>
  26.     <LI><A HREF="#author and copyright">AUTHOR AND COPYRIGHT</A></LI>
  27.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  28. </UL>
  29. <!-- INDEX END -->
  30.  
  31. <HR>
  32. <P>
  33. <H1><A NAME="name">NAME</A></H1>
  34. <P>DBD::Proxy - A proxy driver for the DBI</P>
  35. <P>
  36. <HR>
  37. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  38. <UL>
  39. <LI>Linux</LI>
  40. <LI>Solaris</LI>
  41. <LI>Windows</LI>
  42. </UL>
  43. <HR>
  44. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  45. <PRE>
  46.   use DBI;</PRE>
  47. <PRE>
  48.   $dbh = DBI->connect("dbi:Proxy:hostname=$host;port=$port;dsn=$db",
  49.                       $user, $passwd);</PRE>
  50. <PRE>
  51.   # See the DBI module documentation for full details</PRE>
  52. <P>
  53. <HR>
  54. <H1><A NAME="description">DESCRIPTION</A></H1>
  55. <P>DBD::Proxy is a Perl module for connecting to a database via a remote
  56. DBI driver.</P>
  57. <P>This is of course not needed for DBI drivers which already
  58. support connecting to a remote database, but there are engines which
  59. don't offer network connectivity.</P>
  60. <P>Another application is offering database access through a firewall, as
  61. the driver offers query based restrictions. For example you can
  62. restrict queries to exactly those that are used in a given CGI
  63. application.</P>
  64. <P>Speaking of CGI, another application is (or rather, will be) to reduce
  65. the database connect/disconnect overhead from CGI scripts by using
  66. proxying the connect_cached method. The proxy server will hold the
  67. database connections open in a cache. The CGI script then trades the
  68. database connect/disconnect overhead for the DBD::Proxy
  69. connect/disconnect overhead which is typically much less.
  70. <EM>Note that the connect_cached method is new and still experimental.</EM></P>
  71. <P>
  72. <HR>
  73. <H1><A NAME="connecting to the database">CONNECTING TO THE DATABASE</A></H1>
  74. <P>Before connecting to a remote database, you must ensure, that a Proxy
  75. server is running on the remote machine. There's no default port, so
  76. you have to ask your system administrator for the port number. See
  77. <A HREF="../../../DBI/ProxyServer(3).html">the DBI::ProxyServer(3) manpage</A> for details.</P>
  78. <P>Say, your Proxy server is running on machine ``alpha'', port 3334, and
  79. you'd like to connect to an ODBC database called ``mydb'' as user ``joe''
  80. with password ``hello''. When using DBD::ODBC directly, you'd do a</P>
  81. <PRE>
  82.   $dbh = DBI->connect("DBI:ODBC:mydb", "joe", "hello");</PRE>
  83. <P>With DBD::Proxy this becomes</P>
  84. <PRE>
  85.   $dsn = "DBI:Proxy:hostname=alpha;port=3334;dsn=DBI:ODBC:mydb";
  86.   $dbh = DBI->connect($dsn, "joe", "hello");</PRE>
  87. <P>You see, this is mainly the same. The DBD::Proxy module will create a
  88. connection to the Proxy server on ``alpha'' which in turn will connect
  89. to the ODBC database.</P>
  90. <P>Refer to the <EM>DBI(3)</EM> documentation on the <A HREF="../../../lib/Pod/perlfunc.html#item_connect"><CODE>connect</CODE></A> method for a way
  91. to automatically use DBD::Proxy without having to change your code.</P>
  92. <P>DBD::Proxy's DSN string has the format</P>
  93. <PRE>
  94.   $dsn = "DBI:Proxy:key1=val1; ... ;keyN=valN;dsn=valDSN";</PRE>
  95. <P>In other words, it is a collection of key/value pairs. The following
  96. keys are recognized:</P>
  97. <DL>
  98. <DT><STRONG><A NAME="item_hostname">hostname</A></STRONG><BR>
  99. <DD>
  100. <DT><STRONG><A NAME="item_port">port</A></STRONG><BR>
  101. <DD>
  102. Hostname and port of the Proxy server; these keys must be present,
  103. no defaults. Example:
  104. <PRE>
  105.     hostname=alpha;port=3334</PRE>
  106. <P></P>
  107. <DT><STRONG><A NAME="item_dsn">dsn</A></STRONG><BR>
  108. <DD>
  109. The value of this attribute will be used as a dsn name by the Proxy
  110. server. Thus it must have the format <CODE>DBI:driver:...</CODE>, in particular
  111. it will contain colons. The <EM>dsn</EM> value may contain semicolons, hence
  112. this key *must* be the last and it's value will be the complete
  113. remaining part of the dsn. Example:
  114. <PRE>
  115.     dsn=DBI:ODBC:mydb</PRE>
  116. <P></P>
  117. <DT><STRONG><A NAME="item_cipher">cipher</A></STRONG><BR>
  118. <DD>
  119. <DT><STRONG><A NAME="item_key">key</A></STRONG><BR>
  120. <DD>
  121. <DT><STRONG><A NAME="item_usercipher">usercipher</A></STRONG><BR>
  122. <DD>
  123. <DT><STRONG><A NAME="item_userkey">userkey</A></STRONG><BR>
  124. <DD>
  125. By using these fields you can enable encryption. If you set,
  126. for example,
  127. <PRE>
  128.     cipher=$class;key=$key</PRE>
  129. <P>(note the semicolon) then DBD::Proxy will create a new cipher object
  130. by executing</P>
  131. <PRE>
  132.     $cipherRef = $class->new(pack("H*", $key));</PRE>
  133. <P>and pass this object to the RPC::PlClient module when creating a
  134. client. See <A HREF="../../../RPC/PlClient(3).html">the RPC::PlClient(3) manpage</A>. Example:</P>
  135. <PRE>
  136.     cipher=IDEA;key=97cd2375efa329aceef2098babdc9721</PRE>
  137. <P>The usercipher/userkey attributes allow you to use two phase encryption:
  138. The cipher/key encryption will be used in the login and authorisation
  139. phase. Once the client is authorised, he will change to usercipher/userkey
  140. encryption. Thus the cipher/key pair is a <STRONG>host</STRONG> based secret, typically
  141. less secure than the usercipher/userkey secret and readable by anyone.
  142. The usercipher/userkey secret is <STRONG>your</STRONG> private secret.</P>
  143. <P>Of course encryption requires an appropriately configured server. See
  144. <DBD::ProxyServer(3)/CONFIGURATION FILE>.</P>
  145. <P></P>
  146. <DT><STRONG><A NAME="item_debug">debug</A></STRONG><BR>
  147. <DD>
  148. Turn on debugging mode
  149. <P></P>
  150. <DT><STRONG><A NAME="item_stderr">stderr</A></STRONG><BR>
  151. <DD>
  152. This attribute will set the corresponding attribute of the RPC::PlClient
  153. object, thus logging will not use syslog(), but redirected to stderr.
  154. This is the default under Windows.
  155. <PRE>
  156.     stderr=1</PRE>
  157. <P></P>
  158. <DT><STRONG><A NAME="item_logfile">logfile</A></STRONG><BR>
  159. <DD>
  160. Similar to the stderr attribute, but output will be redirected to the
  161. given file.
  162. <PRE>
  163.     logfile=/dev/null</PRE>
  164. <P></P>
  165. <DT><STRONG><A NAME="item_RowCacheSize">RowCacheSize</A></STRONG><BR>
  166. <DD>
  167. The DBD::Proxy driver supports this attribute (which is DBI standard,
  168. as of DBI 1.02). It's used to reduce network round-trips by fetching
  169. multiple rows in one go. The current default value is 20, but this may
  170. change.
  171. <P></P>
  172. <DT><STRONG><A NAME="item_proxy_no_finish">proxy_no_finish</A></STRONG><BR>
  173. <DD>
  174. This attribute can be used to reduce network traffic: If the
  175. application is calling $sth-><CODE>finish()</CODE> then the proxy tells the server
  176. to finish the remote statement handle. Of course this slows down things
  177. quite a lot, but is prefectly good for reducing memory usage with
  178. persistent connections.
  179. <P>However, if you set the <EM>proxy_no_finish</EM> attribute to a TRUE value,
  180. either in the database handle or in the statement handle, then <CODE>finish()</CODE>
  181. calls will be supressed. This is what you want, for example, in small
  182. and fast CGI applications.</P>
  183. <P></P>
  184. <DT><STRONG><A NAME="item_proxy_quote">proxy_quote</A></STRONG><BR>
  185. <DD>
  186. This attribute can be used to reduce network traffic: By default calls
  187. to $dbh-><CODE>quote()</CODE> are passed to the remote driver.  Of course this slows
  188. down things quite a lot, but is the safest default behaviour.
  189.  
  190. <PRE>
  191.  
  192. However, if you set the I<proxy_quote> attribute to the value 'C<local>'
  193. either in the database handle or in the statement handle, and the call
  194. to quote has only one parameter, then the local default DBI quote
  195. method will be used (which will be faster but may be wrong).</PRE>
  196. <P></P></DL>
  197. <P>
  198. <HR>
  199. <H1><A NAME="author and copyright">AUTHOR AND COPYRIGHT</A></H1>
  200. <P>This module is Copyright (c) 1997, 1998</P>
  201. <PRE>
  202.     Jochen Wiedmann
  203.     Am Eisteich 9
  204.     72555 Metzingen
  205.     Germany</PRE>
  206. <PRE>
  207.     Email: joe@ispsoft.de
  208.     Phone: +49 7123 14887</PRE>
  209. <P>The DBD::Proxy module is free software; you can redistribute it and/or
  210. modify it under the same terms as Perl itself. In particular permission
  211. is granted to Tim Bunce for distributing this as a part of the DBI.</P>
  212. <P>
  213. <HR>
  214. <H1><A NAME="see also">SEE ALSO</A></H1>
  215. <P><EM>DBI(3)</EM>, <A HREF="../../../RPC/PlClient(3).html">the RPC::PlClient(3) manpage</A>, <EM>Storable(3)</EM></P>
  216. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  217. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  218. <STRONG><P CLASS=block> DBD::Proxy - A proxy driver for the DBI</P></STRONG>
  219. </TD></TR>
  220. </TABLE>
  221.  
  222. </BODY>
  223.  
  224. </HTML>
  225.