How This Book is Structured

This book is primarily a reference to the classes and functions in ooSQLite. ooSQLite provides an object-orientated interface and a classic Rexx interface to SQLite. The book is broken into two main sections. The first section describes the object-orientated interface and the second section describes the classic Rexx section. Preceding the object-orientated section are the two chapters, About This Book and Brief Overview. They contain a small amount of overall information. A detailed index follows the classic Rexx section.

The object-orientated section contains a reference for each class in ooSQLite. Each class reference contains a single section for every class, instance, and attribute method of the class. The first section in a class reference is a table listing every method with a brief description and a link to the detailed documentation for the method.

Each method section starts with a How to Read the Syntax Diagrams diagram as a synopsis of how to invoke the method. Text follows describing the method, listing each argument to the method, and the return from the method. Most method sections have a remarks component discussing the method in more detail. Most method sections also have a details component pointing to the SQLite documentation that is most relevant to the method. To fully understand the use of any single method, the reader should also consult the SQLite documentation relevant to that method. Finally, many, but not all, of the method sections end with a short code snippet as an example of using the method.

The classic Rexx section starts with a table that lists every function available for the classic Rexx programmer. This table is similar to the method table that begins each class reference. The table contains a brief description of the function and a link to the detailed documentation for the function. Each function is fully documented in a single section.

The reference for each single function is very similar to the reference to each single method. It starts with a syntax diagram, describes the function, lists the arguments and return. It usually has a remarks component. The details component points the way to the authoritative SQLite documentation. Some, but not all function references contain an example.

Each method and function reference is meant to be stand alone. All the details to use any method or function are included within the section for that method or function. Each method and function is listed in the index. The reader can look up any function or method in the index or the table of contents and go straight to the reference for the function or method.

Within the reference for a single class, each method appears in alphabetical order. Likewise the reference for each function appears in this reference manual in alphabetical order.