1. Introduction

Welcome to the ODBC Programmer's Guide. DBMaker is a powerful and flexible SQL Database Management System (DBMS) that supports an interactive Structured Query Language (SQL), a Microsoft Open Database Connectivity (ODBC) compatible interface, and Embedded SQL for C (ESQL/C). The unique open architecture and native ODBC interface give you the freedom to build custom applications using a wide variety of programming tools, or query your database using existing ODBC-compliant applications.

DBMaker is easily scalable from personal single-user databases to distributed enterprise-wide databases. Regardless of the configuration you choose for your database, the safety of your critical data is ensured by the advanced security, integrity, and reliability features of DBMaker. Extensive cross-platform support permits you to leverage your existing hardware now, and allows you to expand and upgrade to more powerful hardware as your needs grow.

DBMaker provides excellent multimedia handling capabilities, allowing you to store, search, retrieve, and manipulate all types of multimedia data. Binary Large Objects (BLOBs) allow you to ensure the integrity of your multimedia data by taking full advantage of the advanced security and crash recovery mechanisms included in DBMaker. File Objects (FOs) allow you to manage your multimedia data while maintaining the capability to edit individual files in the source application.

1.1 Who Should Read This Book

This guide is intended for programmers who want to create front-end applications for DBMaker, but are confused about where to start or how to use ODBC functions in an application. Users should be familiar with the C programming language, and should have a C development tool available if they wish to compile and execute the example programs.

Information on C programming is beyond the scope of this book, and users should consult a C programming guide if they encounter any problems in this area. If you encounter any problems with compiling and running the example programs with your development tool, you should consult your development tool documentation or the development tool vendor.

1.2 Information in This Book

This guide provides an introduction to the DBMaker ODBC API and outlines how to construct a front-end application for a database using the DBMaker ODBC API. Since this book is only intended as an introduction to ODBC programming, not all ODBC concepts and practices may be covered fully. However, all concepts that are presented will be covered in enough depth to let you understand what is happening in the example programs, and why.

Each chapter introduces a group of related functions and their options, and explains any differences you may encounter between the DBMaker ODBC API and the Microsoft ODBC 3.0 specification. You will learn how to use each function, and how each function fits into a program as a whole.

Examples and illustrations are provided whenever possible to help you understand the information presented. Example programs are given using the C programming language, and this guide assumes the reader is already familiar with the basic concepts necessary for programming in C. Each example is complete program that can be compiled with any suitable C/C++ compiler.

Although this guide provides information on all DBMaker ODBC functions, it is not intended as a comprehensive reference to the Microsoft ODBC 3.0 API. When using this guide, you may find it helpful to have a reference work available that has detailed information on all functions and state transitions. The recommended reference is "ODBC 3.0 Programmer's Reference" by Microsoft Press.

1.3 Other Sources of Information

DBMaker provides many other user's guides and reference manuals in addition to this guide. For more detailed information on a particular subject, you should consult one of the books shown below:

For more information on the SQL language implemented by DBMaker, refer to the SQL Command and Function Reference.

For more information on designing, administering, and maintaining a DBMaker database, refer to the Database Administrator's Reference.

For more information on the ESQL/C language implemented by DBMaker, refer to the ESQL/C Programmer's Reference.

For more information on the tools and utilities provided with DBMaker, refer to the dmSQL User's Guide, the DBATool User's Guide, or the Server Manager User's Guide.

For more information on error and warning messages, refer to the Error and Message Reference.

The subjects listed above are those that programmers using the DBMaker 3.5 ODBC-compatible API may find most useful. Not all of the DBMaker manuals are listed simply because subjects covered by some manuals may be more relevant to end users or database administrators than people who will be programming with SQL via ODBC or ESQL. For information on subjects not listed above, refer to the complete set of manuals provided with DBMaker.

1.4 Document Conventions

This book uses a standard set of typographic conventions to make reading easier and clearer.

Italics

Italics indicate placeholders for information you must supply, such as user names and table names. The word in italics should not be typed, but should be replaced by the actual name you want to use. Italics also introduce new words, and are occasionally used for emphasis in text.

Boldface

Boldface indicates filenames, database names, table names, column names, and other similar terms.

Computer

Information that is displayed on the screen is presented in this type. This includes lines that the product displays in response to user input, as well as lines you are required to enter.

KEYWORDS

All keywords used by the SQL language appear in uppercase when used in text.

SMALL CAPS

Small capital letters indicate keys on the keyboard. A plus sign (+) between two key names indicates you should hold down the first key while pressing the second. A comma (,) between two key names indicates you should release the first key before pressing the second key.