File: oracle.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (478 lines) | stat: -rwxr-xr-x 18,072 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
<?xml version="1.0" encoding="iso-8859-1"?>
 <reference id="ref.oracle">
  <title>Funciones Oracle</title>
  <titleabbrev>Oracle</titleabbrev>

  <refentry id="function.ora-bind">
   <refnamediv>
    <refname>Ora_Bind</refname>
    <refpurpose>Vincula una variable PHP a un par&aacute;metro Oracle</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>ora_bind</methodname>
     <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
     <methodparam><type>string</type><parameter>nombre de variable PHP</parameter></methodparam>
     <methodparam><type>string</type><parameter>nombre de par&aacute;metro SQL</parameter></methodparam>
     <methodparam><type>int</type><parameter>longitud</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>tipo</parameter></methodparam>
     </methodsynopsis>
    <para>
     Devuelve verdadero si el v&iacute;nculo se realiza con &eacute;xito, y sino devuelve falso.  Los detalles
     de los errores pueden examinarse usando la funciones <function>ora_error</function> y
     <function>ora_errorcode</function>.</para>

    <para>
     Esta funci&oacute;n liga la variable PHP nombrada con el par&aacute;metro SQL.
     El par&aacute;mtro SQL debe estar en la forma ":name".  Con el par&aacute;metro
     optativo tipo, se define si el par&aacute;metro SQL se trata de un par&aacute;metro
     de entrada/salida (0 y por defecto), entrada (1) o salida (2).  Como en PHP
     3.0.1, se puede usar las constantes ORA_BIND_INOUT, ORA_BIND_IN y
     ORA_BIND_OUT en lugar de los n&uacute;meros.</para>
 
    <para>
     ora_bind debe ser llamada despu&eacute;s de <function>ora_parse</function> y
     antes de <function>ora_exec</function>. Los valores de entrada pueden pasarse por
     asignaci&oacute;n a las variables PHP vinculadas, despues de la llamada a
     <function>ora_exec</function> dichas variables contendr&aacute;n los valores de salida, si
     &eacute;stos estuvieran disponibles.

<informalexample>
      <programlisting role="php">
