bionic (3) tdbc_tokenize.3tcl.gz

Provided by: tcl8.6-tdbc_1.0.6-1_amd64 bug

NAME
       tdbc::tokenize - TDBC SQL tokenizer


SYNOPSIS
       package require tdbc 1.0

       tdbc::tokenize string
________________________________________________________________________________________________________________


DESCRIPTION
       As  a  convenience  to database drivers, Tcl Database Connectivity (TDBC) provides a command to break SQL
       code apart into tokens so that bound variables can readily be identified and substituted.

       The tdbc::tokenize command accepts as its parameter a string that is expected to contain one or more  SQL
       statements.  It  returns  a  list  of  substrings; concatenating these substrings together will yield the
       original string. Each substring is one of the following:

       [1]    A bound variable, which begins with one of the characters ':', '@', or '$'. The remainder  of  the
              string  is  the  variable  name  and will consist of alphanumeric characters and underscores. (The
              leading character will be be non-numeric.)

       [2]    A semicolon that separates two SQL statements.

       [3]    Something else in a SQL statement. The  tokenizer  does  not  attempt  to  parse  SQL;  it  merely
              identifies  bound  variables  (distinguishing them from similar strings appearing inside quotes or
              comments) and statement delimiters.


SEE ALSO
       tdbc(3tcl), tdbc::connection(3tcl), tdbc::statement(3tcl), tdbc::resultset(3tcl)


KEYWORDS
       TDBC, SQL, database, tokenize


       Copyright (c) 2008 by Kevin B. Kenny.