home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / oraperl2.zip / oraperl.ref < prev    next >
Text File  |  1993-07-01  |  2KB  |  78 lines
  1. .\"    Quick reference sheet for OraPerl
  2. .\"
  3. .nf
  4. .\"
  5. .vs 10
  6. .ps 10
  7. \fBOraperl Quick Reference\fP
  8. .ps 8
  9. .sp 2
  10. .ps 10
  11. \fBOraperl Functions\fP
  12. .ps 8
  13. .in +2m
  14. .sp
  15. .ti -2m
  16. \fB&ora_version\fP
  17. Displays version and copyright information for Oraperl.
  18. .sp
  19. .ti -2m
  20. \fB$lda = &ora_login($database, $name, $password)\fP
  21. Logs into the specified database with the name and password given.
  22. Returns an \fIlda\fP for use with \fIora_open()\fP.
  23. .sp
  24. .ti -2m
  25. \fB$csr = &ora_open($lda, $statement)\fP
  26. Associates the given SQL statement in the database identified by $lda.
  27. Executes it if it contains no substitution variables.
  28. Returns a \fIcsr\fP for use with \fIora_fetch()\fP.
  29. .sp
  30. .ti -2m
  31. \fB&ora_bind($csr, $var, ...)\fP
  32. Binds the given values to the substition variables in the SQL statement
  33. associated with $csr, and executes the resulting statement.
  34. .sp
  35. .ti -2m
  36. \fB$n = &ora_fetch($csr)\fP
  37. Returns the number of fields available from the query.
  38. .sp
  39. .ti -2m
  40. \fB@ary = &ora_fetch($csr)\fP
  41. Retrieves the (next) output data from the statement identified by $csr.
  42. .sp
  43. .ti -2m
  44. \fB&ora_close($csr)\fP
  45. Finishes the SQL statement identified by $csr.
  46. .sp
  47. .ti -2m
  48. \fB&ora_do($lda, $stmt)\fP
  49. Equivalent to \fI&ora_close\fP(\fI&ora_open(...))\fP
  50. for statements which have no substitution variables and do not return data.
  51. .sp
  52. .ti -2m
  53. \fB&ora_logoff($lda)\fP
  54. Logs out of the database identified by $lda.
  55. .ti -2m
  56. .sp 2
  57. .ps 10
  58. \fBOraperl Variables\fP
  59. .sp
  60. .ps 8
  61. .ti -2m
  62. \fB$ora_errno\fP  (read only)
  63. Contains the error code from the last funtion call.
  64. .sp
  65. .ti -2m
  66. \fB$ora_errstr\fP  (read only)
  67. Contains the error message corresponding to $ora_errno.
  68.  
  69. .ti -2m
  70. \fB$ora_debug\fP  (if debugging is enabled)
  71. Contains the debugging flags for \fIOraperl\fP, initialised from Perl's -D flag.
  72. May be set by a program to debug only certain parts of the script.
  73. The following flags are meaningful:
  74. .ta 5m
  75. \0\08    report function entry and exit
  76. \032    report conversions between strings and numerics
  77. 128    report use of malloc and free
  78.