home *** CD-ROM | disk | FTP | other *** search
/ C Programming Starter Kit 2.0 / SamsPublishing-CProgrammingStarterKit-v2.0-Win31.iso / bde / sdkdoc.pak / READSDK.TXT < prev   
Encoding:
Text File  |  1997-07-24  |  15.5 KB  |  425 lines
  1.                 Welcome to the Borland Database Engine
  2.                 --------------------------------------
  3.  
  4. This README file contains installation instructions, information about
  5. how to contact Borland, and important last-minute information about the
  6. Borland Database Engine (BDE).
  7.  
  8. The Borland Database Engine gives developers the opportunity to develop
  9. applications with the same database engine that is used in Paradox for
  10. Windows, dBASE for Windows, Delphi and ReportSmith.
  11.  
  12.  
  13. Contents
  14. --------
  15. I.     Installation and Configuration
  16. II.    Borland Database Engine Directories
  17. III.   Overview of Components
  18. IV.    Programming with the BDE
  19. V.     Programming with the ODBC Socket
  20. VI.    Using DLL Swap
  21. VII.   Using the Database Desktop
  22. VIII.  Accessing SQL Servers using Native Drivers
  23. IX.    What's New for this Release
  24. X.     Getting Help & Reporting Bugs
  25. XI.    Product Information
  26.  
  27.  
  28. I.  Installation and Configuration
  29. -----------------------------------
  30. System requirements:
  31.  
  32.   - DOS 3.1 or higher
  33.   - Windows version 3.1
  34.   - 6 MB RAM required, 8 MB recommended
  35.   - 25 MB free disk space
  36.  
  37. - Follow these steps to install the Borland Database Engine from
  38.   CD-ROM:
  39.   1. Insert the CD-ROM in your CD-ROM drive.  (The following
  40.            instructions assume you are using drive E.  Substitute your
  41.            drive letter if necessary.)
  42.   2. Choose File|Run from the Program Manager.  The Run dialog box appears.
  43.   3. Enter E:SETUP in the Command Line text box.
  44.   4. Follow the instructions on the screen.
  45.  
  46. - Follow these steps to install the Borland Database Engine from
  47.   diskettes:
  48.   1. Insert Diskette 1 in a floppy drive.  (The following instructions
  49.            assume you are using drive A.  Substitute your drive letter
  50.            if necessary.)
  51.   2. Choose File|Run from the Program Manager.  The Run dialog box appears.
  52.   3. Enter A:SETUP in the Command Line text box.
  53.   4. Follow the instructions on the screen.
  54.  
  55.  
  56. II.  Borland Database Engine Directories
  57. -----------------------------------------
  58. If you accepted BDE and IDAPI as the installation directories, the
  59. directory structure for the Borland Database Engine is as follows:
  60.  
  61. IDAPI           (IDAPI .DLLs and the configuration file IDAPI.CFG)
  62.   |
  63.   +--- LANGDRV
  64.  
  65. BDE
  66.   |
  67.   +--- BIN
  68.   |
  69.   +--- DOC
  70.   |
  71.   +--- EXAMPLES
  72.   |    |
  73.   |    +--- C
  74.   |    |    |
  75.   |    |    +--- ADDRESS
  76.   |    |    |
  77.   |    |    +--- DBPING
  78.   |    |    |
  79.   |    |    +--- INVENTRY
  80.   |    |
  81.   |    +--- DELPHI
  82.   |    |    |
  83.   |    |    +--- FILTER
  84.   |    |    |
  85.   |    |    +--- TABLEENH
  86.   |    |         |
  87.   |    |         +--- VCL
  88.   |    |
  89.   |    +--- PASCAL
  90.   |    |    |
  91.   |    |    +--- EMPLOYEE
  92.   |    |
  93.   |    +--- PDOXWIN
  94.   |    |    |
  95.   |    |    +--- RESTRUCT
  96.   |    |    |
  97.   |    |    +--- SEEK
  98.   |    |
  99.   |    +--- QUERY
  100.   |    |
  101.   |    +--- SNIPIT
  102.   |    |
  103.   |    +--- TABLES
  104.   |
  105.   +--- INCLUDE
  106.   |
  107.   +--- LIB
  108.   |
  109.   +--- REDIST
  110.   |
  111.   +--- UNITS
  112.  
  113. DBD
  114.   |
  115.   +---DBDPRIV
  116.  
  117.  
  118. III.  Overview of Components
  119. -----------------------------
  120. Software components
  121.  
  122. The BDE consists of the BDE API and drivers for Paradox, dBASE, ODBC
  123. Socket, and Text files.  FILELIST.TXT lists the files that make up
  124. this release of the Borland Database Engine.  After the BDE is
  125. installed, you should see icons for SnipIt Code Viewer, Query Manager,
  126. DBPing, the BDE on-line help system, various sample applications,
  127. the READSDK, the BDE Configuration Utility, the Database Desktop, and
  128. the DLL Swapper.
  129.  
  130. Documentation Components
  131.  
  132. Documentation for the Borland Database Engine consists of the Borland
  133. Database Engine on-line help, and various text files.  The on-line
  134. help and the supporting text files can be found in the DOC directory.
  135.  
  136.  
  137.  
  138. IV.  Programming with the BDE
  139. -----------------------------
  140.  
  141. - All developers using C, or C++, should use the provided IDAPI.LIB
  142.   library when you link your application.  IDAPI.LIB is more than just
  143.   an import library.  It has hooks to locate and load various DLLs.
  144.  
  145.  
  146. - We recommend that you use DbiQInstantiateAnswer() to save answer
  147.   tables produced by query functions. This is more efficient than
  148.   reading and writing one record at a time.
  149.  
  150. - BDE searches for the configuration file in this order:
  151.   1. Uses the CFG specified in the DBIEnv structure
  152.   2. Checks for a defined CFG file in the WIN.INI file located in
  153.      your Windows directory.  The entry checked for is "[IDAPI]"
  154.      with an sub-entry of "CONFIGFILE01."
  155.   3. Checks for the CFG file in the startup directory.
  156.   4. If the CFG file cannot be found, BDE initializes with a
  157.      predefined set of configuration settings.  The default
  158.      settings include no locking of STANDARD database tables.
  159.  
  160. - BDE\INCLUDE directory needs to be specified before the
  161.   BORLANDC\INCLUDE directory when using BC 3.1.
  162.  
  163. - If you are using Microsoft C and NMAKE.EXE, make sure that you have
  164.   the INCLUDE and LIB environment variables set.
  165.  
  166. - For ANSI drivers do not specify "iLen" when calling DbiNativeToAnsi().
  167.   Simply translate the entire string.
  168.  
  169. - You must set the "iLen" part of your field descriptors when calling
  170.   DbiCreateInMemTable().
  171.  
  172. - The Pascal unit files distributed with the BDE SDK (DBIPROCS.PAS, 
  173.   DBITYPES.PAS, and DBIERRORS.PAS) are NOT intended to be replacements 
  174.   for similarly named Delphi units. They are to be used with BDE-based 
  175.   Borland Pascal programs. The SDK units will have a slightly different 
  176.   interface section than those compiled and provided with Delphi. If 
  177.   you replace the Delphi units, you will not be able to link with other 
  178.   units that are dependent on the Delphi supplied ones.
  179.  
  180. - If there is a new prototype that you wish to access from Delphi you 
  181.   need to either create a DBINEW unit or simply declare the prototypes
  182.   in the .PAS file of your choice.
  183.  
  184. - We strongly recommend that you use the debug layer during application
  185.   development and testing.  This is done by swapping the IDAPI01.DLL with
  186.   the DBG.DLL and activating the debug layer with a call to
  187.   DbiDebugLayerOptions().  Here are some other debug layer details.
  188.   1. The debug layer is "shared" among all BDE clients.
  189.   2. We strongly recommended that one BDE application be designated
  190.      to activate and deactivate the debug layer.
  191.   3. All applications that use BDE will output trace information
  192.      after the debug layer has been enabled.
  193.   4. See the reference material for DbiDebugLayerOptions() for more
  194.      details.
  195.  
  196. - Within the BDE Reference Help under "Data Structures"|"CANHdr" there is 
  197.   a "Operator identifying leaf operands" called canTUPLE. This is not a 
  198.   supported operator. In addition the "Arithmetic" and "Aggregate Type" 
  199.   operators listed are not supported.
  200.  
  201. - Within the BDE Reference Help under "Data Structures"|"Data Type 
  202.   Translations" the data type "Money" is converted to Number (20, 4) for 
  203.   dBASE tables not Float (20, 4).
  204.  
  205. - Older versions of the BDECFG.EXE (then called IDAPICFG.EXE) will
  206.   cause a General Protection Fault if the LDPATH statement in the
  207.   WIN.INI file points to a directory that contains new or current
  208.   versions of the BDE files. Use the BDECFG.EXE to avoid this problem.
  209.  
  210. - When using ODBC data sources with the auto odbc option set to true and
  211.   a driver name greater than 32 characters, IDAPI truncates the name to 
  212.   32 characters. These truncated drivers do not appear in the driver list 
  213.   within BDECFG.EXE. Therefore they cannot be deleted from the 
  214.   configuration file.  Every time that the auto odbc option is set to 
  215.   true these drivers are added repeatedly to the configuration file after 
  216.   every save - thus the configuration file keeps growing and there is no 
  217.   way to remove the excess drivers. To avoid this problem do not use 
  218.   driver names greater than 32 characters in length.
  219.  
  220.  
  221. V.  Programming with the ODBC Socket
  222. -------------------------------------
  223.  
  224. - This release of the Borland Database Engine comes with an ODBC Socket.
  225.   It has been certified with Microsoft's 2.0 ODBC Driver Manager. 
  226.   The files ODBC.DLL, ODBCINST.DLL and ODBCINST.HLP have been installed
  227.   into your WINDOWS SYSTEM directory.  Proper versioning procedures
  228.   occur during the install, therefore if you had newer ODBC Driver
  229.   Manager files already on your system, then they have not been
  230.   replaced.
  231.  
  232.   NOTE: The ODBC 2.0 driver manager does work with ODBC 1.x ODBC drivers.
  233.  
  234. - The driver description in the ODBC.INI must match the driver name
  235.   exactly as found in ODBCINST.INI in order for the BDE Configuration
  236.   Utility to add drivers to the BDE configuration file.
  237.  
  238. - For information on how to create an ODBC driver connection and alias,
  239.   search for "ODBC Driver Connection" in the BDE Configuration Utility
  240.   on-line help.
  241.  
  242. - When using passthrough SQL functions (DbiQExecDirect), case-sensitive
  243.   object names should be enclosed by the DBMS-identifier quote
  244.   character.
  245.  
  246. - ODBC does not support owner-qualified indexes.  When using
  247.   DbiOpenTable, do not specify an owner name with the index parameter.
  248.  
  249. - Physical data type identifiers are composed of a 16-bit number.  The
  250.   high-byte is the driver ID and the low-byte is the ODBC SQL type
  251.   identifier.  To determine the SQL type of a field, use the following
  252.   algorithm:
  253.  
  254.      SWORD     iSqlType;
  255.  
  256.      iSqlType = (SWORD)(signed char)(0x00FF & pFldDesc->iFldType)
  257.  
  258.   The cast to signed char is necessary to preserve the sign information.
  259.  
  260. - Physical types are stored in the SQL_C_ types documented in
  261.   Microsoft's Open Database Connectivity Software Development Kit,
  262.   Version 2.0 Appendix D.  The only exception is for SQL_VARBINARY
  263.   types.  The first byte specifies the number of bytes of information.
  264.  
  265. - Updateable ODBC queries are not supported with aliases that have the 
  266.   SQLPASSTHRU MODE parameter set to NOT SHARED. The SQLPASSTHRU MODE is 
  267.   a parameter that can be set by the BDE Configuration Utility for each 
  268.   ODBC alias.
  269.  
  270.  
  271.   Database-specific information
  272.   -----------------------------
  273. - You may encounter problems when copying Oracle tables containing
  274.   NUMERIC type columns to other Oracle tables.  This is a known problem
  275.   and is fixed in Intersolv ODBC 2.0 Oracle driver.
  276.  
  277. - When specifying NetWare SQL BLOB\MEMO fields, it is necessary to
  278.   specify an iUnits setting less than or equal to 32765.  The default of
  279.   32767 that is assumed by the driver is incorrect due to field header
  280.   information.
  281.  
  282. - When using DbiBatchMove with ebatMode set to batCOPY, BLOB fields that
  283.   require an iUnits specification default to the maximum allowable size
  284.   supported.  This can cause problems for NetWare SQL users because the
  285.   BLOB on the target table is set to 32K, exceeding the record buffer
  286.   limit.
  287.  
  288. - DB2/2 (Database Manager) does not support concatenation operators in
  289.   queries.
  290.  
  291. - Depending on the SQL server being used, scrolling through a set of 
  292.   records based on a non-unique index does not always show a consistent 
  293.   ordering of NULL index values (i.e. sometimes they will be at BOF and 
  294.   sometimes at EOF). This is the behavior of the server and not IDAPI.
  295.  
  296. - When using the Microsoft 1.0 ODBC Text driver within a BDE program 
  297.   opening a database results in the program's working directory being 
  298.   set to the directory where the Text file is located. This means that 
  299.   runtime functions (i.e. findfirst) are not using the Windows defined 
  300.   working directory but the directory containing the Text database. 
  301.  
  302.  
  303. VI.  Using DLL Swap
  304. --------------------
  305. It is possible for your DLLs to reach a state that the DLL Swapper will
  306. not be able to resolve.  If you have IDAPI01.DLL, DBG.DLL, and NODBG.DLL
  307. on your disk at the same time, an error message will be displayed.
  308.  
  309. To resolve the conflict, delete either DBG.DLL or NODBG.DLL.  You should
  310. delete the .DLL that is the same size as the IDAPI01.DLL file.
  311.  
  312.  
  313. VII.  Using the Database Desktop
  314. ---------------------------------
  315. The Database Desktop is a utility that allows you to create, modify,
  316. and restructure Paradox and dBASE tables.  It uses BDE for all of
  317. its database I/O and requires the BDE configuration file for access
  318. to SQL databases.  Refer to your Database Desktop on-line help for
  319. detailed product information.
  320.  
  321.  
  322. VIII.  Accessing SQL Servers using Native Drivers
  323. ------------------------------------------------
  324. This release of the Borland Database Engine has been certified with
  325. the Borland SQL Links 2.5 product.  Borland SQL Links 2.5 product
  326. offers high performance native drivers for InterBase, Oracle,
  327. Informix, and MS/SYBASE SQL Server.
  328.  
  329. With Borland SQL Links 2.5 you can build applications and scale them
  330. between local and remote data.  No other database engine provides this
  331. level of scalability!  Developers use one API to access all drivers
  332. supported by BDE.
  333.  
  334.  
  335. IX.  What's New for this Release
  336. -----------------------------------
  337.  
  338. Local Features
  339.  
  340. - You can now find the BDE documentation on-line (BDE.HLP & LOCALSQL.HLP)
  341.  
  342. - Local SQL has been enhanced. For more information see the Local SQL
  343.   on-line help file.
  344.  
  345. - Local SQL now supports parameterized queries. See Local SQL on-line
  346.   help under "Parameter Substitutions in DML Statements".
  347.  
  348. - There are two new functions (DbiAddAlias and DbiDeleteAlias) that 
  349.   allow aliases to be added and deleted from the configuration file.
  350.   For more information see the BDE on-line help file.
  351.  
  352. - There is now schema support for ASCII tables. See the SNIPIT example
  353.   (CR8TXTBL.C) for more details.
  354.  
  355. - Support for accessing encrypted dBASE tables is now included. See the 
  356.   SNIPIT example (DBLOGIN.C) for more details.
  357.  
  358. - When trying to open a dBASE table with an invalid index there is now
  359.   the capability to recieve a callback and determine whether or not to
  360.   continue opening the table. See the SNIPIT example (INPUTREQ.C) for
  361.   more details.
  362.  
  363.  
  364. New Applications
  365.  
  366. - The Database Desktop has been upgraded (version 5.1) to allow 
  367.   access to remote tables as well as local tables. For more information
  368.   use the Database Desktop on-line help file (DBD.HLP).
  369.  
  370. Changes to Provided Examples
  371.  
  372. The following SNIPIT examples have been added or changed:
  373.  
  374. - FILTCOMP.C: Comparison filter (New)
  375.  
  376. - FILTCONT.C: Continue filter (New)
  377.  
  378. - ADDALIAS.C: Adding and deleting aliases (New)
  379.  
  380. - KEYUPDT.C: Keyed updates (New)
  381.  
  382. - LSQLLIVE.C: Local and remote dynasets (Modified)
  383.  
  384. - SQLBIND.C: Local and remote parameter binding (Modified)
  385.  
  386. - UPDTCRNT.C: Cursor symantics (New)
  387.  
  388. - STORPROC.C: Using stored procedures (New)
  389.  
  390. - CR8TXTBL.C: Text table using a schema file (Modified)
  391.  
  392. - DBLOGIN.C: Accessing encrypted dBASE tables (New)
  393.  
  394. - TEXTEXP.C: Exporting test file using a schema file (Modified)
  395.  
  396. - INPUTREQ.C: Accessing tables with a missing or invalid index (New)
  397.  
  398. The following are examples of using the BDE in a DLL for use with 
  399. PDOXWIN in OPAL:
  400.  
  401. - SEEK: Search dBASE expression indexes.
  402.  
  403. - RESTRUCT: Restructure a table.
  404.  
  405. The following are examples of using the BDE with Delphi:
  406.  
  407. - FILTER: Using a filter with a TTable
  408.  
  409. - TABLEENH: Creating a new Table derived control with Block functionality.
  410.  
  411.  
  412. X.  Getting Help & Reporting Bugs
  413. -------------------------------------
  414. To get technical support from Borland and to report bugs, use CompuServe.
  415. Type GO BDEVTOOL from any '!' prompt and leave your message in section 4.
  416.  
  417. For information on phone support contact Borland at (800) 839-9777.
  418.  
  419.  
  420. XI.  Product Information
  421. ------------------------
  422. For information about any Borland products, contact Borland in the
  423. U.S. at (408) 431-1000.  International customers should contact the
  424. nearest Borland International office.
  425.