[wxWidgets.git] / include / wx / dbtable.h

///////////////////////////////////////////////////////////////////////////////
// Name:        dbtable.h
// Purpose:     Declaration of the wxDbTable class.
// Author:      Doug Card
// Modified by: George Tasker
//              Bart Jourquin
//              Mark Johnson
// Created:     9.96
// RCS-ID:      $Id$
// Copyright:   (c) 1996 Remstar International, Inc.
// Licence:     wxWindows licence, plus:
// Notice:      This class library and its intellectual design are free of charge for use,
//              modification, enhancement, debugging under the following conditions:
//              1) These classes may only be used as part of the implementation of a
//                 wxWidgets-based application
//              2) All enhancements and bug fixes are to be submitted back to the wxWidgets
//                 user groups free of all charges for use with the wxWidgets library.
//              3) These classes may not be distributed as part of any other class library,
//                 DLL, text (written or electronic), other than a complete distribution of
//                 the wxWidgets GUI development toolkit.
///////////////////////////////////////////////////////////////////////////////

/*
// SYNOPSIS START
// SYNOPSIS STOP
*/

#ifndef DBTABLE_DOT_H
#define DBTABLE_DOT_H

#include "wx/version.h"

#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  #pragma interface "dbtable.h"
#endif

#include "wx/db.h"

#include "wx/variant.h"
#include "wx/dbkeyg.h"

const int   wxDB_ROWID_LEN       = 24;  // 18 is the max, 24 is in case it gets larger
const int   wxDB_DEFAULT_CURSOR  = 0;
const bool  wxDB_QUERY_ONLY      = TRUE;
const bool  wxDB_DISABLE_VIEW    = TRUE;

// Used to indicate end of a variable length list of
// column numbers passed to member functions
const int   wxDB_NO_MORE_COLUMN_NUMBERS = -1;

// The following class is used to define a column of a table.
// The wxDbTable constructor will dynamically allocate as many of
// these as there are columns in the table.  The class derived
// from wxDbTable must initialize these column definitions in it's
// constructor.  These column definitions provide inf. to the
// wxDbTable class which allows it to create a table in the data
// source, exchange data between the data source and the C++
// object, and so on.
class WXDLLIMPEXP_ODBC wxDbColDef
{
public:
    wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];  // Column Name
    int     DbDataType;                         // Logical Data Type; e.g. DB_DATA_TYPE_INTEGER
    SWORD   SqlCtype;                           // C data type; e.g. SQL_C_LONG
    void   *PtrDataObj;                         // Address of the data object
    int     SzDataObj;                          // Size, in bytes, of the data object
    bool    KeyField;                           // TRUE if this column is part of the PRIMARY KEY to the table; Date fields should NOT be KeyFields.
    bool    Updateable;                         // Specifies whether this column is updateable
    bool    InsertAllowed;                      // Specifies whether this column should be included in an INSERT statement
    bool    DerivedCol;                         // Specifies whether this column is a derived value
    SDWORD  CbValue;                            // Internal use only!!!
    bool    Null;                               // NOT FULLY IMPLEMENTED - Allows NULL values in Inserts and Updates

    wxDbColDef();

    bool    Initialize();
};  // wxDbColDef


class WXDLLIMPEXP_ODBC wxDbColDataPtr
{
public:
    void    *PtrDataObj;
    int      SzDataObj;
    SWORD    SqlCtype;
};  // wxDbColDataPtr


// This structure is used when creating secondary indexes.
class WXDLLIMPEXP_ODBC wxDbIdxDef
{
public:
    wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];
    bool    Ascending;
};  // wxDbIdxDef


class WXDLLIMPEXP_ODBC wxDbTable
{
private:
    ULONG       tableID;  // Used for debugging.  This can help to match up mismatched constructors/destructors

    // Private member variables
    UDWORD      cursorType;
    bool        insertable;

    // Private member functions
    bool        initialize(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
                       const wxString &qryTblName, bool qryOnly, const wxString &tblPath);
    void        cleanup();

    void        setCbValueForColumn(int columnIndex);
    bool        bindParams(bool forUpdate);  // called by the other 'bind' functions
    bool        bindInsertParams(void);
    bool        bindUpdateParams(void);

    bool        bindCols(HSTMT cursor);
    bool        getRec(UWORD fetchType);
    bool        execDelete(const wxString &pSqlStmt);
    bool        execUpdate(const wxString &pSqlStmt);
    bool        query(int queryType, bool forUpdate, bool distinct, const wxString &pSqlStmt=wxEmptyString);

#if !wxODBC_BACKWARD_COMPATABILITY
// these were public
    // Where, Order By and From clauses
    wxString    where;               // Standard SQL where clause, minus the word WHERE
    wxString    orderBy;             // Standard SQL order by clause, minus the ORDER BY
    wxString    from;                // Allows for joins in a wxDbTable::Query().  Format: ",tbl,tbl..."

