You are viewing a plain text version of this content. The canonical link for it is here.
Posted to torque-dev@db.apache.org by tf...@apache.org on 2011/05/07 22:50:07 UTC
svn commit: r1100623 -
/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/runtime/reference/relevant-classes.xml
Author: tfischer
Date: Sat May 7 20:50:07 2011
New Revision: 1100623
URL: http://svn.apache.org/viewvc?rev=1100623&view=rev
Log:
mark sql and adapter packages as subject to change without notice.
Modified:
db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/runtime/reference/relevant-classes.xml
Modified: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/runtime/reference/relevant-classes.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/runtime/reference/relevant-classes.xml?rev=1100623&r1=1100622&r2=1100623&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/runtime/reference/relevant-classes.xml (original)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/runtime/reference/relevant-classes.xml Sat May 7 20:50:07 2011
@@ -51,11 +51,9 @@
regenerate with torque only the Base* class changes. This allows you
to change the schema, but still keep your existing code.
</p>
-
</section>
<section name="Data Objects">
-
<p>
A Data Object holds information about a single row of a specific table.
Data Objects can be generated automatically for you. It takes the form
@@ -84,11 +82,9 @@
the resultset. Secondly you can create Data Objects and call their save
methods to insert or update the related row into the database.
</p>
-
</section>
<section name="Criteria">
-
<p>
Criteria is an abstraction of the criteria of an sql query. We use
criteria objects to specify the criteria of a sql statement. The
@@ -107,11 +103,9 @@
DISTINCT. If Criteria is too limited for your purposes (which should not
happen often) you are still free to use raw sql queries.
</p>
-
</section>
<section name="Database Maps">
-
<p>
The Peers make use of a DatabaseMap class that holds internal data about
the relational schema. You will seldom, if ever, need to work with the
@@ -140,11 +134,9 @@
The Map for the database with the name key can be retrieved
by the method Torque.getDatabaseMap(key).
</p>
-
</section>
<section name="ID Broker">
-
<p>
The ID Broker is used to automatically create unique primary keys for
tables. It creates id's from a database table called id_table.
@@ -160,11 +152,9 @@
The ID Broker is used in the underlying Peer code. After you have
generated your object model classes you need not worry about it anymore.
</p>
-
</section>
<section name="Database adaptors">
-
<p>
Although all databases supported by Torque understand SQL, there are
differences in the behaviour of the databases which the Torque runtime
@@ -191,6 +181,7 @@
<a href="new-database-support.html">Support for new Databases</a>
docs on how to create a new adapter for your database.
</p>
+ </section>
<section name="DataSourceFactories">
<p>
@@ -214,7 +205,14 @@
</p>
</section>
-
+ <section name="Other classes">
+ <p>
+ The torque runtime library contains more classes than described above.
+ The classes in the packages org.apache.torque.sql
+ and org.apache.torque.adapter are not considered public API of torque,
+ i.e. you can use these classes but they cannot be expected to stay
+ compatible between releases.
+ </p>
</section>
<section name="Internal resources used by the Torque Runtime">
---------------------------------------------------------------------
To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
For additional commands, e-mail: torque-dev-help@db.apache.org