PageRenderTime 75ms CodeModel.GetById 28ms RepoModel.GetById 1ms app.codeStats 0ms

/lib/ruby/gems/1.8/gems/pg-0.8.0/doc/postgres.html

https://github.com/tjgillies/gems
HTML | 278 lines | 263 code | 1 blank | 14 comment | 0 complexity | 6a9db83268d013ea5b69274c0379019c MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
    2. 

  2.     "http://www.w3.org/TR/html4/strict.dtd">
    3. 

  3. <html lang="en">
    4. 

  4. <head> 
    5. 

  5.   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    6. 

  6.   <meta http-equiv="Content-Style-Type" content="text/css">
    7. 

  7.   <meta name="Keywords" lang="en" content="Ruby PostgreSQL">
    8. 

  8.   <link rev="made" href="mailto:noborus@netlab.jp">
    9. 

  9.   <style type="text/css">
    10. 

  10.    <!--
    11. 

  11.     body {
    12. 

  12.         background-color: white;
    13. 

  13.         color: black;
    14. 

  14.     }
    15. 

  15.     address { text-align: right }
    16. 

  16.     div.lastmodifed { text-align: right }
    17. 

  17.     div.language { text-align: right }    
    18. 

  18.     pre {
    19. 

  19.         white-space: pre;
    20. 

  20.         background-color: antiquewhite;
    21. 

  21.         border: inset thin;
    22. 

  22.     }
    23. 

  23.    -->
    24. 

  24.   </style>
    25. 

  25.   <title>Postgres reference</title>
    26. 

  26. </head>
    27. 

  27. <body>
    28. 

  28.   <div class = "language">
    29. 

  29.     [English | <a href="postgres.jp.html">Japanese</a>]
    30. 

  30.   </div>
    31. 

  31.   <h1><a name="reference">Postgres reference</a></h1>
    32. 

  32.   <div class = "lastmodifed">
    33. 

  33.     Last update: Sun,  4 Mar 2001 15:40:08 +0000
    34. 

  34.   </div>
    35. 

  35.   <hr>
    36. 

  36.   <div>
    37. 

  37.     <h2><a name="PGconn">PGconn</a></h2>
    38. 

  38.     <p>
    39. 

  39.  The class to access PostgreSQL database.  All other functionality of libpq
    40. 

  40. save the large object to a file.
    41. 

  41.     </p>
    42. 

  42.     <p>
    43. 

  43. For example, to send query to the database on the localhost.
    44. 

  44.     </p>
    45. 

  45.     <pre>
    46. 

  46. require &quot;postgres&quot;
    47. 

  47. conn = PGconn.connect("localhost", 5432, &quot;&quot;, &quot;&quot;, &quot;test1&quot;)
    48. 

  48. # or: conn = PGconn.open('dbname=test1')
    49. 

  49. res = conn.exec(&quot;select * from a;&quot;)
    50. 

  50.     </pre>
    51. 

  51.     <h3>super class:</h3>
    52. 

  52.     <code>Object</code>
    53. 

  53.     <h3>class methods:</h3>
    54. 

  54.     <p>
    55. 

  55.       <a name="PGconn.connect"><code>connect(<var>pghost</var>,
    56. 

  56.                        <var>pgport</var>, <var>pgoptions</var>,
    57. 

  57.                        <var>pgtty</var>, <var>dbname</var>, <var>login</var>,
    58. 

  58.                        <var>passwd</var>)</code></a>
    59. 

  59.       <a name="PGconn.new"><code>new(<var>pghost</var>,
    60. 

  60.                        <var>pgport</var>, <var>pgoptions</var>,
    61. 

  61.                        <var>pgtty</var>, <var>dbname</var>, <var>login</var>,
    62. 

  62.                        <var>passwd</var>)</code></a>
    63. 

  63.       <a name="PGconn.open"><code>open(<var>string</var>)</code></a>
    64. 

  64.      </p>
    65. 

  65.      <dl>
    66. 

  66.        <dt>Connect to the PostgreSQL server.  Options are:</dt>
    67. 

  67.          <dd><var>pghost</var> : Server hostname(string)
    68. 

  68.          <dd><var>pgport</var> : Server port number(integer)
    69. 

  69.          <dd><var>pgoptions</var> : backend options(string)
    70. 

  70.          <dd><var>pgtty</var> : tty to print backend debug message(string)
    71. 

  71.          <dd><var>dbname</var> : connecting database name(string)
    72. 

  72.          <dd><var>login</var> : login user name(string)
    73. 

  73.          <dd><var>passwd</var> : login password(string)
    74. 

  74.        <dt>Options in string format (separated by whitespace) are:</dt>
    75. 

  75.          <dd><var>host=name</var> : Server hostname(string) (defaults to localhost)
    76. 

  76. 	 <dd><var>hostaddr=addr</var> : Server host IP address(string)
    77. 

  77. 	 <dd><var>port=number</var> : Server port number(integer) (default: 5432)
    78. 

  78.          <dd><var>options=string</var> : backend options(string) (sent to server, not well explained)
    79. 

  79.          <dd><var>tty=anything</var> : ignored, used to be debug TTY(string)
    80. 

  80.          <dd><var>dbname=name</var> : connecting database name(string) (default: your username)
    81. 

  81.          <dd><var>user=username</var> : login user name(string) (default: your username)
    82. 

  82.          <dd><var>password=censored</var> : login password(string)
    83. 

  83. 	 <dd><var>sslmode=mode</var> : how to treat SSL(string) (one of disable, allow, prefer, require)
    84. 

  84.          <dd><var>service=name</var> : service name in pg_service.conf(string)
    85. 

  85. 	 <dd><var>connect_timeout=seconds</var> : how long to wait for a connection(integer) (0 means forever)
    86. 

  86.      </dl>
    87. 

  87.      <p>On failure, it raises <code>PGError</code> exception.</p>
    88. 

  88.      <h3>methods:</h3>
    89. 

  89.      <dl>
    90. 

  90.        <dt><a name="db"><code>db</code></a>
    91. 

  91.          <dd>Returns the connected database name.
    92. 

  92.        <dt><a name="host"><code>host</code></a>
    93. 

  93.          <dd>Returns the connected server name.
    94. 

  94.        <dt><a name="user"><code>user</code></a>
    95. 

  95.          <dd>Returns the authenticated user name.
    96. 

  96.        <dt><a name="options"><code>options</code></a>
    97. 

  97.          <dd>Returns backend option string.
    98. 

  98.        <dt><a name="port"><code>port</code></a>
    99. 

  99.          <dd>Returns the connected server port number.
    100. 

  100.        <dt><a name="tty"><code>tty</code></a>
    101. 

  101.          <dd>Returns the connected pgtty.
    102. 

  102.        <dt><a name="error"><code>error</code></a>
    103. 

  103.          <dd>Returns the error message about connection.
    104. 

  104.        <dt> <a name="finish"><code>finish</code></a>
    105. 

  105.        <dt> <a name="close"><code>close</code></a>
    106. 

  106.          <dd>Closes the backend connection.
    107. 

  107.        <dt><a name="reset"><code>reset</code></a>
    108. 

  108.          <dd>Resets the backend connection.  This method closes the backend
    109. 

  109.             connection and tries to re-connect.
    110. 

  110.        <dt><a name="trace"><code>trace(<var>port</var>)</code></a>
    111. 

  111.          <dd>Enables tracing message passing between backend.  The trace 
    112. 

  112. 	    message will be written to the port object, which is the
    113. 

  113. 	    instance of the class File.
    114. 

  114.        <dt><a name="untrace"><code>untrace</code></a>
    115. 

  115.          <dd>Disables the message tracing.
    116. 

  116.        <dt><a name="exec"><code>exec(<var>sql</var>)</code></a>
    117. 

  117.          <dd>Sends SQL query request specified by <var>sql</var> to the
    118. 

  118. 	    PostgreSQL. Returns the <a href="#PGresult">PGresult</a>
    119. 

  119. 	    instance on success. On failure, it raises <code>PGError</code>
    120. 

  120. 	    exception.
    121. 

  121.        <dt><a name="query"><code>query(<var>sql</var>)</code></a>
    122. 

  122.          <dd>Sends SQL query request specified by <var>sql</var> to the
    123. 

  123. 	    PostgreSQL.Returns an Array as the resulting tuple on success.
    124. 

  124.             On failure, it returns nil, and error detail can be obtained
    125. 

  125. 	    by error.
    126. 

  126.        <dt><a name="async_exec"><code>async_exec(<var>sql</var>)</code></a>
    127. 

  127.          <dd>Sends SQL asynchronous query request specified by <var>sql</var>
    128. 

  128. 	    to the PostgreSQL. Returns the <a href="#PGresult">PGresult</a>
    129. 

  129. 	    instance on success. On failure, it raises <code>PGError</code>
    130. 

  130. 	    exception.
    131. 

  131.        <dt><a name="async_query"><code>async_query(<var>sql</var>)</code></a>
    132. 

  132.          <dd>Sends SQL asynchronous query request specified by <var>sql</var>
    133. 

  133. 	    to the PostgreSQL.Returns an Array as the resulting tuple on
    134. 

  134. 	    success. On failure, it returns nil, and error detail can be
    135. 

  135. 	    obtained by error.
    136. 

  136.        <dt><a name="get_notify"><code>get_notify</code></a>
    137. 

  137.          <dd>Returns the array of the unprocessed notifiers.
    138. 

  138.             If there is no unprocessed notifier, it returns nil.
    139. 

  139.        <dt><a name="insert_table"><code>insert_table(<var>table</var>,
    140. 

  140. 	  <var>array</var>)</code></a>
    141. 

  141.          <dd>Inserts contents of the <var>array</var> into the
    142. 

  142. 	    <var>table</var>.
    143. 

  143.        <dt><a name="getline"><code>getline</code></a>
    144. 

  144.          <dd>Reads a line from the backend server into internal buffer.
    145. 

  145.             Returns nil for EOF, 0 for success, 1 for buffer overflowed.
    146. 

  146.             You need to ensure single &quot;.&quot; from backend to confirm
    147. 

  147. 	    transmission completion. The sample program <a href="../sample/psql.rb">psql.rb</a>
    148. 

  148.             treats this copy protocol right.
    149. 

  149.        <dt><a name="putline"><code>putline(<var>string</var>)</code></a>
    150. 

  150.          <dd>Sends the <var>string</var> to the backend server.
    151. 

  151. 	    Users must send a single &quot;.&quot; to denote the end of data transmission.
    152. 

  152.        <dt><a name="endcopy"><code>endcopy</code></a>
    153. 

  153.          <dd>Waits until the backend completes the copying.  You should call
    154. 

  154. 	    this method after putline, or getline.Returns nil on success,
    155. 

  155. 	    raises an exception otherwise.
    156. 

  156.        <dt><a name="set_client_encoding"><code>set_client_encoding</code></a>
    157. 

  157.          <dd>Set client encoding(String).
    158. 

  158.        <dt><a name="client_encoding"><code>client_encoding</code></a>
    159. 

  159.          <dd>Returns client encoding(String).
    160. 

  160.        <dt><a name="set_notice_processor"><code>set_notice_processor(proc)</code></a>
    161. 

  161.          <dd>Control reporting of notice and warning messages generated by the
    162. 

  162. 	 backend server (with Proc or anything else responding to :call).
    163. 

  163. 	 Pass nil to disable processing of the messages.
    164. 

  164. 

  165.        <dt><a name="lo_import"><code>lo_import(<var>file</var>)</code></a>
    166. 

  166.          <dd>Import a <var>file</var> to a large object. Return the <a href="#PGlarge">PGlarge</a> instance on success. On failure, it raises <code>PGError</code> exception.
    167. 

  167.        <dt><a name="lo_export"><code>lo_export(<var>oid</var>, <var>file</var>)</code></a>
    168. 

  168.          <dd>Save a large object of oid to a <var>file</var>.
    169. 

  169.        <dt><a name="lo_create"><code>lo_create([<var>mode</var>])</code></a>
    170. 

  170.          <dd>Return the <a href="#PGlarge">PGlarge</a> instance on success. On failure, it raises <code>PGError</code> exception.
    171. 

  171.        <dt><a name="lo_open"><code>lo_open(<var>oid</var>, [<var>mode</var>])</code></a>
    172. 

  172.          <dd>Open a large object of oid. Return the <a href="#PGlarge">PGlarge</a> instance on success. The mode argument specifies the mode for the opened large object, which is either <var>&quot;INV_READ&quot;</var>, or <var>&quot;INV_WRITE&quot;</var>. If mode On failure, it raises <code>PGError</code> exception. If mode omitted, the default is <var>&quot;INV_READ&quot;</var>
    173. 

  173.        <dt><a name="lo_unlink"><code>lo_unlink(<var>oid</var>)</code></a>
    174. 

  174.          <dd>Unlink (deletes) the postgres large object of oid.
    175. 

  175.      </dl>
    176. 

  176.    </div>
    177. 

  177.    <hr>
    178. 

  178.    <div>
    179. 

  179.      <h2><a name="PGresult">PGresult</a></h2>
    180. 

  180.      <P>
    181. 

  181.  The class to represent the query result tuples.  The object of this
    182. 

  182. class is created as the result of every query.  You may need to invoke
    183. 

  183. clear method for the finished object for better memory performance.
    184. 

  184.      </P>
    185. 

  185.      <h3>super class:</h3>
    186. 

  186.      <p>
    187. 

  187.        <code>Object</code>
    188. 

  188.      </p>
    189. 

  189.      <h2>methods:</h2>
    190. 

  190.      <dl>
    191. 

  191.        <dt><a name="status"><code>status</code></a>
    192. 

  192.          <dd><dl>
    193. 

  193. 	      <dt>Returns the status of the query.  The status value is
    194. 

  194. 	         either:
    195. 

  195. 	        <dd>EMPTY_QUERY
    196. 

  196.                 <dd>COMMAND_OK
    197. 

  197.                 <dd>TUPLES_OK
    198. 

  198.                 <dd>COPY_OUT
    199. 

  199.                 <dd>COPY_IN
    200. 

  200. 	      </dl>
    201. 

  201.        <dt><a name="result"><code>result</code></a>
    202. 

  202.          <dd>Returns the query result tuple in the array.
    203. 

  203.        <dt><a name="fields"><code>fields</code></a>
    204. 

  204.          <dd>Returns the array of the fields of the query result.
    205. 

  205.        <dt><a name="num_tuples"><code>num_tuples</code></a>
    206. 

  206.          <dd>Returns the number of tuples of the query result.
    207. 

  207.        <dt><a name="num_fields"><code>num_fields</code></a>
    208. 

  208.          <dd>Returns the number of fields of the query result.
    209. 

  209.        <dt><a name="fieldname"><code>fieldname(<var>index</var>)</code></a>
    210. 

  210.          <dd>Returns the field name corresponding field index.
    211. 

  211.        <dt><a name="fieldnum"><code>fieldnum(<var>name</var>)</code></a>
    212. 

  212.          <dd>Returns the index of the <var>name</var>ed field.
    213. 

  213.        <dt><a name="type"><code>type(<var>index</var>)</code></a>
    214. 

  214.          <dd>Returns the integer corresponding the type of the field.
    215. 

  215. 	    The field indicator starts from zero.
    216. 

  216.        <dt><a name="size"><code>size(<var>index</var>)</code></a>
    217. 

  217.          <dd>Returns the size of the field in bytes.
    218. 

  218.             Returns <code>-1</code> if the field is variable sized.
    219. 

  219.        <dt><a name="getvalue"><code>getvalue(<var>tup_num, field_num</var>)
    220. 

  220. 	    </code></a>
    221. 

  221.          <dd>Returns the field value.
    222. 

  222.        <dt><a name="getlength"><code>getlength(<var>tup_num, field_num</var>)
    223. 

  223. 	    </code></a>
    224. 

  224.          <dd>Returns the length of the field in bytes.
    225. 

  225.        <dt><a name="cmdstatus"><code>cmdtuples</code></a>
    226. 

  226.          <dd>the number of tuples (rows) affected by the SQL command.
    227. 

  227.        <dt><a name="cmdstatus"><code>cmdstatus</code></a>
    228. 

  228.          <dd>Returns the status string of the last query command.
    229. 

  229.        <dt><a name="oid"><code>oid</code></a>
    230. 

  230.          <dd>Returns the oid of the inserted row, or <code>nil</code> if
    231. 

  231. 	 the last statement was not an <code>INSERT</code>
    232. 

  232.        <dt><a name="clear"><code>clear</code></a>
    233. 

  233.          <dd>Clears the <a href="#PGresult">PGresult</a> object as the result
    234. 

  234. 	     of the query.
    235. 

  235.      </dl>
    236. 

  236.   </div>
    237. 

  237.   <hr>
    238. 

  238.   <div>
    239. 

  239.   <h2><a name="PGlarge">PGlarge</a></h2>
    240. 

  240.      <P>
    241. 

  241.  The class to access large objects. The object of this class is created as the
    242. 

  242.  result of <a href="#lo_import">lo_import</a>, <a href="#lo_create">lo_create</a>, and <a href="#lo_open">lo_open</a>.
    243. 

  243.      </P>
    244. 

  244.      <h3>super class:</h3>
    245. 

  245.      <p>
    246. 

  246.        <code>Object</code>
    247. 

  247.      </p>
    248. 

  248.      <h2>methods:</h2>
    249. 

  249.      <dl>
    250. 

  250.        <dt><a name="open"><code>open([<var>mode</var>])</code></a>
    251. 

  251.          <dd>Open a large object. The mode argument specifies the mode for the opened large object, which is either <var>&quot;INV_READ&quot;</var>,<var>&quot;INV_READ&quot;</var>.
    252. 

  252.        <dt><a name="close"><code>close</code></a>
    253. 

  253.          <dd>Close a large object. Closed when they are garbage-collected.
    254. 

  254.        <dt><a name="read"><code>read([<var>length</var>])</code></a>
    255. 

  255.          <dd>Attempts to read <var>length</var> bytes from large object. If no <var>length</var> given, reads all data.
    256. 

  256.        <dt><a name="write"><code>write(<var>str</var>)</code></a>
    257. 

  257.          <dd>Write the string to the large object. Return the number of bytes written.
    258. 

  258.        <dt><a name="seek"><code>seek(<var>offset</var>, <var>whence</var>)</code></a>
    259. 

  259.          <dd>Move the large object pointer to the <var>offset</var>. The value for <var>whence</var> are SEEK_SET, SEEK_CUR, and SEEK_END.Or it is 0,1,2.
    260. 

  260.        <dt><a name="tell"><code>tell</code></a>
    261. 

  261.          <dd>Return the current position of the large object pointer.
    262. 

  262.        <dt><a name="unlink"><code>unlink</code></a>
    263. 

  263.          <dd>Delete large object.
    264. 

  264.        <dt><a name="oid"><code>oid</code></a>
    265. 

  265.          <dd>Return the large object oid.
    266. 

  266.        <dt><a name="size"><code>size</code></a>
    267. 

  267.          <dd>Return the size of large object.
    268. 

  268.        <dt><a name="export"><code>export(<var>file</var>)</code></a>
    269. 

  269.          <dd>Save a large object of oid to a <var>file</var>.
    270. 

  270.     </dl>
    271. 

  271.   </div>
    272. 

  272.   <hr>
    273. 

  273.   <address>
    274. 

  274.     mailto:
    275. 

  275.     <a href="mailto:noborus@netlab.jp">Noboru Saitou</a>
    276. 

  276.   </address>
    277. 

  277. </body>
    278. 

  278. </html>
    279. 

  279.