    // ODBC Handles
    HENV        henv;           // ODBC Environment handle
    HDBC        hdbc;           // ODBC DB Connection handle
    HSTMT       hstmt;          // ODBC Statement handle
    HSTMT      *hstmtDefault;   // Default cursor
    HSTMT       hstmtInsert;    // ODBC Statement handle used specifically for inserts
    HSTMT       hstmtDelete;    // ODBC Statement handle used specifically for deletes
    HSTMT       hstmtUpdate;    // ODBC Statement handle used specifically for updates
    HSTMT       hstmtInternal;  // ODBC Statement handle used internally only
    HSTMT      *hstmtCount;     // ODBC Statement handle used by Count() function (No binding of columns)

    // Flags
    bool        selectForUpdate;

    // Pointer to the database object this table belongs to
    wxDb       *pDb;

    // Table Inf.
    wxString    tablePath;                                 // needed for dBase tables
    wxString    tableName;                                 // Table name
    wxString    queryTableName;                            // Query Table Name
    UWORD       noCols;                                    // # of columns in the table
    bool        queryOnly;                                 // Query Only, no inserts, updates or deletes

    // Column Definitions
    wxDbColDef *colDefs;         // Array of wxDbColDef structures
#endif
public:
#if wxODBC_BACKWARD_COMPATABILITY
    // Where, Order By and From clauses
    char       *where;          // Standard SQL where clause, minus the word WHERE
    char       *orderBy;        // Standard SQL order by clause, minus the ORDER BY
    char       *from;           // Allows for joins in a wxDbTable::Query().  Format: ",tbl,tbl..."

    // ODBC Handles
    HENV        henv;           // ODBC Environment handle
    HDBC        hdbc;           // ODBC DB Connection handle
    HSTMT       hstmt;          // ODBC Statement handle
    HSTMT      *hstmtDefault;   // Default cursor
    HSTMT       hstmtInsert;    // ODBC Statement handle used specifically for inserts
    HSTMT       hstmtDelete;    // ODBC Statement handle used specifically for deletes
    HSTMT       hstmtUpdate;    // ODBC Statement handle used specifically for updates
    HSTMT       hstmtInternal;  // ODBC Statement handle used internally only
    HSTMT      *hstmtCount;     // ODBC Statement handle used by Count() function (No binding of columns)

    // Flags
    bool        selectForUpdate;

    // Pointer to the database object this table belongs to
    wxDb       *pDb;

    // Table Inf.
    char        tablePath[wxDB_PATH_MAX];                  // needed for dBase tables
    char        tableName[DB_MAX_TABLE_NAME_LEN+1];        // Table name
    char        queryTableName[DB_MAX_TABLE_NAME_LEN+1];   // Query Table Name
    UWORD       noCols;                                    // # of columns in the table
    bool        queryOnly;                                 // Query Only, no inserts, updates or deletes

    // Column Definitions
    wxDbColDef *colDefs;         // Array of wxDbColDef structures
#endif
    // Public member functions
    wxDbTable(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
              const wxString &qryTblName=wxEmptyString, bool qryOnly = !wxDB_QUERY_ONLY, 
              const wxString &tblPath=wxEmptyString);

    // DEPRECATED
    wxDbTable(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
              const wxChar *qryTblName=wxEmptyString, bool qryOnly = !wxDB_QUERY_ONLY, 
              const wxString &tblPath=wxEmptyString);

    virtual ~wxDbTable();

    bool            Open(bool checkPrivileges=FALSE, bool checkTableExists=TRUE);
    bool            CreateTable(bool attemptDrop=TRUE);
    bool            DropTable(void);
    bool            CreateIndex(const wxString &idxName, bool unique, UWORD noIdxCols, 
                                wxDbIdxDef *pIdxDefs, bool attemptDrop=TRUE);
    bool            DropIndex(const wxString &idxName);

    // Accessors

    // The member variables returned by these accessors are all
    // set when the wxDbTable instance is created and cannot be 
    // changed, hence there is no corresponding SetXxxx function
    wxDb           *GetDb()              { return pDb; }
    const wxString &GetTableName()       { return tableName; }
    const wxString &GetQueryTableName()  { return queryTableName; }
    const wxString &GetTablePath()       { return tablePath; }

    UWORD           GetNumberOfColumns() { return noCols; }  // number of "defined" columns for this wxDbTable instance

    const wxString &GetFromClause()      { return from; }
    const wxString &GetOrderByClause()   { return orderBy; }
    const wxString &GetWhereClause()     { return where; }

    bool            IsQueryOnly()        { return queryOnly; }
#if wxODBC_BACKWARD_COMPATABILITY
    void            SetFromClause(const char *From) { from = (char *)From; }
    void            SetOrderByClause(const char *OrderBy) { orderBy = (char *)OrderBy; }
    void            SetWhereClause(const char *Where) { where = (char *)Where; }
#else
    void            SetFromClause(const wxString &From) { from = From; }
    void            SetOrderByClause(const wxString &OrderBy) { orderBy = OrderBy; }
    bool            SetOrderByColNums(UWORD first, ...);
    void            SetWhereClause(const wxString &Where) { where = Where; }
    void            From(const wxString &From) { from = From; }
    void            OrderBy(const wxString &OrderBy) { orderBy = OrderBy; }
    void            Where(const wxString &Where) { where = Where; }
    const wxString &Where()   { return where; }
    const wxString &OrderBy() { return orderBy; }
    const wxString &From()    { return from; }
#endif
    int             Insert(void);
    bool            Update(void);
    bool            Update(const wxString &pSqlStmt);
    bool            UpdateWhere(const wxString &pWhereClause);
    bool            Delete(void);
    bool            DeleteWhere(const wxString &pWhereClause);
    bool            DeleteMatching(void);
    virtual bool    Query(bool forUpdate = FALSE, bool distinct = FALSE);
    bool            QueryBySqlStmt(const wxString &pSqlStmt);
    bool            QueryMatching(bool forUpdate = FALSE, bool distinct = FALSE);
    bool            QueryOnKeyFields(bool forUpdate = FALSE, bool distinct = FALSE);
    bool            Refresh(void);
    bool            GetNext(void)   { return(getRec(SQL_FETCH_NEXT));  }
    bool            operator++(int) { return(getRec(SQL_FETCH_NEXT));  }

