tdbc.n 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. '\"
  2. '\" tdbc.n --
  3. '\"
  4. '\" Copyright (c) 2008 by Kevin B. Kenny.
  5. '\"
  6. '\" See the file "license.terms" for information on usage and redistribution of
  7. '\" this file, and for a DISCLAIMER OF ALL WARRANTIES.
  8. .TH "tdbc" n 8.6 Tcl "Tcl Database Connectivity"
  9. '\" .so man.macros
  10. '\" IGNORE
  11. .if t .wh -1.3i ^B
  12. .nr ^l \n(.l
  13. .ad b
  14. '\" # BS - start boxed text
  15. '\" # ^y = starting y location
  16. '\" # ^b = 1
  17. .de BS
  18. .br
  19. .mk ^y
  20. .nr ^b 1u
  21. .if n .nf
  22. .if n .ti 0
  23. .if n \l'\\n(.lu\(ul'
  24. .if n .fi
  25. ..
  26. '\" # BE - end boxed text (draw box now)
  27. .de BE
  28. .nf
  29. .ti 0
  30. .mk ^t
  31. .ie n \l'\\n(^lu\(ul'
  32. .el \{\
  33. '\" Draw four-sided box normally, but don't draw top of
  34. '\" box if the box started on an earlier page.
  35. .ie !\\n(^b-1 \{\
  36. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  37. .\}
  38. .el \}\
  39. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  40. .\}
  41. .\}
  42. .fi
  43. .br
  44. .nr ^b 0
  45. ..
  46. '\" END IGNORE
  47. .BS
  48. .SH "NAME"
  49. tdbc \- Tcl Database Connectivity
  50. .SH "SYNOPSIS"
  51. .nf
  52. package require \fBtdbc 1.0\fR
  53. package require \fBtdbc::\fIdriver version\fR
  54. \fBtdbc::\fIdriver\fB::connection create \fIdb\fR ?\fI\-option value\fR...?
  55. .fi
  56. .BE
  57. .SH "DESCRIPTION"
  58. .PP
  59. Tcl Database Connectivity (TDBC) is a common interface for Tcl
  60. programs to access SQL databases. It is implemented by a series of
  61. database \fIdrivers\fR: separate modules, each of which adapts Tcl to
  62. the interface of one particular database system. All of the drivers
  63. implement a common series of commands for manipulating the database.
  64. These commands are all named dynamically, since they all represent
  65. objects in the database system. They include \fBconnections,\fR
  66. which represent connections to a database; \fBstatements,\fR which
  67. represent SQL statements, and \fBresult sets,\fR which represent
  68. the sets of rows that result from executing statements. All of these
  69. have manual pages of their own, listed under \fBSEE ALSO\fR.
  70. .PP
  71. In addition, TDBC itself has a few service procedures that are chiefly
  72. of interest to driver writers. \fBSEE ALSO\fR also enumerates them.
  73. .SH "SEE ALSO"
  74. Tdbc_Init(3),
  75. tdbc::connection(n), tdbc::mapSqlState(n),
  76. tdbc::resultset(n), tdbc::statement(n), tdbc::tokenize(n),
  77. tdbc::mysql(n), tdbc::odbc(n), tdbc::postgres(n), tdbc::sqlite3(n)
  78. .SH "KEYWORDS"
  79. TDBC, SQL, database, connectivity, connection, resultset, statement
  80. .SH "COPYRIGHT"
  81. Copyright (c) 2008 by Kevin B. Kenny.
  82. '\" Local Variables:
  83. '\" mode: nroff
  84. '\" End:
  85. '\"