Change Standards-Version to 3.9.8 - no changes required.

[sven/mysqltcl.git] / doc / mysqltcl.n

'\"
'\" Generated from file 'mysqltcl.man' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"     Start paragraph describing an argument to a library procedure.
'\"     type is type of argument (int, etc.), in/out is either "in", "out",
'\"     or "in/out" to describe whether procedure reads or modifies arg,
'\"     and indent is equivalent to second arg of .IP (shouldn't ever be
'\"     needed;  use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\"     Give maximum sizes of arguments for setting tab stops.  Type and
'\"     name are examples of largest possible arguments that will be passed
'\"     to .AP later.  If args are omitted, default tab stops are used.
'\"
'\" .BS
'\"     Start box enclosure.  From here until next .BE, everything will be
'\"     enclosed in one large box.
'\"
'\" .BE
'\"     End of box enclosure.
'\"
'\" .CS
'\"     Begin code excerpt.
'\"
'\" .CE
'\"     End code excerpt.
'\"
'\" .VS ?version? ?br?
'\"     Begin vertical sidebar, for use in marking newly-changed parts
'\"     of man pages.  The first argument is ignored and used for recording
'\"     the version when the .VS was added, so that the sidebars can be
'\"     found and removed when they reach a certain age.  If another argument
'\"     is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\"     End of vertical sidebar.
'\"
'\" .DS
'\"     Begin an indented unfilled display.
'\"
'\" .DE
'\"     End of indented unfilled display.
'\"
'\" .SO
'\"     Start of list of standard options for a Tk widget.  The
'\"     options follow on successive lines, in four columns separated
'\"     by tabs.
'\"
'\" .SE
'\"     End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\"     Start of description of a specific option.  cmdName gives the
'\"     option's name as specified in the class command, dbName gives
'\"     the option's name in the option database, and dbClass gives
'\"     the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\"     Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id$
'\"
'\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"     # Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1  \\fI\\$2\\fP    (\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1  \\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"     # define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"     # BS - start boxed text
'\"     # ^y = starting y location
'\"     # ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"     # BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"     Draw four-sided box normally, but don't draw top of
.\"     box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"     # VS - start vertical sidebar
'\"     # ^Y = starting y location
'\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"     # VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"     # Special macro to handle page bottom:  finish off current
'\"     # box/sidebar if in box/sidebar mode, then invoked standard
'\"     # page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"     Draw three-sided box if this is the box's first page,
.\"     draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"     # DS - begin display
.de DS
.RS
.nf
.sp
..
'\"     # DE - end display
.de DE
.fi
.RE
.sp
..
'\"     # SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 4c 8c 12c
.ft B
..
'\"     # SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"     # OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:      \\fB\\$1\\fR
Database Name:  \\fB\\$2\\fR
Database Class: \\fB\\$3\\fR
.fi
.IP
..
'\"     # CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"     # CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "mysqltcl" n 3.0  ""
.BS
.SH NAME
mysqltcl \- MySQL server access commands for Tcl
.SH SYNOPSIS
package require \fBTcl  8.4\fR
.sp
package require \fBmysqltcl  3.0\fR
.sp
\fB::mysql::connect\fR ?\fIoption value\fR...?
.sp
\fB::mysql::use\fR \fIhandle\fR \fIdatabase\fR
.sp
\fB::mysql::sel\fR \fIhandle\fR \fIsql-statement\fR ?\fI-list|-flatlist\fR?
.sp
\fB::mysql::fetch\fR \fIhandle\fR
.sp
\fB::mysql::exec\fR \fIhandle\fR \fIsql-statement\fR
.sp
\fB::mysql::query\fR \fIhandle\fR \fIsql-select-statement\fR
.sp
\fB::mysql::endquery\fR \fIquery-handle\fR
.sp
\fB::mysql::map\fR \fIhandle\fR \fIbinding-list\fR \fIscript\fR
.sp
\fB::mysql::receive\fR \fIhandle\fR \fIsql-statment\fR \fIbinding-list\fR \fIscript\fR
.sp
\fB::mysql::seek\fR \fIhandle\fR \fIrow-index\fR
.sp
\fB::mysql::col\fR \fIhandle\fR \fItable-name\fR \fIoption\fR
.sp
\fB::mysql::col\fR \fIhandle\fR \fItable-name\fR \fIoptionkist\fR
.sp
\fB::mysql::col\fR \fIhandle\fR ?\fIoption\fR...?
.sp
\fB::mysql::info\fR \fIhandle\fR \fIoption\fR
.sp
\fB::mysql::baseinfo\fR \fIoption\fR
.sp
\fB::mysql::ping\fR \fIhandle\fR
.sp
\fB::mysql::changeuser\fR \fIuser\fR \fIpassword\fR ?\fIdatabase\fR?
.sp
\fB::mysql::result\fR \fIhandle\fR \fIoption\fR
.sp
\fB::mysql::state\fR \fIhandle\fR ?\fI-numeric\fR?
.sp
\fB::mysql::close\fR ?\fIhandle\fR?
.sp
\fB::mysql::insertid\fR \fIhandle\fR
.sp
\fB::mysql::escape\fR ?\fIhandle\fR? \fIstring\fR
.sp
\fB::mysql::autocommit\fR \fIhandle\fR \fIboolean\fR
.sp
\fB::mysql::commit\fR \fIhandle\fR
.sp
\fB::mysql::rollback\fR \fIhandle\fR
.sp
\fB::mysql::nextresult\fR \fIhandle\fR
.sp
\fB::mysql::moreresult\fR \fIhandle\fR
.sp
\fB::mysql::warningcount\fR \fIhandle\fR
.sp
\fB::mysql::isnull\fR \fIvalue\fR
.sp
\fB::mysql::newnull\fR
.sp
\fB::mysql::setserveroption\fR \fIhandle\fR \fIoption\fR
.sp
\fB::mysql::shutdown\fR \fIhandle\fR
.sp
\fB::mysql::encoding\fR \fIhandle\fR ?encoding?
.sp
.BE
.SH DESCRIPTION
MySQLTcl is a collection of Tcl commands and a Tcl global array that
provide access to MySQL database servers.
.PP
MySQLTcl is nothing more than a patched version of a patched version
of Hakan Soderstrom's patch of Tom Poindexter's Sybtcl.
.PP
Mysqltcl is binary Tcl library (extension) written in C language that use direkt
official MySQL C-API. Almost all Tcl commands correspond to MySQL C-API functions.
For detail documentation see official MySQL C-API manual.
.SH "MYSQLTCL COMMANDS"
.TP
\fB::mysql::connect\fR ?\fIoption value\fR...?
Connect to a MySQL server.
A handle is returned which should be used in other mysqltcl
commands using this connection.
::mysql::connect raises a Tcl error if the connection fails.
::mysql::connect read first the options from my.cnf file group mysqltcl.
See MySQL documentation chapter "options files".
Possible connection options are:
.RS
.TP
\fB-host\fR \fIhostname\fR
The host on which the server is located. The local host is used by default.
.TP
\fB-user\fR \fIuser\fR
The user whose name is used for the connection.
The current Unix user-name is used by default.
.TP
\fB-password\fR \fIpassword\fR
The password that must be used for the connection.
If it is not present, the connection is possible only for users with
no password on the server.
.TP
\fB-db\fR \fIdb\fR
If this option is present, \fIdb\fR is used as current database, with no need
for a call to \fImysql::use\fR.
.TP
\fB-port\fR \fIport\fR
The port number for the TCP/IP connection, if it's different from the default.
.TP
\fB-socket\fR \fIsocket\fR
The socket or named pipe for the connection.
.TP
\fB-encoding\fR \fIencodingname\fR
The option works similar to -encoding option in fconfigure. It support also
special encoding name binary. By option -binary no converting will be done be reading or writing to/from MySQL.
If option is not set the system encoding (see utf-8) is used.
Please test all input and outputs with another program to check that all
is the way you expect it. If option binary is not used the system procedures
Tcl_ExternalToUtfDString (writing) and Tcl_ExternalToUtf (reading) will be used
by option binary the function Tcl_GetByteArrayFromObj and Tcl_NewByteArrayObj are used.
If you want to manipulate binary date use -encoding binary. By handling textes set your
special encoding that you want to use in your database. Consider what another system access the
database and what encoding they expect. It can useful
to use -encoding utf-8. That is standard encoding in some linux distributions and newer systems.
.TP
\fB-compress\fR \fIboolean\fR
Use compression protocol. Default is false
.TP
\fB-odbc\fR \fIboolean\fR
The client is an ODBC client. This changes mysqld to be more ODBC-friendly. Default is false
.TP
\fB-noschema\fR \fIboolean\fR
Don't allow the db_name.tbl_name.col_name syntax. This is for ODBC. It causes the parser to generate an error if you use that syntax, which is useful for trapping bugs in some ODBC programs. This changes mysqld to be more ODBC-friendly. Default is false
.TP
\fB-multistatement\fR \fIboolean\fR
Tell the server that the client may send multiple-row-queries (separated by `;').
If this flag is not set, multiple-row-queries are disabled. Default is false.
.TP
\fB-multiresult\fR \fIboolean\fR
Tell the server that the client can handle multiple-result sets from multi-queries or stored procedures.
This is automatically set if CLIENT_MULTI_STATEMENTS is set.
.TP
\fB-localfiles\fR \fIboolean\fR
Enable LOAD DATA LOCAL handling. Default is false.
.TP
\fB-foundrows\fR \fIboolean\fR
Return the number of found (matched) rows, not the number of affected rows.
Default is false.
.TP
\fB-interactive\fR \fIboolean\fR
Allow interactive_timeout seconds (instead of wait_timeout seconds) of inactivity before closing the connection.
The client's session wait_timeout variable will be set to the value of the session interactive_timeout variable.
Default is false.
.TP
\fB-ssl\fR \fIboolean\fR
Switch to SSL after handshake. Default is  false
.TP
\fB-sslkey\fR \fIstring\fR
is the pathname to the key file.
Used if -ssl is true
.TP
\fB-sslcert\fR \fIstring\fR
is the pathname to the certificate file.
Used if -ssl is true
.TP
\fB-sslca\fR \fIstring\fR
is the pathname to the certificate authority file.
Used if -ssl is true
.TP
\fB-sslcapath\fR \fIstring\fR
is the pathname to a directory that contains trusted SSL CA certificates in pem format.
Used if -ssl is true
.TP
\fB-sslcipher\fR \fIstring\fR
is a list of allowable ciphers to use for SSL encryption.
Used if -ssl is true
.TP
\fB-reconnect\fR \fIboolean\fR
default is false.
.RE
.TP
\fB::mysql::use\fR \fIhandle\fR \fIdatabase\fR
Associate a connected handle with a particular database.
\fIhandle\fR must be a valid handle previously obtained from ::mysql::connect.
mysql::use raises a Tcl error if the handle is not valid or
if the database name specified could not be used.
.sp
Consider you can use mysqltcl without to specify the database, in this case
you must use explizit schema notation to specify the table in sql.
.nf

::mysql::sel $handle {select * from uni.student}

.fi
with option connection \fI-noschema\fR you can prohibit such syntax.
.TP
\fB::mysql::sel\fR \fIhandle\fR \fIsql-statement\fR ?\fI-list|-flatlist\fR?
Send \fIsql-statement\fR to the server.
.sp
If \fIsql-statement\fR is a SELECT statement and no \fI-list\fR or
\fI-flatlist\fR option is specified, the command returns the
number of rows returned as the result of the query.
The rows can be obtained by the \fI::mysql::fetch\fR and/or the
\fI::mysql::map\fR commands.
The resulting rows are called the \fIpending result\fR.
.sp
If \fIsql-statement\fR is a SELECT statement and \fI-list\fR or \fI-flatlist\fR
is specified, the command returns the full list of rows returned as
the result of the query in one of two possible formats:
.RS
.TP
\fB-list\fR
generates a list of lists, in which each element is a row of the result.
.TP
\fB-flatlist\fR
generates the concatenation of all rows in a single list, which
is useful for scanning with a single \fIforeach\fR.
.RE
Example:
.nf

% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" -list
{1 Joe} {2 Phil} {3 John}
% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" -flatlist
{1 Joe 2 Phil 3 John}

.fi
Note that both list syntaxes are faster than something like
.nf

% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS"
% ::mysql::map $db {id name} {lappend result $id $name}
% set $result
{1 Joe 2 Phil 3 John}

.fi
If \fIsql-statement\fR is a valid MySQL statement, but not a SELECT
statement, the command returns -1 after executing the statement, or an empty
string if \fI-list\fR or \fI-flatlist\fR is specified.
There is no pending result in this case.
.sp
In any case ::mysql::sel implicitly cancels any previous result still
pending for the handle.
.TP
\fB::mysql::fetch\fR \fIhandle\fR
Returns the next row from result set as Tcl list.
mysql::fetch raises a Tcl error if there is no pending result for \fIhandle\fR.
mysql::fetch was former named mysqlnext.
.TP
\fB::mysql::exec\fR \fIhandle\fR \fIsql-statement\fR
Send \fIsql-statement\fR, a MySQL non-SELECT statement, to the server.
The \fIhandle\fR must be in use (through ::mysql::connect and ::mysql::use).
.sp
::mysql::exec implicitly cancels any previous result pending for the handle.
.sp
If \fIsql-statement\fR is a valid MySQL SELECT statement, the statement
is executed, but the result is discarded.
No Tcl error is generated.
This amounts to a (potentially costly) no-op.
Use the ::mysql::sel command for SELECT statements.
.sp
::mysql::exec returns the number of affected rows (DELETE, UPDATE).
In case of multiple statement ::mysql::exec returns a list of number of affected rows.
.sp
.TP
\fB::mysql::query\fR \fIhandle\fR \fIsql-select-statement\fR
Send \fIsql-select-statement\fR to the server.
.sp
\fImysql::query\fR allow to send multiple nested queries on one handle (without need to build
new handle or caching results).
mysql::query return a query handle that can be used as handle in commands as (mysql::fetch,
::mysql::map, mysql::seek, mysql::col, mysql::result).
After result proceeding all query must be
freed with \fI::mysql::endquery query-hanlde\fR command.
.sp
Example:
.nf

set query1 [::mysql::query $db {SELECT ID, NAME FROM FRIENDS}\\]
while {[set row [::mysql::fetch $query1]]!=""} {
    set id [lindex $row 0]
    set query2 [::mysql::query $db "SELECT ADDRESS FROM ADDRESS WHERE FRIENDID=$ID"]
    ::mysql::map $query2 address { puts "address = $address" }
    ::mysql::endquery $query2
}
::mysql::endquery $query1

.fi
In most cases one should use sql-joins and avoid nested queries.
SQL-sever can optimize such queries.
But in some applications (GUI-Forms) where the results are used long time the inner
query is not known before.
.TP
\fB::mysql::endquery\fR \fIquery-handle\fR
free result memory after \fI::mysql::query\fR command.
You must invoke ::mysql::endquery after each mysqlquery to not cause memory leaks. See mysqlquery command.
.sp
Using \fI::mysql::endquery\fR on db-handle will free also memory (pending result) after \fI::mysql::sel\fR command.
.sp
.TP
\fB::mysql::map\fR \fIhandle\fR \fIbinding-list\fR \fIscript\fR
Iterate a script over the rows of the pending result.
::mysql::map may consume all rows or only some of the rows of the pending
result.
Any remaining rows may be obtained by further ::mysql::fetch or ::mysql::map
commands.
.sp
\fIhandle\fR must be a handle with a pending result from a previous
::mysql::sel command.
\fIbinding-list\fR must be a list of one or more variable names.
\fIscript\fR must be a Tcl script.
It may be empty, but usually it contains one or more commands.
.sp
::mysql::map processes one row at a time from the pending result.
For each row the column values are bound to the variables in the
binding list, then the script is executed.
Binding is strictly positional.
The first variable in the binding list is bound to the first column of
the row, and so on.
The variables are created in the current context (if they do not
already exist).
A variable name begining with a hyphen is not bound; it serves as a
placeholder in the binding list.
If there are more columns than variables the extra columns are
ignored.
.sp
The ::mysql::map command is similar to an ordinary \fIforeach\fR.
A \fIforeach\fR iterates over the elements of a list, ::mysql::map
iterates over the rows of a pending result.
In both cases iteration is affected by \fIbreak\fR and \fIcontinue\fR
Tcl commands.
The binding list variables retain their last values after the command
has completed.
.sp
A simple example follows.
Assume $db is a handle in use.
.nf

::mysql::sel $db {
    select lname, fname, area, phone from friends order by lname, fname
}
::mysql::map $db {ln fn - phone} {
   if {$phone == {}} continue
   puts [format "%16s %-8s %s" $ln $fn $phone]
}

.fi
The ::mysql::sel command gets and sorts all rows from table friends.
The ::mysql::map command is used to format and print the result in a way
suitable for a phone list.
For demonstration purposes one of the columns (area) is not used.
The script begins by skipping over rows which have no phone number.
The second command in the script formats and prints values from the row.
.sp
::mysql::map raises a Tcl error if there is no pending result for
\fIhandle\fR, or if \fIbinding-list\fR contains more variables than
there are columns in the pending result.
.sp
.TP
\fB::mysql::receive\fR \fIhandle\fR \fIsql-statment\fR \fIbinding-list\fR \fIscript\fR
This command works the same way as the command mysqtclmap but
it do not need leading ::mysql::sel command.
The main difference is internal using of MySQL client library.
This command use mysql_use_result from C-API that do not
store result on client but try to receive the rows directly
from server.
There is also no client cache.
This command can be faster as using of ::mysql::sel and by
very big resultset will not overload client machine.
The scipt should process the result immadiatly because
it can block table (or tables) for another clients.
If performance matter please test all alternatives separatly.
You must consider two aspects: memory consumption and performance.
.TP
\fB::mysql::seek\fR \fIhandle\fR \fIrow-index\fR
Moves the current position among the rows in the pending result.
This may cause \fI::mysql::fetch\fR and \fI::mysql::map\fR to re-read rows, or to
skip over rows.
.sp
Row index 0 is the position just before the first row in the pending result;
row index 1 is the position just before the second row, and so
on.
You may specify a negative row index.
Row index -1 is the position just before the last row;
row index -2 is the position just before the second last row,
and so on.
An out-of-bounds row index will cause ::mysql::seek to set the new current
position either just before the first row (if the index is too negative),
or just after the last row (if the index exceeds the number of rows).
This is not an error condition.
.sp
::mysql::seek returns the number of rows that can be read sequentially from
the new current position.
::mysql::seek raises a Tcl error if there is no pending result for \fIhandle\fR.
.sp
Portability note: The functionality of \fI::mysql::seek\fR is frequently
absent in other Tcl extensions for SQL.
That is because MySQL C-API client library ofers own result set caching functionality
that lacks another SQL-APIs.
That increase the performance because all rows are received at once and the query does
not block the server for another clienst , on the other
hand you works on the cached data can use a lot of memory and are up to date only in the moment
of query but not fetch.
.sp
.TP
\fB::mysql::col\fR \fIhandle\fR \fItable-name\fR \fIoption\fR
.TP
\fB::mysql::col\fR \fIhandle\fR \fItable-name\fR \fIoptionkist\fR
.TP
\fB::mysql::col\fR \fIhandle\fR ?\fIoption\fR...?
Return information about the columns of a table.
\fIhandle\fR must be in use.
\fItable-name\fR must be the name of a table; it may be a table name
or \fI-current\fR if there is a pending result.
One or more options control what information to return.
Each option must be one of the following keywords.
.RS
.TP
\fBname\fR Return the name of a column.
.TP
\fBtype\fR
Return the type of a column; one of the strings \fIdecimal\fR,
\fItiny\fR, \fIshort\fR, \fIlong\fR, \fIfloat\fR, \fIdouble\fR,
\fInull\fR, \fItimestamp\fR, \fIlong long\fR, \fIint24\fR, \fIdate\fR,
\fItime\fR, \fIdate time\fR, \fIyear\fR, \fInew date\fR, \fIenum\fR,
\fIset\fR, \fItiny blob\fR, \fImedium blob\fR, \fIlong blob\fR,
\fIblob\fR, \fIvar string\fR, or \fIstring\fR.
Note that a column of type \fIchar\fR will return tiny, while they are
represented equally.
.TP
\fBlength\fR Return the length of a column in bytes.
.TP
\fBtable\fR Return the name of the table in which this column occurs.
.TP
\fBnon_null\fR Return the string "1" if the column is non-null; otherwise "0".
.TP
\fBprim_key\fR Return the string "1" if the column is part of the primary key;
otherwise "0".
.TP
\fBnumeric\fR Return the string "1" if the column is numeric; otherwise "0".
.TP
\fBdecimals\fR Return the string "1" if the column is non-null; otherwise "0".
.RE
The three forms of this command generate their result in a
particular way.
.RS
.IP [1]
If a single option is present the result is a simple list of
values; one for each column.
.IP [2]
If the options are given in the form of an option list the
result is a list of lists.
Each sublist corresponds to a column and contains the information
specified by the options.
.IP [3]
If several options are given, but not in a list, the result is also
a list of lists.
In this case each sublist corresponds to an option and contains one
value for each column.
.RE
The following is a sample interactive session containing all forms of
the ::mysql::col command and their results.
The last command uses the \fI-current\fR option.
It could alternatively specify the table name explicitly.
.nf

%::mysql::col $db friends name
name lname area phone
% ::mysql::col $db friends {name type length}
{fname char 12} {lname char 20} {area char 5} {phone char 12}
% ::mysql::sel $db {select * from friends}
% ::mysql::col $db -current name type length
{fname lname area phone} {char char char char} {12 20 5 12}]

.fi
.TP
\fB::mysql::info\fR \fIhandle\fR \fIoption\fR
Return various database information depending on the \fIoption\fR.
The option must be one of the following keywords.
.RS
.TP
\fBinfo\fR
Return a String with information about last operation.
"Records: 3 Duplicates: 0 Warnings: 0" by INSERT or
"Rows matched: 40 Changed: 40 Warnings: 0" by UPDATE statements
(read the manual for mysql_info in MySQL C API documentation)
.TP
\fBdatabases\fR
Return a list of all database names known to the server.
The handle must be connected.
.TP
\fBdbname\fR
Return the name of the database with which the handle is associated.
The handle must be in use.
.TP
\fBdbname?\fR
Return the name of the database with which the handle is associated;
an empty string if the handle is connected, but not in use.
.TP
\fBhost\fR
Return the name of the host to which the handle is connected.
The handle must be connected.
.TP
\fBhost\fR
Return the name of the host to which the handle is connected; an empty
string if the handle is not valid.
.TP
\fBtables\fR
Return a list of all table names in the database with which the handle
is associated.
The handle must be in use.
.TP
\fBserverversion\fR
Returns the version number of the server as a string.
.TP
\fBserverversionid\fR
Returns the version number of the server as an integer.
.TP
\fBsqlstate\fR
Returns a string containing the SQLSTATE error code for the last error.
The error code consists of five characters. '00000' means ``no error.''
The values are specified by ANSI SQL and ODBC.
Note that not all MySQL errors are yet mapped to SQLSTATE's.
The value 'HY000' (general error) is used for unmapped errors.
.TP
\fBstate\fR
Returns a character string containing information similar to that provided by the mysqladmin status command.
This includes uptime in seconds and the number of running threads, questions, reloads, and open tables.
.RE
.TP
\fB::mysql::baseinfo\fR \fIoption\fR
return information information that do not need handle.
.RS
.TP
\fBconnectparameters\fR
return all supported connecting options
.TP
\fBclientversion\fR
return the version of underlying MYSQL C-API library
.RE
.TP
\fB::mysql::ping\fR \fIhandle\fR
Checks whether the connection to the server is working. If it has gone down, an automatic reconnection is attempted.
.sp
This function can be used by clients that remain idle for a long while, to check whether the server has closed the connection and reconnect if necessary.
.sp
Return True if server is alive
.TP
\fB::mysql::changeuser\fR \fIuser\fR \fIpassword\fR ?\fIdatabase\fR?
Changes the user and causes the database specified by database to become the default (current) database on the connection specified by MySQL. In subsequent queries, this database is the default for table references that do not include an explicit database specifier.
.sp
::mysql::changeuser fails unless the connected user can be authenticated or if he doesn't have permission to use the database. In this case the user and database are not changed
.sp
if database parameter may be set were is no default database.
.sp
Cause Error if operation is not succesed
.TP
\fB::mysql::result\fR \fIhandle\fR \fIoption\fR
Return information about the pending result.
Note that a result is pending until canceled by a ::mysql::exec command,
even if no rows remain to be read.
\fIOption\fR must be one of the following keywords.
.RS
.TP
\fBcols\fR
Return the number of columns in the pending result.
There must be a pending result.
.TP
\fBcols\fR
Return the number of columns in the pending result; an empty string if
no result is pending.
.TP
\fBcurrent\fR
Return the current position in the pending result; a non-negative integer.
This value can be used as \fIrow-index\fR in the ::mysql::seek command.
An error is raised if there is no pending result.
.TP
\fBcurrent?\fR
As above, but returns an empty string if there is no pending result.
.TP
\fBrows\fR
Return the number of rows that can be read sequentially from the
current position in the pending result.
There must be a pending result.
.TP
\fBrows\fR
Return the number of rows that can be read sequentially from the
current position in the pending result; an empty string if no result
is pending.
.sp
[::mysql::result $db current] + [::mysql::result $db rows]
always equals the total number of rows in the pending result.
.RE
.TP
\fB::mysql::state\fR \fIhandle\fR ?\fI-numeric\fR?
Return the state of a handle as a string or in numeric form.
There is no requirement on \fIhandle\fR; it may be any string.
The return value is one of the following strings, or the corresponding
numeric value if \fI-numeric\fR is specified.
The states form a progression where each state builds on the previous.
.RS
.TP
\fBNOT_A_HANDLE (0)\fR
The string supplied for \fIhandle\fR is not a mysqltcl handle at all.
.TP
\fBUNCONNECTED (1)\fR
The string supplied for \fIhandle\fR is one of the possible mysqltcl
handles, but it is not valid to any server.
.TP
\fBCONNECTED (2)\fR
The handle is connected to a server, but not associated with a database.
.TP
\fBIN_USE (3)\fR
The handle is connected and associated with a database, but there is
no pending result.
.TP
\fBRESULT_PENDING (4)\fR
The handle is connected, associated with a database, and there is a
pending result.
.RE
.TP
\fB::mysql::close\fR ?\fIhandle\fR?
Closes the server connection associated with \fIhandle\fR, causing it
to go back to the unconnected state.
Closes all connections if \fIhandle\fR is omitted.
Returns an empty string.
::mysql::close raises a Tcl error if a handle is specified which is not
valid.
.TP
\fB::mysql::insertid\fR \fIhandle\fR
Returns the auto increment id of the last INSERT statement.
.TP
\fB::mysql::escape\fR ?\fIhandle\fR? \fIstring\fR
Returns the content of \fIstring\fR, with all special characters escaped,
so that it is suitable for use in an SQL statement. This is simpler (faster)
than using a general \fIregexp\fR or string map.
If handle is specified C-API function mysql_real_escape_string is used.
This is the recommended usage because in this case current character set is respected.
.TP
\fB::mysql::autocommit\fR \fIhandle\fR \fIboolean\fR
Sets autocommit mode on if mode is 1, off if mode is 0.
.TP
\fB::mysql::commit\fR \fIhandle\fR
Commits the current transaction.
.TP
\fB::mysql::rollback\fR \fIhandle\fR
Rollback the current transaction.
.TP
\fB::mysql::nextresult\fR \fIhandle\fR
If more query results exist, mysql::nextresult() reads the next query results and returns the status back to application.
returns -1 if no result or number of rows in the result set.
.TP
\fB::mysql::moreresult\fR \fIhandle\fR
Returns true if more results exist from the currently executed query, and the application must call mysql::result to fetch the results.
.TP
\fB::mysql::warningcount\fR \fIhandle\fR
Returns the number of warnings generated during execution of the previous SQL statement.
.TP
\fB::mysql::isnull\fR \fIvalue\fR
Null handling is a known problem with Tcl, especially with DB interaction.
The mysql "varchar" type has two valid blank values, NULL and an empty
string. This is where the problem arises; Tcl is not able to differentiate
between the two because of the way it handles strings.
Mysql has new internal Tcl type for null that string representation is stored
in global array mysqltcl(nullvalue) and as default empty string.
mysql::isnull can be used for safe check for null value.
Warning mysql::isnull works only reliable if there are no type conversation on
returned rows.
Consider row is always Tcl list even when there are only one column in the row.
.nf

set row [::mysql::next $handle]
if {[mysql::isnull [lindex $row 1]]} {
   puts "2. column of $row is null"
}
if {[mysql::isnull $row]} {
   puts "this does not work, because of type conversation list to string"
}

.fi
.TP
\fB::mysql::newnull\fR
create new null object. It can be used to simulate returned row contents.
.TP
\fB::mysql::setserveroption\fR \fIhandle\fR \fIoption\fR
there are only 2 options now: -multi_statment_on and -multi_statment_off
.TP
\fB::mysql::shutdown\fR \fIhandle\fR
Asks the database server to shut down. The connected user must have SHUTDOWN privileges.
.TP
\fB::mysql::encoding\fR \fIhandle\fR ?encoding?
Ask or change a encoding of connection.
There are special encoding "binary" for binary data transfers.
.PP
.SH "STATUS INFORMATION"
Mysqltcl creates and maintains a Tcl global array to provide status
information.
Its name is \fImysqlstatus\fR.
.P
Mysqlstatus elements:
.TP
code
A numeric conflict code set after every mysqltcl command.
Zero means no conflict; non-zero means some kind of conflict.
All conflicts also generate a Tcl error.
.sp
All MySQL server conflicts set mysqlstatus(code) to the numeric
code of the MySQL error.
.sp
Any other conflict sets mysqlstatus(code) to -1.
.TP
command
The last failing mysqltcl command.
Not updated for successful commands.
.TP
message
Message string for the last conflict detected.
The same string is returned as the result of the failing mysqltcl
command.
Not updated for successful commands.
.TP
nullvalue
The string to use in query results to represent the SQL null value.
The empty string is used initially.
You may set it to another value.
.PP
.SH "Backward compatibility"
Up from version 3.0 all mysql commands are declared in ::mysql namespace.
All names for example mysqlconnect are also aviable but deprecated.
All old commands have the name pattern mysql{name} and the most of them are now mysql::{name}.
The exception is mysqlnext, which  was renamed to mysql::fetch.
.SH "BUGS & POSSIBLE MISFEATURES"
Deleting any of the mysqltcl commands closes all connections.
.SH AUTHORS
.IP \(bu
Tobias Ritzau
.IP \(bu
Paolo Brutti
.IP \(bu
Artur Trzewik (mail@xdobry.de) - active maintainer
.PP
MySQLTcl is derived from a patch of msql by Hakan Soderstrom, Soderstrom Programvaruverkstad,
S-12242 Enskede, Sweden.
msql is derived from Sybtcl by Tom Poindexter.
There are many contributors and bug reporter that are not mentioned.
If you have contributed to mysqltcl and wants to be on the list contact Artur Trzewik.