    /***** These four functions only work with wxDb instances that are defined  *****
     ***** as not being FwdOnlyCursors                                          *****/
    bool            GetPrev(void);
    bool            operator--(int);
    bool            GetFirst(void);
    bool            GetLast(void);

    bool            IsCursorClosedOnCommit(void);
    UWORD           GetRowNum(void);

    void            BuildSelectStmt(wxString &pSqlStmt, int typeOfSelect, bool distinct);
    void            BuildSelectStmt(wxChar *pSqlStmt, int typeOfSelect, bool distinct);

    void            BuildDeleteStmt(wxString &pSqlStmt, int typeOfDel, const wxString &pWhereClause=wxEmptyString);
    void            BuildDeleteStmt(wxChar *pSqlStmt, int typeOfDel, const wxString &pWhereClause=wxEmptyString);

    void            BuildUpdateStmt(wxString &pSqlStmt, int typeOfUpd, const wxString &pWhereClause=wxEmptyString);
    void            BuildUpdateStmt(wxChar *pSqlStmt, int typeOfUpd, const wxString &pWhereClause=wxEmptyString);

    void            BuildWhereClause(wxString &pWhereClause, int typeOfWhere, const wxString &qualTableName=wxEmptyString, bool useLikeComparison=FALSE);
    void            BuildWhereClause(wxChar *pWhereClause, int typeOfWhere, const wxString &qualTableName=wxEmptyString, bool useLikeComparison=FALSE);

#if wxODBC_BACKWARD_COMPATABILITY
// The following member functions are deprecated.  You should use the BuildXxxxxStmt functions (above)
    void            GetSelectStmt(char *pSqlStmt, int typeOfSelect, bool distinct)
                           { BuildSelectStmt(pSqlStmt,typeOfSelect,distinct); }
    void            GetDeleteStmt(char *pSqlStmt, int typeOfDel, const char *pWhereClause = NULL)
                           { BuildDeleteStmt(pSqlStmt,typeOfDel,pWhereClause); }
    void            GetUpdateStmt(char *pSqlStmt, int typeOfUpd, const char *pWhereClause = NULL)
                           { BuildUpdateStmt(pSqlStmt,typeOfUpd,pWhereClause); }
    void            GetWhereClause(char *pWhereClause, int typeOfWhere, 
                                   const char *qualTableName = NULL, bool useLikeComparison=FALSE)
                           { BuildWhereClause(pWhereClause,typeOfWhere,qualTableName,useLikeComparison); }
#endif
    bool            CanSelectForUpdate(void);
    bool            CanUpdByROWID(void);
    void            ClearMemberVar(UWORD colNo, bool setToNull=FALSE);
    void            ClearMemberVars(bool setToNull=FALSE);
    bool            SetQueryTimeout(UDWORD nSeconds);

    wxDbColDef     *GetColDefs() { return colDefs; }
    void            SetColDefs(UWORD index, const wxString &fieldName, int dataType, 
                               void *pData, SWORD cType,
                               int size, bool keyField = FALSE, bool upd = TRUE,
                               bool insAllow = TRUE, bool derivedCol = FALSE);
    wxDbColDataPtr *SetColDefs(wxDbColInf *colInfs, UWORD numCols);

    bool            CloseCursor(HSTMT cursor);
    bool            DeleteCursor(HSTMT *hstmtDel);
    void            SetCursor(HSTMT *hstmtActivate = (void **) wxDB_DEFAULT_CURSOR);
    HSTMT           GetCursor(void) { return(hstmt); }
    HSTMT          *GetNewCursor(bool setCursor = FALSE, bool bindColumns = TRUE);
#if wxODBC_BACKWARD_COMPATABILITY
// The following member function is deprecated.  You should use the GetNewCursor
    HSTMT          *NewCursor(bool setCursor = FALSE, bool bindColumns = TRUE) {  return GetNewCursor(setCursor,bindColumns); }
#endif

    ULONG           Count(const wxString &args=_T("*"));
    int             DB_STATUS(void) { return(pDb->DB_STATUS); }

