Getting Started with CitSQL Version 1.2 The CitSQL Family of Precompilers Getting Started Version 1.2 Page 1 Getting Started with CitSQL Version 1.2 ACKNOWLEDGMENT ........................................................................................................ 6 INTRODUCTION ................................................................................................................. 7 Overview ............................................................................................................................................................................ 7 The CitSQL Family of Products ..................................................................................................................................... 7 The CitSQL Precompiler ............................................................................................................................................... 10 The CitSQL Runtime Component ................................................................................................................................. 10 The SQL Engine Client Component ............................................................................................................................. 10 What differentiates CitSQL ........................................................................................................................................... 10 GETTING STARTED ......................................................................................................... 11 Installation ....................................................................................................................................................................... 11 Directory Structure ........................................................................................................................................................ 12 Required Third-Party Tools .......................................................................................................................................... 12 USING THE PRECOMPILER ............................................................................................ 12 License ............................................................................................................................................................................. 12 For CitSQL for MySQL .......................................................................................................................................... 14 >citmysql ................................................................................................................................................................. 14 For CitSQL fro PostgreSQL .................................................................................................................................... 14 >citpgsql .................................................................................................................................................................. 14 For CitSQL for ODBC ............................................................................................................................................ 14 >citodbc ................................................................................................................................................................... 14 Usage ................................................................................................................................................................................ 14 Options ............................................................................................................................................................................. 14 DebugMode ................................................................................................................................................................. 16 ExpandIncludes ............................................................................................................................................................ 16 FreeFormatOutput ........................................................................................................................................................ 16 IncludeSearchPath........................................................................................................................................................ 17 LibName ...................................................................................................................................................................... 17 LogMode ...................................................................................................................................................................... 18 MaxMem ...................................................................................................................................................................... 18 Quote Translation......................................................................................................................................................... 19 StandardPrefix ............................................................................................................................................................. 20 StrictMode ................................................................................................................................................................... 20 StrictPictureMode ........................................................................................................................................................ 20 TargetPattern ................................................................................................................................................................ 20 Page 2 Getting Started with CitSQL Version 1.2 TrimMode .................................................................................................................................................................... 21 TruncComments ........................................................................................................................................................... 21 Usage with a resource file ............................................................................................................................................... 22 Storing multiple options in a resource file ................................................................................................................... 22 Storing multiple programs in a resource file ................................................................................................................ 22 Using Wildcards........................................................................................................................................................... 23 RUNNING THE SAMPLE TEST PROGRAM .................................................................... 23 Precompile the Sample Test Programs ......................................................................................................................... 23 Compile the Sample Test Programs .............................................................................................................................. 24 Run the Sample Test Programs ..................................................................................................................................... 24 THE SQL COMMUNICATIONS AREA ( SQLCA ) ............................................................ 24 The SQLCA Data Structure .......................................................................................................................................... 25 SUPPORT FOR USAGE VARCHAR, VARRAW, VARYING ............................................ 25 ADDRESSING THE VARIOUS DATABASES .................................................................. 26 Connection ....................................................................................................................................................................... 26 Addressing MySQL ........................................................................................................................................................ 27 Preparing the sample program ..................................................................................................................................... 27 Preparing the conection to the database ....................................................................................................................... 28 Addressing PostgreSQL ................................................................................................................................................. 29 Preparing the sample program ..................................................................................................................................... 29 Preparing the conection to the database ....................................................................................................................... 29 Addressing Microsoft SQL Server (ODBC) ................................................................................................................. 30 Preparing the Sample Program .................................................................................................................................... 30 Preparing the connection to the database ....................................................................................................................