&lt;?php
ora_parse($curs, "declare tmp INTEGER; begin tmp := :in; :out := tmp; :x := 7.77; end;");
ora_bind($curs, "result", ":x", $len, 2);
ora_bind($curs, "input", ":in", 5, 1);
ora_bind($curs, "output", ":out", 5, 2);
$input = 765;
ora_exec($curs);
echo "Result: $result&lt;BR>Out: $output&lt;BR>In: $input";
?>
</programlisting>
     </informalexample></para>

   </refsect1>
  </refentry>

  <refentry id="function.ora-close">
   <refnamediv>
    <refname>Ora_Close</refname>
    <refpurpose>Cierra un cursor Oracle</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>ora_close</methodname>
     <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
     </methodsynopsis>
    <para>
     Devuelve verdadero si el cierre fu&eacute; exitoso, o falso de lo contrario.  Los detalles de los
     errores se recuperan usando las funciones
     <function>ora_error</function> y
     <function>ora_errorcode</function>.</para>

    <para>
     Esta funci&oacute;n cierra un cursor de datos abierto con
     <function>ora_open</function>.</para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-columnname">
   <refnamediv>
    <refname>Ora_ColumnName</refname>
    <refpurpose>toma el nombre de una columna de resultados Oracle</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>string</type><methodname>Ora_ColumnName</methodname>
     <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
     <methodparam><type>int</type><parameter>column</parameter></methodparam>
     </methodsynopsis>
    <para>
     Devuelve el nomre de un campo/columna
     <parameter>column</parameter> en el cursor
     <parameter>cursor</parameter>.  el nombre devuelto estar&aacute; en letras may&uacute;sculas.</para>
   </refsect1>
  </refentry>


  <refentry id="function.ora-columntype">
   <refnamediv>
    <refname>Ora_ColumnType</refname>
    <refpurpose>toma el tipo de una columna de resultados Oracle</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>string</type><methodname>Ora_ColumnType</methodname>
     <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
     <methodparam><type>int</type><parameter>column</parameter></methodparam>
     </methodsynopsis>
    <para>
     Devuelve el nombre del tipo de datos del campo o columna
     <parameter>column</parameter> en el cursor
     <parameter>cursor</parameter>.  Se devolver&aacute; un tipo de datos, de entre los siguientes:
     <simplelist>
      <member><literal>"VARCHAR2"</literal></member>
      <member><literal>"VARCHAR"</literal></member>
      <member><literal>"CHAR"</literal></member>
      <member><literal>"NUMBER"</literal></member>
      <member><literal>"LONG"</literal></member>
      <member><literal>"LONG RAW"</literal></member>
      <member><literal>"ROWID"</literal></member>
      <member><literal>"DATE"</literal></member>
      <member><literal>"CURSOR"</literal></member>
     </simplelist></para>
   </refsect1>
  </refentry>


  <refentry id="function.ora-commit">
   <refnamediv>
    <refname>Ora_Commit</refname>
    <refpurpose>realiza una transacci&oacute;n Oracle</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>ora_commit</methodname>
     <methodparam><type>int</type><parameter>conn</parameter></methodparam>
     </methodsynopsis>
    <para>Devuelve verdadero si es exitosa, de lo cantrario devuelve falso.  Puede verse los detalles
    del error usando las funciones <function>ora_error</function>
    y <function>ora_errorcode</function>.  Esta funci&oacute;n realiza una transacci&oacute;n Oracle.
    Se define como transacci&oacute;n cualquier cambio en una conexi&oacute;n dada, desde la &uacute;ltima
    tarea/retroceso en la ejecucion (rollback), anulaci&oacute;n de la ejecuci&oacute;n autom&aacute;tica de tareas (autocommit), o cuando se ha
    establecido la conexi&oacute;n.</para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-commitoff">
   <refnamediv>
    <refname>Ora_CommitOff</refname>
    <refpurpose>deshabilita el modo automatico de ejecucion de tareas (autocommit)</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>ora_commitoff</methodname>
     <methodparam><type>int</type><parameter>conn</parameter></methodparam>
     </methodsynopsis>
    <para>
     Devuelve verdadero si se ejecuta con &eacute;xito, sino devuelve falso.  Los pormenores del error
     en cuestion, pueden revisarse invocando las funciones <function>ora_error</function> y
     <function>ora_errorcode</function>.</para>

    <para>
     Esta funci&oacute;n deshabilita la ejecucion automatica luego de cada instancia <function>ora_exec</function>.</para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-commiton">
   <refnamediv>
    <refname>Ora_CommitOn</refname>
    <refpurpose>Habilita la ejecucion autom&aacute;tica de tareas (autocommit)</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>ora_commiton</methodname>
     <methodparam><type>int</type><parameter>conn</parameter></methodparam>
     </methodsynopsis>
    <para>
     Esta funci&oacute;n habilita la ejecucion automatica luego de cada instancia <function>ora_exec</function>
     en la conexi&oacute;n dada.</para>

    <para>
     Devuelve verdadero si se ejecuta con &eacute;xito, sino devuelve falso.  Los pormenores del error
     en cuestion, pueden revisarse invocando las funciones <function>ora_error</function> y
     <function>ora_errorcode</function>.</para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-error">
   <refnamediv>
    <refname>Ora_Error</refname>
    <refpurpose>toma los mensajes de error de Oracle</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>string</type><methodname>Ora_Error</methodname>
     <methodparam><type>int</type><parameter>cursor_or_connection</parameter></methodparam>
     </methodsynopsis>
    <para>
     Devuelve los mensajes de error en la forma
     <replaceable>XXX</replaceable>-<replaceable>NNNNN</replaceable>
     donde <replaceable>XXX</replaceable> es la procedencia del error
      y <replaceable>NNNNN</replaceable> es la identificaci&oacute;n del
     mensaje de error.
    <note>
     <para>El soporte para las identificaciones de conexi&oacute;n fue agregado en la versi&oacute;n 3.0.4.</para>
    </note></para>
    <para>
     En las versiones UNIX de Oracle, pueden encontrarse detalles acerca de un mensaje de error
     como este: <computeroutput>