    bool            IsColNull(UWORD colNo) const;
    bool            SetColNull(UWORD colNo, bool set=TRUE);
    bool            SetColNull(const wxString &colName, bool set=TRUE);
#if wxODBC_BACKWARD_COMPATABILITY
// The following member functions are deprecated.  You should use the SetColNull()
    bool            SetNull(int colNo, bool set=TRUE) { return (SetNull(colNo,set)); }
    bool            SetNull(const char *colName, bool set=TRUE) { return (SetNull(colName,set)); }
#endif
#ifdef __WXDEBUG__
    ULONG           GetTableID() { return tableID; }
#endif

//TODO: Need to Document
    typedef     enum  { WX_ROW_MODE_QUERY , WX_ROW_MODE_INDIVIDUAL } rowmode_t;
    virtual     void         SetRowMode(const rowmode_t rowmode);
    virtual     wxVariant    GetCol(const int colNo) const ;
    virtual     void         SetCol(const int colNo, const wxVariant value);
    virtual     GenericKey   GetKey(void);
    virtual     void         SetKey(const GenericKey &key);

    private:
        HSTMT      *m_hstmtGridQuery;
        rowmode_t   m_rowmode;
        size_t      m_keysize;

//      typedef enum {unmodified=0, UpdatePending, InsertPending } recStatus;

//      recStatus  get_ModifiedStatus() { return m_recstatus; }
        
//      void modify() {
//          if (m_recstatus==unmodified)
//              m_recstatus=UpdatePending;
//      }
//  protected:
//      void insertify() {m_recstatus=InsertPending; }
//      void unmodify() {m_recstatus=unmodified; }
//      recStatus m_recstatus;
//TODO: Need to Document
};  // wxDbTable


// Change this to 0 to remove use of all deprecated functions
#if wxODBC_BACKWARD_COMPATABILITY
//#################################################################################
//############### DEPRECATED functions for backward compatability #################
//#################################################################################

// Backward compability.  These will eventually go away
typedef wxDbTable       wxTable;
typedef wxDbIdxDef      wxIdxDef;
typedef wxDbIdxDef      CidxDef;
typedef wxDbColDef      wxColDef;
typedef wxDbColDef      CcolDef;
typedef wxDbColDataPtr  wxColDataPtr;
typedef wxDbColDataPtr  CcolDataPtr;

const int   ROWID           = wxDB_ROWID_LEN;
const int   DEFAULT_CURSOR  = wxDB_DEFAULT_CURSOR;
const bool  QUERY_ONLY      = wxDB_QUERY_ONLY;
const bool  DISABLE_VIEW    = wxDB_DISABLE_VIEW;
#endif

#endif
Commit	Line	Data
108106cf	1	///////////////////////////////////////////////////////////////////////////////
a2115c88	2	// Name: dbtable.h
f6bcfd97	3	// Purpose: Declaration of the wxDbTable class.
108106cf	4	// Author: Doug Card
30a6d2d2	5	// Modified by: George Tasker
3ca6a5f0 BP	6	// Bart Jourquin
3ca6a5f0 BP	7	// Mark Johnson
108106cf JS	8	// Created: 9.96
	9	// RCS-ID: $Id$
	10	// Copyright: (c) 1996 Remstar International, Inc.
65571936	11	// Licence: wxWindows licence, plus:
4fdae997	12	// Notice: This class library and its intellectual design are free of charge for use,
108106cf JS	13	// modification, enhancement, debugging under the following conditions:
108106cf JS	14	// 1) These classes may only be used as part of the implementation of a
77ffb593 JS	15	// wxWidgets-based application
	16	// 2) All enhancements and bug fixes are to be submitted back to the wxWidgets
	17	// user groups free of all charges for use with the wxWidgets library.
108106cf JS	18	// 3) These classes may not be distributed as part of any other class library,
108106cf JS	19	// DLL, text (written or electronic), other than a complete distribution of
77ffb593	20	// the wxWidgets GUI development toolkit.
108106cf JS	21	///////////////////////////////////////////////////////////////////////////////
	22
	23	/*
	24	// SYNOPSIS START
	25	// SYNOPSIS STOP
	26	*/
	27
a2115c88 GT	28	#ifndef DBTABLE_DOT_H
a2115c88 GT	29	#define DBTABLE_DOT_H
108106cf	30
a2115c88 GT	31	#include "wx/version.h"
a2115c88 GT	32
12028905	33	#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
882fc8a9	34	#pragma interface "dbtable.h"
108106cf JS	35	#endif
108106cf JS	36
882fc8a9 GT	37	#include "wx/db.h"
	38
	39	#include "wx/variant.h"
	40	#include "wx/dbkeyg.h"
108106cf	41
f6bcfd97 BP	42	const int wxDB_ROWID_LEN = 24; // 18 is the max, 24 is in case it gets larger
f6bcfd97 BP	43	const int wxDB_DEFAULT_CURSOR = 0;
a144affe GT	44	const bool wxDB_QUERY_ONLY = TRUE;
a144affe GT	45	const bool wxDB_DISABLE_VIEW = TRUE;
108106cf	46
2b63ff5d GT	47	// Used to indicate end of a variable length list of
	48	// column numbers passed to member functions
	49	const int wxDB_NO_MORE_COLUMN_NUMBERS = -1;
	50
