[fdo-commits] r743 - in branches/3.2.1/Providers/GenericRdbms/Docs/doc_src/group_and_page_definitions: MySQL ODBC

[svn_fdo at osgeo.org]

Author: gregboone
Date: 2007-02-13 19:39:05 -0500 (Tue, 13 Feb 2007)
New Revision: 743

Modified:
   branches/3.2.1/Providers/GenericRdbms/Docs/doc_src/group_and_page_definitions/MySQL/define_pages.h
   branches/3.2.1/Providers/GenericRdbms/Docs/doc_src/group_and_page_definitions/ODBC/define_pages.h
Log:
FDO4: Update API documentation generation process

Modified: branches/3.2.1/Providers/GenericRdbms/Docs/doc_src/group_and_page_definitions/MySQL/define_pages.h
===================================================================
--- branches/3.2.1/Providers/GenericRdbms/Docs/doc_src/group_and_page_definitions/MySQL/define_pages.h	2007-02-13 23:28:33 UTC (rev 742)
+++ branches/3.2.1/Providers/GenericRdbms/Docs/doc_src/group_and_page_definitions/MySQL/define_pages.h	2007-02-14 00:39:05 UTC (rev 743)
@@ -7,6 +7,60 @@
 that provides access to data in a particular data store. The FDO 
 Provider for MySQL provides FDO with access to a MySQL-based data store.
 </p>
+
+<p>MySQL 5.0.22 and later is supported. You can create, edit, and delete MySQL 
+data stores and schemas, or you can access existing databases in MySQL that 
+were created by other applications. The FDO Provider for MySQL supports native 
+MySQL geometry, indexing, two-dimensional geometry (compatible with the OGC 
+Simple Feature specificaton), and spatial query operations, but not 
+transactions. Auto-generated properties are auto-incremented. MySQL uses a 
+revision number for optimistic concurrency.
+</p>
+
+\note
+If you cannot connect to your MySQL data source and you receive the error 
+message, "Specified credentials are not valid or the provider is unable to 
+establish a connection," copy the libmySQL.dll file into the \FDO\bin folder 
+under the Autodesk product install folder to resolve the problem.
+
+<p>
+A MySQL schema can support the following:
+</p>
+<ul>
+  <li>Inheritance
+  <li>Multiple schemas
+  <li>Object properties
+  <li>Association properties
+  <li>Schema overrrides
+  <li>Auto ID generation
+  <li>Null value constraints
+  <li>Unique value constraints
+  <li>Composite unique value constraints
+  <li>Spatial contexts
+  <li>These geometry types: point, line string, polygon,multi-point, multi-line 
+  string, multi-polygon, curve string, curve polygon, multi-curve string, 
+  multi-curve polygon, linear ring, line string segment, circular arc segment, 
+  and ring.
+</ul>
+
+<p>When you create a MySQL schema, the following restrictions apply:
+</p>
+<ul>
+  <li>A feature class must define or inherit at least one identity property.
+  <li>You cannot specify default values for data properties.
+  <li>Inclusive value range constraints are not supported.
+  <li>Identity properties cannot be nullable.
+  <li>Read-only identity properties must be autogenerated.
+  <li>A feature class can have multiple geometric properties; main geometry is 
+  not mandatory, but this attribute of the feature class indicates which 
+  geometry property to use as the default for queries and rendering. HasMeasure 
+  and HasElevation are supported. 
+  <li>The maximum length of a string is 65,535 bytes.
+  <li>For decimal properties, precision must be between 1 and 65 inclusive and 
+  scale must be between 0 and 30 inclusive.
+</ul>
+
+
 <p>The FDO Provider for MySQL API provides custom commands that are
 specifically designed to work with the FDO API. For example, using 
 these commands, you can do the following:

Modified: branches/3.2.1/Providers/GenericRdbms/Docs/doc_src/group_and_page_definitions/ODBC/define_pages.h
===================================================================
--- branches/3.2.1/Providers/GenericRdbms/Docs/doc_src/group_and_page_definitions/ODBC/define_pages.h	2007-02-13 23:28:33 UTC (rev 742)
+++ branches/3.2.1/Providers/GenericRdbms/Docs/doc_src/group_and_page_definitions/ODBC/define_pages.h	2007-02-14 00:39:05 UTC (rev 743)
@@ -11,12 +11,13 @@
 feature objects that can run in a multi-platform
 environment, including Windows, Linux, and UNIX.
 </p>
+
 <p>The FDO Provider for ODBC has the following characteristics:
 </p>
 <ul>
-  <li> The FDO Provider for ODBC supports the definition of one or more feature classes in terms of
-    any relational database table that contains an X, Y, and
-    optionally, Z columns.</li>
+  <li> The FDO Provider for ODBC supports the definition of one or more 
+    feature classes in terms of any relational database table that 
+    contains an X, Y, and optionally, Z columns.</li>
   <li> Metadata--that maps the table name, and X, Y, and optionally, Z
     columns to a feature class--is maintained outside the
     database in a configuration file. This information, in
@@ -42,7 +43,39 @@
 Microsoft Excel (must have at least one named range; do not use DATABASE 
 or other reserved words as a range name) 
 
+<p>For more information about setting up an ODBC data store in AutoCAD Map 3D
+2008 and configuring Excel for database ranges, see the 'Managing Data' topic
+in the <i>AutoCAD Map 3D User's Guide</i> (acmap.chm).
+</p>
+
+<p>For ODBC, only a point geometry (X, Y, and optionally, Z columns define a 
+point) is supported. The default column names are X, Y, and Z, but when you pick 
+the columns to represent these, you override the defaults. In AutoCAD Map 3D 
+2008, this information is stored in the map file itself, so if you go through 
+the same process in another map, you will need to override the settings again 
+in the same way.
+</p>
+
+<p>There is no spatial indexing. Object locations are stored in separate 
+properties in the object definition.
 <p>
+
+<p>The existing schema is used, and you cannot add, change, or delete it, nor 
+can you add FDO metadata to the data store.
+</p>
+
+<p>When you set up a Data Source Name for your ODBC data store (by adding a DSN 
+in Windows), you will need to specify certain configuration options, depending 
+on the type of ODBC data store you use. The connection information (Login ID 
+and password) you enter here is used only for defining the DSN, and not at 
+connection time with the ODBC provider. 
+</p>
+
+\note
+For MySQL, make sure you have installed the MySQL driver from MyODBC 3.51. 
+You can find it at http://dev.mysql.com/downloads/connector/odbc/3.51.html.
+
+<p>
 For more information, see <i>The Essential FDO</i> (FET_TheEssentialFDO.pdf) 
 and the <i>FDO Developer's Guide</i> (FDG_FDODevGuide.pdf).
 </p>