<prompt>$</prompt> <userinput>oerr ora <replaceable>00001</replaceable></userinput> 00001, 00000,
"unique constraint (%s.%s) violated" // *Cause: An update or insert
statement attempted to insert a duplicate key //         For Trusted
ORACLE configured in DBMS MAC mode, you may see //         this message
if a duplicate entry exists at a different level.  // *Action: Either
remove the unique restriction or do not insert the key </computeroutput></para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-errorcode">
   <refnamediv>
    <refname>Ora_ErrorCode</refname>
    <refpurpose>captura el c&oacute;digo de error Oracle</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>Ora_ErrorCode</methodname>
     <methodparam><type>int</type><parameter>cursor_or_connection</parameter></methodparam>
     </methodsynopsis>
    <para>
     Devuelve el codigo num&eacute;rico de error de la &uacute;ltima declaraci&oacute;n ejecutada en el cursor
     o conexion espacificada.
     <!-- FIXME: se listar&aacute;n los valores posibles? -->
    <note>
     <para>El soporte para las identificaciones de conexi&oacute;n fue agregado en la versi&oacute;n 3.0.4.</para>
    </note></para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-exec">
   <refnamediv>
    <refname>Ora_Exec</refname>
    <refpurpose>ejecuta las declaraciones interpretadas en un cursor Oracle</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>ora_exec</methodname>
     <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
     </methodsynopsis>
    <para>
     Devuelve verdadero ante la ejecuci&oacute;n exitosa, de lo contrario, devuelve falso.  Los detalles del error
     pueden verse invocando las funciones <function>ora_error</function> y
     <function>ora_errorcode</function>.</para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-fetch">
   <refnamediv>
    <refname>Ora_Fetch</refname>
    <refpurpose>extrae una fila de datos a partir de un cursor</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>ora_fetch</methodname>
     <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
     </methodsynopsis>
    <para>
     Devuelve verdadero (se extrajo una fila) o falso (no hay mas filas, o ha
     ocurrido un error).  Si ocurre un error, los detalles del mismo
     pueden verse invocando las funciones <function>ora_error</function> y
     <function>ora_errorcode</function>.  Si no hubo errores,
     <function>ora_errorcode</function> devolver&aacute; 0.
     Recupera una hilera de datos partiendo de un cursor especificado.</para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-getcolumn">
   <refnamediv>
    <refname>Ora_GetColumn</refname>
    <refpurpose>toma datos de la fila extra&iacute;da</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>mixed</type><methodname>ora_getcolumn</methodname>
     <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
     <methodparam><type>mixed</type><parameter>column</parameter></methodparam>
     </methodsynopsis>
    <para>
     Devuelve la columna de datos.  Si hay un error, se devuelve falso y
     <function>ora_errorcode</function>
     devulve un valor distinto de cero.  Note, de igual manera, que la busqueda
     de un resultado Falso en esta funci&oacute;n, puede resultar verdadera, a&uacute;n en casos
     en que no ocurran errores:(resultado NULO, cadenas vacias, valor 0 o cadenas "0").
     Extrae los datos para una columna o resultado de funci&oacute;n.</para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-logoff">
   <refnamediv>
    <refname>Ora_Logoff</refname>
    <refpurpose>cierra una conexi&oacute;n Oracle</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>ora_logoff</methodname>
     <methodparam><type>int</type><parameter>connection</parameter></methodparam>
     </methodsynopsis>
    <para>
     Devuelve verdadero si es exitosa, o falso si hay errores.  Los detalles del error
     pueden verse invocando las funciones <function>ora_error</function> y
     <function>ora_errorcode</function>. Cierra la sesi&oacute;n de trabajo del usuario, y lo desconecta del servidor.</para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-logon">
   <refnamediv>
    <refname>Ora_Logon</refname>
    <refpurpose>Abre una conexi&oacute;n Oracle </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>ora_logon</methodname>
     <methodparam><type>string</type><parameter>usuario</parameter></methodparam>
     <methodparam><type>string</type><parameter>contrase&ntilde;a</parameter></methodparam>
     </methodsynopsis>
    <para>
     Establece una conexi&oacute;n entre PHP y una base de datos Oracle, con los
     datos de nombre de usuario y contrase&ntilde;a especificados.</para>

    <para>
     Las conexiones pueden llevarse adelante usando <productname>SQL*Net</productname>
     indicando el nombre <acronym>TNS</acronym> al
     <parameter>usuario</parameter> de este modo:
     <informalexample>
      <programlisting role="php">