108106cf	51	// The following class is used to define a column of a table.
f6bcfd97	52	// The wxDbTable constructor will dynamically allocate as many of
108106cf	53	// these as there are columns in the table. The class derived
f6bcfd97	54	// from wxDbTable must initialize these column definitions in it's
108106cf	55	// constructor. These column definitions provide inf. to the
f6bcfd97	56	// wxDbTable class which allows it to create a table in the data
108106cf JS	57	// source, exchange data between the data source and the C++
108106cf JS	58	// object, and so on.
bb41dcbe	59	class WXDLLIMPEXP_ODBC wxDbColDef
108106cf JS	60	{
108106cf JS	61	public:
4fdae997	62	wxChar ColName[DB_MAX_COLUMN_NAME_LEN+1]; // Column Name
95ca6a20	63	int DbDataType; // Logical Data Type; e.g. DB_DATA_TYPE_INTEGER
02cf6fdd	64	SWORD SqlCtype; // C data type; e.g. SQL_C_LONG
95ca6a20 GT	65	void *PtrDataObj; // Address of the data object
95ca6a20 GT	66	int SzDataObj; // Size, in bytes, of the data object
a144affe	67	bool KeyField; // TRUE if this column is part of the PRIMARY KEY to the table; Date fields should NOT be KeyFields.
95ca6a20 GT	68	bool Updateable; // Specifies whether this column is updateable
	69	bool InsertAllowed; // Specifies whether this column should be included in an INSERT statement
	70	bool DerivedCol; // Specifies whether this column is a derived value
	71	SDWORD CbValue; // Internal use only!!!
	72	bool Null; // NOT FULLY IMPLEMENTED - Allows NULL values in Inserts and Updates
da99271d GT	73
	74	wxDbColDef();
	75
	76	bool Initialize();
f6bcfd97	77	}; // wxDbColDef
30a6d2d2	78
95ca6a20	79
bb41dcbe	80	class WXDLLIMPEXP_ODBC wxDbColDataPtr
30a6d2d2 GT	81	{
30a6d2d2 GT	82	public:
95ca6a20 GT	83	void *PtrDataObj;
95ca6a20 GT	84	int SzDataObj;
02cf6fdd	85	SWORD SqlCtype;
f6bcfd97	86	}; // wxDbColDataPtr
30a6d2d2 GT	87
30a6d2d2 GT	88
108106cf	89	// This structure is used when creating secondary indexes.
bb41dcbe	90	class WXDLLIMPEXP_ODBC wxDbIdxDef
108106cf JS	91	{
108106cf JS	92	public:
4fdae997 GT	93	wxChar ColName[DB_MAX_COLUMN_NAME_LEN+1];
4fdae997 GT	94	bool Ascending;
f6bcfd97	95	}; // wxDbIdxDef
108106cf	96
95ca6a20	97
bb41dcbe	98	class WXDLLIMPEXP_ODBC wxDbTable
108106cf JS	99	{
108106cf JS	100	private:
3ca6a5f0	101	ULONG tableID; // Used for debugging. This can help to match up mismatched constructors/destructors
108106cf	102
95ca6a20	103	// Private member variables
3ca6a5f0 BP	104	UDWORD cursorType;
3ca6a5f0 BP	105	bool insertable;
a2115c88	106
95ca6a20	107	// Private member functions
02cf6fdd	108	bool initialize(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
4fdae997 GT	109	const wxString &qryTblName, bool qryOnly, const wxString &tblPath);
	110	void cleanup();
	111
0907ea9c	112	void setCbValueForColumn(int columnIndex);
4fdae997	113	bool bindParams(bool forUpdate); // called by the other 'bind' functions
3ca6a5f0 BP	114	bool bindInsertParams(void);
3ca6a5f0 BP	115	bool bindUpdateParams(void);
4fdae997	116
3ca6a5f0 BP	117	bool bindCols(HSTMT cursor);
3ca6a5f0 BP	118	bool getRec(UWORD fetchType);
4fdae997 GT	119	bool execDelete(const wxString &pSqlStmt);
4fdae997 GT	120	bool execUpdate(const wxString &pSqlStmt);
da99271d	121	bool query(int queryType, bool forUpdate, bool distinct, const wxString &pSqlStmt=wxEmptyString);
108106cf	122
f6bcfd97 BP	123	#if !wxODBC_BACKWARD_COMPATABILITY
	124	// these were public
	125	// Where, Order By and From clauses
	126	wxString where; // Standard SQL where clause, minus the word WHERE
	127	wxString orderBy; // Standard SQL order by clause, minus the ORDER BY
	128	wxString from; // Allows for joins in a wxDbTable::Query(). Format: ",tbl,tbl..."
95ca6a20 GT	129
95ca6a20 GT	130	// ODBC Handles
f6bcfd97 BP	131	HENV henv; // ODBC Environment handle
	132	HDBC hdbc; // ODBC DB Connection handle
	133	HSTMT hstmt; // ODBC Statement handle
	134	HSTMT *hstmtDefault; // Default cursor
	135	HSTMT hstmtInsert; // ODBC Statement handle used specifically for inserts
	136	HSTMT hstmtDelete; // ODBC Statement handle used specifically for deletes
	137	HSTMT hstmtUpdate; // ODBC Statement handle used specifically for updates
	138	HSTMT hstmtInternal; // ODBC Statement handle used internally only
	139	HSTMT *hstmtCount; // ODBC Statement handle used by Count() function (No binding of columns)
95ca6a20	140
f6bcfd97 BP	141	// Flags
f6bcfd97 BP	142	bool selectForUpdate;
95ca6a20	143
f6bcfd97 BP	144	// Pointer to the database object this table belongs to
f6bcfd97 BP	145	wxDb *pDb;
95ca6a20	146
f6bcfd97	147	// Table Inf.
4fdae997 GT	148	wxString tablePath; // needed for dBase tables
	149	wxString tableName; // Table name
	150	wxString queryTableName; // Query Table Name
02cf6fdd	151	UWORD noCols; // # of columns in the table
f6bcfd97	152	bool queryOnly; // Query Only, no inserts, updates or deletes
95ca6a20	153
f6bcfd97 BP	154	// Column Definitions
	155	wxDbColDef *colDefs; // Array of wxDbColDef structures
	156	#endif
	157	public:
	158	#if wxODBC_BACKWARD_COMPATABILITY
95ca6a20	159	// Where, Order By and From clauses
f6bcfd97 BP	160	char *where; // Standard SQL where clause, minus the word WHERE
	161	char *orderBy; // Standard SQL order by clause, minus the ORDER BY
	162	char *from; // Allows for joins in a wxDbTable::Query(). Format: ",tbl,tbl..."
	163
	164	// ODBC Handles
	165	HENV henv; // ODBC Environment handle
	166	HDBC hdbc; // ODBC DB Connection handle
	167	HSTMT hstmt; // ODBC Statement handle
	168	HSTMT *hstmtDefault; // Default cursor
	169	HSTMT hstmtInsert; // ODBC Statement handle used specifically for inserts
	170	HSTMT hstmtDelete; // ODBC Statement handle used specifically for deletes
	171	HSTMT hstmtUpdate; // ODBC Statement handle used specifically for updates
	172	HSTMT hstmtInternal; // ODBC Statement handle used internally only
	173	HSTMT *hstmtCount; // ODBC Statement handle used by Count() function (No binding of columns)
95ca6a20 GT	174
95ca6a20 GT	175	// Flags
f6bcfd97	176	bool selectForUpdate;
95ca6a20	177
f6bcfd97 BP	178	// Pointer to the database object this table belongs to
	179	wxDb *pDb;
	180
	181	// Table Inf.
	182	char tablePath[wxDB_PATH_MAX]; // needed for dBase tables
	183	char tableName[DB_MAX_TABLE_NAME_LEN+1]; // Table name
	184	char queryTableName[DB_MAX_TABLE_NAME_LEN+1]; // Query Table Name
02cf6fdd	185	UWORD noCols; // # of columns in the table
f6bcfd97 BP	186	bool queryOnly; // Query Only, no inserts, updates or deletes
	187
	188	// Column Definitions
	189	wxDbColDef *colDefs; // Array of wxDbColDef structures
	190	#endif
95ca6a20	191	// Public member functions
02cf6fdd	192	wxDbTable(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
8a39593e JS	193	const wxString &qryTblName=wxEmptyString, bool qryOnly = !wxDB_QUERY_ONLY,
8a39593e JS	194	const wxString &tblPath=wxEmptyString);
4fdae997 GT	195
4fdae997 GT	196	// DEPRECATED
02cf6fdd	197	wxDbTable(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
8a39593e JS	198	const wxChar *qryTblName=wxEmptyString, bool qryOnly = !wxDB_QUERY_ONLY,
8a39593e JS	199	const wxString &tblPath=wxEmptyString);
4fdae997	200
f6bcfd97 BP	201	virtual ~wxDbTable();
f6bcfd97 BP	202
a144affe GT	203	bool Open(bool checkPrivileges=FALSE, bool checkTableExists=TRUE);
a144affe GT	204	bool CreateTable(bool attemptDrop=TRUE);
f6bcfd97	205	bool DropTable(void);
21e05269	206	bool CreateIndex(const wxString &idxName, bool unique, UWORD noIdxCols,
a144affe	207	wxDbIdxDef *pIdxDefs, bool attemptDrop=TRUE);
4fdae997	208	bool DropIndex(const wxString &idxName);
f6bcfd97	209
3ca6a5f0	210	// Accessors
f6bcfd97 BP	211
f6bcfd97 BP	212	// The member variables returned by these accessors are all
1454d4e6	213	// set when the wxDbTable instance is created and cannot be
f6bcfd97	214	// changed, hence there is no corresponding SetXxxx function
3ca6a5f0	215	wxDb *GetDb() { return pDb; }
4fdae997 GT	216	const wxString &GetTableName() { return tableName; }
	217	const wxString &GetQueryTableName() { return queryTableName; }
	218	const wxString &GetTablePath() { return tablePath; }
f6bcfd97	219
02cf6fdd	220	UWORD GetNumberOfColumns() { return noCols; } // number of "defined" columns for this wxDbTable instance
f6bcfd97	221
4fdae997 GT	222	const wxString &GetFromClause() { return from; }
	223	const wxString &GetOrderByClause() { return orderBy; }
	224	const wxString &GetWhereClause() { return where; }
f6bcfd97	225
3ca6a5f0	226	bool IsQueryOnly() { return queryOnly; }
f6bcfd97 BP	227	#if wxODBC_BACKWARD_COMPATABILITY
f6bcfd97 BP	228	void SetFromClause(const char From) { from = (char )From; }
3ca6a5f0 BP	229	void SetOrderByClause(const char OrderBy) { orderBy = (char )OrderBy; }
3ca6a5f0 BP	230	void SetWhereClause(const char Where) { where = (char )Where; }
f6bcfd97	231	#else
e7e5298c GT	232	void SetFromClause(const wxString &From) { from = From; }
e7e5298c GT	233	void SetOrderByClause(const wxString &OrderBy) { orderBy = OrderBy; }
e938ff5e	234	bool SetOrderByColNums(UWORD first, ...);
e7e5298c GT	235	void SetWhereClause(const wxString &Where) { where = Where; }
	236	void From(const wxString &From) { from = From; }
	237	void OrderBy(const wxString &OrderBy) { orderBy = OrderBy; }
	238	void Where(const wxString &Where) { where = Where; }
4fdae997 GT	239	const wxString &Where() { return where; }
	240	const wxString &OrderBy() { return orderBy; }
	241	const wxString &From() { return from; }
f6bcfd97 BP	242	#endif
	243	int Insert(void);
	244	bool Update(void);
4fdae997 GT	245	bool Update(const wxString &pSqlStmt);
4fdae997 GT	246	bool UpdateWhere(const wxString &pWhereClause);
f6bcfd97	247	bool Delete(void);
4fdae997	248	bool DeleteWhere(const wxString &pWhereClause);
f6bcfd97	249	bool DeleteMatching(void);
a144affe	250	virtual bool Query(bool forUpdate = FALSE, bool distinct = FALSE);
4fdae997	251	bool QueryBySqlStmt(const wxString &pSqlStmt);
a144affe GT	252	bool QueryMatching(bool forUpdate = FALSE, bool distinct = FALSE);
a144affe GT	253	bool QueryOnKeyFields(bool forUpdate = FALSE, bool distinct = FALSE);
f6bcfd97 BP	254	bool Refresh(void);
	255	bool GetNext(void) { return(getRec(SQL_FETCH_NEXT)); }
	256	bool operator++(int) { return(getRec(SQL_FETCH_NEXT)); }
	257
	258	/*** These four functions only work with wxDb instances that are defined ***
95ca6a20	259	*** as not being FwdOnlyCursors ***/
f6bcfd97 BP	260	bool GetPrev(void);
	261	bool operator--(int);
	262	bool GetFirst(void);
	263	bool GetLast(void);
	264
	265	bool IsCursorClosedOnCommit(void);
	266	UWORD GetRowNum(void);
	267
4fdae997 GT	268	void BuildSelectStmt(wxString &pSqlStmt, int typeOfSelect, bool distinct);
	269	void BuildSelectStmt(wxChar *pSqlStmt, int typeOfSelect, bool distinct);
	270
8a39593e JS	271	void BuildDeleteStmt(wxString &pSqlStmt, int typeOfDel, const wxString &pWhereClause=wxEmptyString);
8a39593e JS	272	void BuildDeleteStmt(wxChar *pSqlStmt, int typeOfDel, const wxString &pWhereClause=wxEmptyString);
4fdae997	273
8a39593e JS	274	void BuildUpdateStmt(wxString &pSqlStmt, int typeOfUpd, const wxString &pWhereClause=wxEmptyString);
8a39593e JS	275	void BuildUpdateStmt(wxChar *pSqlStmt, int typeOfUpd, const wxString &pWhereClause=wxEmptyString);
4fdae997	276
8a39593e JS	277	void BuildWhereClause(wxString &pWhereClause, int typeOfWhere, const wxString &qualTableName=wxEmptyString, bool useLikeComparison=FALSE);
8a39593e JS	278	void BuildWhereClause(wxChar *pWhereClause, int typeOfWhere, const wxString &qualTableName=wxEmptyString, bool useLikeComparison=FALSE);
4fdae997	279
f6bcfd97 BP	280	#if wxODBC_BACKWARD_COMPATABILITY
	281	// The following member functions are deprecated. You should use the BuildXxxxxStmt functions (above)
	282	void GetSelectStmt(char *pSqlStmt, int typeOfSelect, bool distinct)
	283	{ BuildSelectStmt(pSqlStmt,typeOfSelect,distinct); }
2b63ff5d	284	void GetDeleteStmt(char pSqlStmt, int typeOfDel, const char pWhereClause = NULL)
f6bcfd97	285	{ BuildDeleteStmt(pSqlStmt,typeOfDel,pWhereClause); }
2b63ff5d	286	void GetUpdateStmt(char pSqlStmt, int typeOfUpd, const char pWhereClause = NULL)
f6bcfd97 BP	287	{ BuildUpdateStmt(pSqlStmt,typeOfUpd,pWhereClause); }
f6bcfd97 BP	288	void GetWhereClause(char *pWhereClause, int typeOfWhere,
a144affe	289	const char *qualTableName = NULL, bool useLikeComparison=FALSE)
f6bcfd97 BP	290	{ BuildWhereClause(pWhereClause,typeOfWhere,qualTableName,useLikeComparison); }
	291	#endif
	292	bool CanSelectForUpdate(void);
	293	bool CanUpdByROWID(void);
a144affe GT	294	void ClearMemberVar(UWORD colNo, bool setToNull=FALSE);
a144affe GT	295	void ClearMemberVars(bool setToNull=FALSE);
f6bcfd97 BP	296	bool SetQueryTimeout(UDWORD nSeconds);
	297
	298	wxDbColDef *GetColDefs() { return colDefs; }
21e05269	299	void SetColDefs(UWORD index, const wxString &fieldName, int dataType,
02cf6fdd	300	void *pData, SWORD cType,
a144affe GT	301	int size, bool keyField = FALSE, bool upd = TRUE,
a144affe GT	302	bool insAllow = TRUE, bool derivedCol = FALSE);
21e05269	303	wxDbColDataPtr SetColDefs(wxDbColInf colInfs, UWORD numCols);
f6bcfd97 BP	304
	305	bool CloseCursor(HSTMT cursor);
	306	bool DeleteCursor(HSTMT *hstmtDel);
	307	void SetCursor(HSTMT hstmtActivate = (void *) wxDB_DEFAULT_CURSOR);
	308	HSTMT GetCursor(void) { return(hstmt); }
a144affe	309	HSTMT *GetNewCursor(bool setCursor = FALSE, bool bindColumns = TRUE);
f6bcfd97 BP	310	#if wxODBC_BACKWARD_COMPATABILITY
f6bcfd97 BP	311	// The following member function is deprecated. You should use the GetNewCursor
a144affe	312	HSTMT *NewCursor(bool setCursor = FALSE, bool bindColumns = TRUE) { return GetNewCursor(setCursor,bindColumns); }
f6bcfd97 BP	313	#endif
f6bcfd97 BP	314
8a39593e	315	ULONG Count(const wxString &args=_T("*"));
f6bcfd97 BP	316	int DB_STATUS(void) { return(pDb->DB_STATUS); }
f6bcfd97 BP	317
882fc8a9	318	bool IsColNull(UWORD colNo) const;
a144affe GT	319	bool SetColNull(UWORD colNo, bool set=TRUE);
a144affe GT	320	bool SetColNull(const wxString &colName, bool set=TRUE);
f02d4a64 GT	321	#if wxODBC_BACKWARD_COMPATABILITY
f02d4a64 GT	322	// The following member functions are deprecated. You should use the SetColNull()
a144affe GT	323	bool SetNull(int colNo, bool set=TRUE) { return (SetNull(colNo,set)); }
a144affe GT	324	bool SetNull(const char *colName, bool set=TRUE) { return (SetNull(colName,set)); }
f02d4a64	325	#endif
154f22b3	326	#ifdef __WXDEBUG__
f6bcfd97	327	ULONG GetTableID() { return tableID; }
a2115c88	328	#endif
108106cf	329
882fc8a9 GT	330	//TODO: Need to Document
	331	typedef enum { WX_ROW_MODE_QUERY , WX_ROW_MODE_INDIVIDUAL } rowmode_t;
	332	virtual void SetRowMode(const rowmode_t rowmode);
1dee6b39 GT	333	virtual wxVariant GetCol(const int colNo) const ;
1dee6b39 GT	334	virtual void SetCol(const int colNo, const wxVariant value);
882fc8a9 GT	335	virtual GenericKey GetKey(void);
	336	virtual void SetKey(const GenericKey &key);
	337
	338	private:
	339	HSTMT *m_hstmtGridQuery;
	340	rowmode_t m_rowmode;
	341	size_t m_keysize;
	342
	343	// typedef enum {unmodified=0, UpdatePending, InsertPending } recStatus;
	344
	345	// recStatus get_ModifiedStatus() { return m_recstatus; }
	346
	347	// void modify() {
	348	// if (m_recstatus==unmodified)
	349	// m_recstatus=UpdatePending;
	350	// }
	351	// protected:
	352	// void insertify() {m_recstatus=InsertPending; }
	353	// void unmodify() {m_recstatus=unmodified; }
	354	// recStatus m_recstatus;
	355	//TODO: Need to Document
f6bcfd97	356	}; // wxDbTable
108106cf	357
4a8fc2c8 GT	358
4a8fc2c8 GT	359	// Change this to 0 to remove use of all deprecated functions
f6bcfd97	360	#if wxODBC_BACKWARD_COMPATABILITY
4a8fc2c8 GT	361	//#################################################################################
	362	//############### DEPRECATED functions for backward compatability #################
	363	//#################################################################################
	364
	365	// Backward compability. These will eventually go away
f6bcfd97 BP	366	typedef wxDbTable wxTable;
	367	typedef wxDbIdxDef wxIdxDef;
	368	typedef wxDbIdxDef CidxDef;
	369	typedef wxDbColDef wxColDef;
	370	typedef wxDbColDef CcolDef;
	371	typedef wxDbColDataPtr wxColDataPtr;
	372	typedef wxDbColDataPtr CcolDataPtr;
	373
	374	const int ROWID = wxDB_ROWID_LEN;
	375	const int DEFAULT_CURSOR = wxDB_DEFAULT_CURSOR;
	376	const bool QUERY_ONLY = wxDB_QUERY_ONLY;
	377	const bool DISABLE_VIEW = wxDB_DISABLE_VIEW;
4a8fc2c8 GT	378	#endif
4a8fc2c8 GT	379
108106cf	380	#endif