Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc'd database-object 

git-svn-id: https://svn.jboss.org/repos/hibernate/trunk/Hibernate3/doc@7877 1b8cb986-b30d-0410-93ca-fae66ebed9b2
This commit is contained in:
Steve Ebersole 2005-08-12 05:18:50 +00:00
parent 4127262de4
commit 337051f1a2
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
reference/en/modules/basic_mapping.xml
View File

@ -3268,5 +3268,51 @@ public class Customer implements Serializable {
</para>
</sect1>
<sect1 id="mapping-database-object">
<title>Auxiliary Database Objects</title>
<para>
Allows CREATE and DROP of arbitrary database objects, in conjunction with
Hibernate's schema evolution tools, to provide the ability to fully define
a user schema within the Hibernate mapping files. Although designed specifically
for creating and dropping things like triggers or stored procedures, really any
SQL command that can be run via a <literal>java.sql.Statement.execute()</literal>
method is valid here (ALTERs, INSERTS, etc). There are essentially two modes for
defining auxiliary database objects...
</para>
<para>
The first mode is to explicitly list the CREATE and DROP commands out in the mapping
file:
</para>
<programlisting><![CDATA[<hibernate-mapping>
...
<database-object>
<create>CREATE TRIGGER my_trigger ...</create>
<drop>DROP TRIGGER my_trigger</drop>
</database-object>
</hibernate-mapping>]]></programlisting>
<para>
The second mode is to supply a custom class which knows how to construct the
CREATE and DROP commands. This custom class must implement the
<literal>org.hibernate.mapping.AuxiliaryDatabaseObject</literal> interface.
</para>
<programlisting><![CDATA[<hibernate-mapping>
...
<database-object>
<definition class="MyTriggerDefinition"/>
</database-object>
</hibernate-mapping>]]></programlisting>
<para>
Additionally, these database objects can be optionally scoped such that they only
apply when certain dialects are used.
</para>
<programlisting><![CDATA[<hibernate-mapping>
...
<database-object>
<definition class="MyTriggerDefinition"/>
<dialect-scope name="org.hibernate.dialect.Oracle9Dialect"/>
<dialect-scope name="org.hibernate.dialect.OracleDialect"/>
</database-object>
</hibernate-mapping>]]></programlisting>
</sect1>
</chapter>