$conn = Ora_Logon("usuario<emphasis>@TNSNAME</emphasis>", "contrase&ntilde;a");
</programlisting>
     </informalexample></para>

    <para>
     Si hubiesen datos con caracteres no-ASCII, habr&iacute;a que asegurarse de que
     est&eacute; presente la variable de entorno <envar>NLS_LANG</envar> en el sistema.
     Para los modulos de servidor, deber&iacute;an definirse en el entorno del servidor antes de iniciarlo.</para>

    <para>
     Devuelve el &iacute;ndice de la conexi&oacute;n si aquella tuvo &eacute;xito, de lo cantrario devuelve falso.
     Los detalles del error pueden verse invocando las funciones <function>ora_error</function> y
     <function>ora_errorcode</function>.
    </para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-open">
   <refnamediv>
    <refname>Ora_Open</refname>
    <refpurpose>abre un cursor Oracle</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>ora_open</methodname>
     <methodparam><type>int</type><parameter>connection</parameter></methodparam>
     </methodsynopsis>
    <para>
     Abre un cursor asociado con la conexi&oacute;n.</para>

    <para>
     Devuelve el &iacute;ndice del cursor o Falso si hay un error.
     Los detalles del error pueden verse invocando las funciones <function>ora_error</function> y
     <function>ora_errorcode</function>.
    </para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-parse">
   <refnamediv>
    <refname>Ora_Parse</refname>
    <refpurpose>interpreta una declaraci&oacute;n SQL</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>ora_parse</methodname>
     <methodparam><type>int</type><parameter>cursor_ind</parameter></methodparam>
     <methodparam><type>string</type><parameter>sql_statement</parameter></methodparam>
     <methodparam><type>int</type><parameter>defer</parameter></methodparam>
     </methodsynopsis>
    <para>
     Esta funci&oacute;n interpreta una declaraci&oacute;n SQL o un bloque PL/SQL y
     los asocia con el cursor dado.  Devuelve 0 si se ejecuta con exito, o  -1 ante un
     error.</para>

   </refsect1>
  </refentry>


  <refentry id="function.ora-rollback">
   <refnamediv>
    <refname>Ora_Rollback</refname>
    <refpurpose>retrocede en la lista de transacciones (hace un roll back)</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>ora_rollback</methodname>
     <methodparam><type>int</type><parameter>connection</parameter></methodparam>
     </methodsynopsis>
    <para>
     Deshace una transaccion Oracle.  (Ver
     <function>ora_commit</function> para la definici&oacute;n de transacci&oacute;n.)</para>

    <para>
     Devuelve verdadero si tiene &eacute;xito, o falso si hay un error.
     Los detalles del error pueden verse invocando las funciones <function>ora_error</function> y
     <function>ora_errorcode</function>.
    </para>

   </refsect1>
  </refentry>


 </reference>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->