<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
<!--NewPage--> | |
<HTML> | |
<HEAD> | |
<!-- Generated by javadoc (build 1.6.0_11) on Wed Jul 20 09:13:34 CDT 2011 --> | |
<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<TITLE> | |
SchemaTool (OpenJPA Parent POM 2.1.1 API) | |
</TITLE> | |
<META NAME="date" CONTENT="2011-07-20"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
if (location.href.indexOf('is-external=true') == -1) { | |
parent.document.title="SchemaTool (OpenJPA Parent POM 2.1.1 API)"; | |
} | |
} | |
</SCRIPT> | |
<NOSCRIPT> | |
</NOSCRIPT> | |
</HEAD> | |
<BODY BGCOLOR="white" onload="windowTitle();"> | |
<HR> | |
<!-- ========= START OF TOP NAVBAR ======= --> | |
<A NAME="navbar_top"><!-- --></A> | |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_top_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SchemaTool.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaSerializer.html" title="interface in org.apache.openjpa.jdbc.schema"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.Flags.html" title="class in org.apache.openjpa.jdbc.schema"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/openjpa/jdbc/schema/SchemaTool.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="SchemaTool.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_top"></A> | |
<!-- ========= END OF TOP NAVBAR ========= --> | |
<HR> | |
<!-- ======== START OF CLASS DATA ======== --> | |
<H2> | |
<FONT SIZE="-1"> | |
org.apache.openjpa.jdbc.schema</FONT> | |
<BR> | |
Class SchemaTool</H2> | |
<PRE> | |
<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.openjpa.jdbc.schema.SchemaTool</B> | |
</PRE> | |
<HR> | |
<DL> | |
<DT><PRE>public class <B>SchemaTool</B><DT>extends <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> | |
</PRE> | |
<P> | |
The SchemaTool is used to manage the database schema. Note that the | |
tool never adds or drops unique constraints from existing tables, because | |
JDBC <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/DatabaseMetaData.html?is-external=true" title="class or interface in java.sql"><CODE>DatabaseMetaData</CODE></A> does not include information on these | |
constraints. | |
<P> | |
<P> | |
<DL> | |
<DT><B>Author:</B></DT> | |
<DD>Abe White, Patrick Linskey</DD> | |
</DL> | |
<HR> | |
<P> | |
<!-- ======== NESTED CLASS SUMMARY ======== --> | |
<A NAME="nested_class_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Nested Class Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static class</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.Flags.html" title="class in org.apache.openjpa.jdbc.schema">SchemaTool.Flags</A></B></CODE> | |
<BR> | |
Run flags.</TD> | |
</TR> | |
</TABLE> | |
<!-- =========== FIELD SUMMARY =========== --> | |
<A NAME="field_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Field Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_ADD">ACTION_ADD</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_BUILD">ACTION_BUILD</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_CREATEDB">ACTION_CREATEDB</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_DELETE_TABLE_CONTENTS">ACTION_DELETE_TABLE_CONTENTS</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_DROP">ACTION_DROP</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_DROPDB">ACTION_DROPDB</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_EXPORT">ACTION_EXPORT</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_IMPORT">ACTION_IMPORT</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_REFLECT">ACTION_REFLECT</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_REFRESH">ACTION_REFRESH</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_RETAIN">ACTION_RETAIN</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTIONS">ACTIONS</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
</TABLE> | |
| |
<!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
<A NAME="constructor_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Constructor Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#SchemaTool(org.apache.openjpa.jdbc.conf.JDBCConfiguration)">SchemaTool</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf)</CODE> | |
<BR> | |
Default constructor.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#SchemaTool(org.apache.openjpa.jdbc.conf.JDBCConfiguration, java.lang.String)">SchemaTool</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf, | |
<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> action)</CODE> | |
<BR> | |
Construct a tool to perform the given action.</TD> | |
</TR> | |
</TABLE> | |
| |
<!-- ========== METHOD SUMMARY =========== --> | |
<A NAME="method_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Method Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>(package private) void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#add()">add</A></B>()</CODE> | |
<BR> | |
Adds any components present in the schema repository but absent from | |
the database.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#addColumn(org.apache.openjpa.jdbc.schema.Column)">addColumn</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</CODE> | |
<BR> | |
Add the given column to the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#addForeignKey(org.apache.openjpa.jdbc.schema.ForeignKey)">addForeignKey</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> fk)</CODE> | |
<BR> | |
Add the given foreign key to the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#addPrimaryKey(org.apache.openjpa.jdbc.schema.PrimaryKey)">addPrimaryKey</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/PrimaryKey.html" title="class in org.apache.openjpa.jdbc.schema">PrimaryKey</A> pk)</CODE> | |
<BR> | |
Add the given primary key to the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>(package private) void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#build()">build</A></B>()</CODE> | |
<BR> | |
Re-execute all SQL used for the creation of the current database; | |
this action is usually used when creating SQL scripts.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#clear()">clear</A></B>()</CODE> | |
<BR> | |
Cleanup DataSource after run()/record()</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>(package private) void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#createDB()">createDB</A></B>()</CODE> | |
<BR> | |
Re-execute all SQL used for the creation of the current database; | |
this action is usually used when creating SQL scripts.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#createIndex(org.apache.openjpa.jdbc.schema.Index, org.apache.openjpa.jdbc.schema.Table)">createIndex</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema">Index</A> idx, | |
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</CODE> | |
<BR> | |
Add the given index to the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#createIndex(org.apache.openjpa.jdbc.schema.Index, org.apache.openjpa.jdbc.schema.Table, org.apache.openjpa.jdbc.schema.Unique[])">createIndex</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema">Index</A> idx, | |
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table, | |
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Unique.html" title="class in org.apache.openjpa.jdbc.schema">Unique</A>[] uniques)</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#createSequence(org.apache.openjpa.jdbc.schema.Sequence)">createSequence</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Sequence.html" title="class in org.apache.openjpa.jdbc.schema">Sequence</A> seq)</CODE> | |
<BR> | |
Add the given sequence to the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#createTable(org.apache.openjpa.jdbc.schema.Table)">createTable</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</CODE> | |
<BR> | |
Add the given table to the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>(package private) void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#drop()">drop</A></B>()</CODE> | |
<BR> | |
Drops all schema components in the schema repository that also exist | |
in the database.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#dropColumn(org.apache.openjpa.jdbc.schema.Column)">dropColumn</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</CODE> | |
<BR> | |
Drop the given column from the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>(package private) void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#dropDB()">dropDB</A></B>()</CODE> | |
<BR> | |
Drop the current database.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#dropForeignKey(org.apache.openjpa.jdbc.schema.ForeignKey)">dropForeignKey</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> fk)</CODE> | |
<BR> | |
Drop the given foreign key from the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#dropIndex(org.apache.openjpa.jdbc.schema.Index)">dropIndex</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema">Index</A> idx)</CODE> | |
<BR> | |
Drop the given index from the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#dropPrimaryKey(org.apache.openjpa.jdbc.schema.PrimaryKey)">dropPrimaryKey</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/PrimaryKey.html" title="class in org.apache.openjpa.jdbc.schema">PrimaryKey</A> pk)</CODE> | |
<BR> | |
Drop the given primary key from the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#dropSequence(org.apache.openjpa.jdbc.schema.Sequence)">dropSequence</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Sequence.html" title="class in org.apache.openjpa.jdbc.schema">Sequence</A> seq)</CODE> | |
<BR> | |
Drop the given sequence from the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#dropTable(org.apache.openjpa.jdbc.schema.Table)">dropTable</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</CODE> | |
<BR> | |
Drop the given table from the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#getAction()">getAction</A></B>()</CODE> | |
<BR> | |
The action supplied on construction.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#getDBSchemaGroup()">getDBSchemaGroup</A></B>()</CODE> | |
<BR> | |
Return the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#getDropSequences()">getDropSequences</A></B>()</CODE> | |
<BR> | |
If true, sequences that appear to be unused will be dropped.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#getDropTables()">getDropTables</A></B>()</CODE> | |
<BR> | |
If true, tables that appear to be unused will be dropped.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#getForeignKeys()">getForeignKeys</A></B>()</CODE> | |
<BR> | |
Whether foreign keys on existing tables should be manipulated.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#getIgnoreErrors()">getIgnoreErrors</A></B>()</CODE> | |
<BR> | |
If true, SQLExceptions thrown during schema manipulation will be | |
printed but ignored.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#getIndexes()">getIndexes</A></B>()</CODE> | |
<BR> | |
Whether indexes on existing tables should be manipulated.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#getOpenJPATables()">getOpenJPATables</A></B>()</CODE> | |
<BR> | |
Whether to act on special tables used by OpenJPA components | |
for bookkeeping.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#getPrimaryKeys()">getPrimaryKeys</A></B>()</CODE> | |
<BR> | |
Whether primary keys on existing tables should be manipulated.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#getSchemaGroup()">getSchemaGroup</A></B>()</CODE> | |
<BR> | |
Return the schema group the tool will act on.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#getSequences()">getSequences</A></B>()</CODE> | |
<BR> | |
Whether sequences should be manipulated.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/6/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#getWriter()">getWriter</A></B>()</CODE> | |
<BR> | |
The stream to write to for the creation of SQL scripts.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#main(java.lang.String[])">main</A></B>(<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args)</CODE> | |
<BR> | |
Usage: java org.apache.openjpa.jdbc.schema.SchemaTool [option]* | |
[-action/-a <add | retain | drop | refresh | createDB | dropDB | |
| build | reflect | import | export>] | |
<.schema file or resource>* | |
Where the following options are recognized.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#record()">record</A></B>()</CODE> | |
<BR> | |
Record the changes made to the DB in the current <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaFactory.html" title="interface in org.apache.openjpa.jdbc.schema"><CODE>SchemaFactory</CODE></A>.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>(package private) void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#refresh()">refresh</A></B>()</CODE> | |
<BR> | |
Adds any components present in the schema repository but absent from | |
the database, and drops unused database components.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>(package private) void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#retain()">retain</A></B>()</CODE> | |
<BR> | |
Drops database components that are not mentioned in the schema | |
repository.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#run()">run</A></B>()</CODE> | |
<BR> | |
Run the tool action.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#run(org.apache.openjpa.jdbc.conf.JDBCConfiguration, java.lang.String[], org.apache.openjpa.lib.util.Options)">run</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf, | |
<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args, | |
<A HREF="../../../../../org/apache/openjpa/lib/util/Options.html" title="class in org.apache.openjpa.lib.util">Options</A> opts)</CODE> | |
<BR> | |
Run the tool.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#run(org.apache.openjpa.jdbc.conf.JDBCConfiguration, java.lang.String[], org.apache.openjpa.jdbc.schema.SchemaTool.Flags, java.lang.ClassLoader)">run</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf, | |
<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args, | |
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.Flags.html" title="class in org.apache.openjpa.jdbc.schema">SchemaTool.Flags</A> flags, | |
<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</A> loader)</CODE> | |
<BR> | |
Run the tool.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#setDBSchemaGroup(org.apache.openjpa.jdbc.schema.SchemaGroup)">setDBSchemaGroup</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A> db)</CODE> | |
<BR> | |
Set the database schema.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#setDropSequences(boolean)">setDropSequences</A></B>(boolean dropSeqs)</CODE> | |
<BR> | |
If true, sequences that appear to be unused will be dropped.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#setDropTables(boolean)">setDropTables</A></B>(boolean dropTables)</CODE> | |
<BR> | |
If true, tables that appear to be unused will be dropped.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#setForeignKeys(boolean)">setForeignKeys</A></B>(boolean fks)</CODE> | |
<BR> | |
Whether foreign keys on existing tables should be manipulated.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#setIgnoreErrors(boolean)">setIgnoreErrors</A></B>(boolean ignoreErrs)</CODE> | |
<BR> | |
If true, SQLExceptions thrown during schema manipulation will be | |
printed but ignored.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#setIndexes(boolean)">setIndexes</A></B>(boolean indexes)</CODE> | |
<BR> | |
Whether indexes on existing tables should be manipulated.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#setOpenJPATables(boolean)">setOpenJPATables</A></B>(boolean openjpaTables)</CODE> | |
<BR> | |
Whether to act on special tables used by OpenJPA components | |
for bookkeeping.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#setPrimaryKeys(boolean)">setPrimaryKeys</A></B>(boolean pks)</CODE> | |
<BR> | |
Whether primary keys on existing tables should be manipulated.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#setSchemaGroup(org.apache.openjpa.jdbc.schema.SchemaGroup)">setSchemaGroup</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A> group)</CODE> | |
<BR> | |
Set the schema group the tool will act on.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#setSequences(boolean)">setSequences</A></B>(boolean seqs)</CODE> | |
<BR> | |
Whether sequences should be manipulated.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#setWriter(java.io.Writer)">setWriter</A></B>(<A HREF="http://java.sun.com/j2se/6/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A> writer)</CODE> | |
<BR> | |
The stream to write to for the creation of SQL scripts.</TD> | |
</TR> | |
</TABLE> | |
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> | |
</TR> | |
</TABLE> | |
| |
<P> | |
<!-- ============ FIELD DETAIL =========== --> | |
<A NAME="field_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Field Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="ACTION_ADD"><!-- --></A><H3> | |
ACTION_ADD</H3> | |
<PRE> | |
public static final <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACTION_ADD</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.SchemaTool.ACTION_ADD">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="ACTION_DROP"><!-- --></A><H3> | |
ACTION_DROP</H3> | |
<PRE> | |
public static final <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACTION_DROP</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.SchemaTool.ACTION_DROP">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="ACTION_RETAIN"><!-- --></A><H3> | |
ACTION_RETAIN</H3> | |
<PRE> | |
public static final <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACTION_RETAIN</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.SchemaTool.ACTION_RETAIN">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="ACTION_REFRESH"><!-- --></A><H3> | |
ACTION_REFRESH</H3> | |
<PRE> | |
public static final <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACTION_REFRESH</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.SchemaTool.ACTION_REFRESH">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="ACTION_BUILD"><!-- --></A><H3> | |
ACTION_BUILD</H3> | |
<PRE> | |
public static final <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACTION_BUILD</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.SchemaTool.ACTION_BUILD">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="ACTION_REFLECT"><!-- --></A><H3> | |
ACTION_REFLECT</H3> | |
<PRE> | |
public static final <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACTION_REFLECT</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.SchemaTool.ACTION_REFLECT">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="ACTION_CREATEDB"><!-- --></A><H3> | |
ACTION_CREATEDB</H3> | |
<PRE> | |
public static final <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACTION_CREATEDB</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.SchemaTool.ACTION_CREATEDB">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="ACTION_DROPDB"><!-- --></A><H3> | |
ACTION_DROPDB</H3> | |
<PRE> | |
public static final <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACTION_DROPDB</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.SchemaTool.ACTION_DROPDB">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="ACTION_IMPORT"><!-- --></A><H3> | |
ACTION_IMPORT</H3> | |
<PRE> | |
public static final <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACTION_IMPORT</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.SchemaTool.ACTION_IMPORT">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="ACTION_EXPORT"><!-- --></A><H3> | |
ACTION_EXPORT</H3> | |
<PRE> | |
public static final <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACTION_EXPORT</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.SchemaTool.ACTION_EXPORT">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="ACTION_DELETE_TABLE_CONTENTS"><!-- --></A><H3> | |
ACTION_DELETE_TABLE_CONTENTS</H3> | |
<PRE> | |
public static final <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACTION_DELETE_TABLE_CONTENTS</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.SchemaTool.ACTION_DELETE_TABLE_CONTENTS">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="ACTIONS"><!-- --></A><H3> | |
ACTIONS</H3> | |
<PRE> | |
public static final <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <B>ACTIONS</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<!-- ========= CONSTRUCTOR DETAIL ======== --> | |
<A NAME="constructor_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Constructor Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="SchemaTool(org.apache.openjpa.jdbc.conf.JDBCConfiguration)"><!-- --></A><H3> | |
SchemaTool</H3> | |
<PRE> | |
public <B>SchemaTool</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf)</PRE> | |
<DL> | |
<DD>Default constructor. Tools constructed this way will not have an | |
action, so the <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#run()"><CODE>run()</CODE></A> method will be a no-op. | |
<P> | |
</DL> | |
<HR> | |
<A NAME="SchemaTool(org.apache.openjpa.jdbc.conf.JDBCConfiguration, java.lang.String)"><!-- --></A><H3> | |
SchemaTool</H3> | |
<PRE> | |
public <B>SchemaTool</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf, | |
<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> action)</PRE> | |
<DL> | |
<DD>Construct a tool to perform the given action. | |
<P> | |
</DL> | |
<!-- ============ METHOD DETAIL ========== --> | |
<A NAME="method_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Method Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="clear()"><!-- --></A><H3> | |
clear</H3> | |
<PRE> | |
public void <B>clear</B>()</PRE> | |
<DL> | |
<DD>Cleanup DataSource after run()/record() | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getAction()"><!-- --></A><H3> | |
getAction</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getAction</B>()</PRE> | |
<DL> | |
<DD>The action supplied on construction. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getIgnoreErrors()"><!-- --></A><H3> | |
getIgnoreErrors</H3> | |
<PRE> | |
public boolean <B>getIgnoreErrors</B>()</PRE> | |
<DL> | |
<DD>If true, SQLExceptions thrown during schema manipulation will be | |
printed but ignored. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setIgnoreErrors(boolean)"><!-- --></A><H3> | |
setIgnoreErrors</H3> | |
<PRE> | |
public void <B>setIgnoreErrors</B>(boolean ignoreErrs)</PRE> | |
<DL> | |
<DD>If true, SQLExceptions thrown during schema manipulation will be | |
printed but ignored. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getOpenJPATables()"><!-- --></A><H3> | |
getOpenJPATables</H3> | |
<PRE> | |
public boolean <B>getOpenJPATables</B>()</PRE> | |
<DL> | |
<DD>Whether to act on special tables used by OpenJPA components | |
for bookkeeping. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setOpenJPATables(boolean)"><!-- --></A><H3> | |
setOpenJPATables</H3> | |
<PRE> | |
public void <B>setOpenJPATables</B>(boolean openjpaTables)</PRE> | |
<DL> | |
<DD>Whether to act on special tables used by OpenJPA components | |
for bookkeeping. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getDropTables()"><!-- --></A><H3> | |
getDropTables</H3> | |
<PRE> | |
public boolean <B>getDropTables</B>()</PRE> | |
<DL> | |
<DD>If true, tables that appear to be unused will be dropped. Defaults to | |
true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setDropTables(boolean)"><!-- --></A><H3> | |
setDropTables</H3> | |
<PRE> | |
public void <B>setDropTables</B>(boolean dropTables)</PRE> | |
<DL> | |
<DD>If true, tables that appear to be unused will be dropped. Defaults to | |
true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getDropSequences()"><!-- --></A><H3> | |
getDropSequences</H3> | |
<PRE> | |
public boolean <B>getDropSequences</B>()</PRE> | |
<DL> | |
<DD>If true, sequences that appear to be unused will be dropped. Defaults | |
to true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setDropSequences(boolean)"><!-- --></A><H3> | |
setDropSequences</H3> | |
<PRE> | |
public void <B>setDropSequences</B>(boolean dropSeqs)</PRE> | |
<DL> | |
<DD>If true, sequences that appear to be unused will be dropped. Defaults | |
to true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getSequences()"><!-- --></A><H3> | |
getSequences</H3> | |
<PRE> | |
public boolean <B>getSequences</B>()</PRE> | |
<DL> | |
<DD>Whether sequences should be manipulated. Defaults to true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setSequences(boolean)"><!-- --></A><H3> | |
setSequences</H3> | |
<PRE> | |
public void <B>setSequences</B>(boolean seqs)</PRE> | |
<DL> | |
<DD>Whether sequences should be manipulated. Defaults to true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getIndexes()"><!-- --></A><H3> | |
getIndexes</H3> | |
<PRE> | |
public boolean <B>getIndexes</B>()</PRE> | |
<DL> | |
<DD>Whether indexes on existing tables should be manipulated. | |
Defaults to true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setIndexes(boolean)"><!-- --></A><H3> | |
setIndexes</H3> | |
<PRE> | |
public void <B>setIndexes</B>(boolean indexes)</PRE> | |
<DL> | |
<DD>Whether indexes on existing tables should be manipulated. | |
Defaults to true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getForeignKeys()"><!-- --></A><H3> | |
getForeignKeys</H3> | |
<PRE> | |
public boolean <B>getForeignKeys</B>()</PRE> | |
<DL> | |
<DD>Whether foreign keys on existing tables should be manipulated. | |
Defaults to true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setForeignKeys(boolean)"><!-- --></A><H3> | |
setForeignKeys</H3> | |
<PRE> | |
public void <B>setForeignKeys</B>(boolean fks)</PRE> | |
<DL> | |
<DD>Whether foreign keys on existing tables should be manipulated. | |
Defaults to true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getPrimaryKeys()"><!-- --></A><H3> | |
getPrimaryKeys</H3> | |
<PRE> | |
public boolean <B>getPrimaryKeys</B>()</PRE> | |
<DL> | |
<DD>Whether primary keys on existing tables should be manipulated. | |
Defaults to true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setPrimaryKeys(boolean)"><!-- --></A><H3> | |
setPrimaryKeys</H3> | |
<PRE> | |
public void <B>setPrimaryKeys</B>(boolean pks)</PRE> | |
<DL> | |
<DD>Whether primary keys on existing tables should be manipulated. | |
Defaults to true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getWriter()"><!-- --></A><H3> | |
getWriter</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/6/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A> <B>getWriter</B>()</PRE> | |
<DL> | |
<DD>The stream to write to for the creation of SQL scripts. If the | |
stream is non-null, all SQL will be written to this stream rather than | |
executed against the database. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setWriter(java.io.Writer)"><!-- --></A><H3> | |
setWriter</H3> | |
<PRE> | |
public void <B>setWriter</B>(<A HREF="http://java.sun.com/j2se/6/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A> writer)</PRE> | |
<DL> | |
<DD>The stream to write to for the creation of SQL scripts. If the | |
stream is non-null, all SQL will be written to this stream rather than | |
executed against the database. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getSchemaGroup()"><!-- --></A><H3> | |
getSchemaGroup</H3> | |
<PRE> | |
public <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A> <B>getSchemaGroup</B>()</PRE> | |
<DL> | |
<DD>Return the schema group the tool will act on. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setSchemaGroup(org.apache.openjpa.jdbc.schema.SchemaGroup)"><!-- --></A><H3> | |
setSchemaGroup</H3> | |
<PRE> | |
public void <B>setSchemaGroup</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A> group)</PRE> | |
<DL> | |
<DD>Set the schema group the tool will act on. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="run()"><!-- --></A><H3> | |
run</H3> | |
<PRE> | |
public void <B>run</B>() | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Run the tool action. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="add()"><!-- --></A><H3> | |
add</H3> | |
<PRE> | |
void <B>add</B>() | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Adds any components present in the schema repository but absent from | |
the database. Package-private for testing. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="drop()"><!-- --></A><H3> | |
drop</H3> | |
<PRE> | |
void <B>drop</B>() | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Drops all schema components in the schema repository that also exist | |
in the database. Package-private for testing. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="retain()"><!-- --></A><H3> | |
retain</H3> | |
<PRE> | |
void <B>retain</B>() | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Drops database components that are not mentioned in the schema | |
repository. Package-private for testing. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="refresh()"><!-- --></A><H3> | |
refresh</H3> | |
<PRE> | |
void <B>refresh</B>() | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Adds any components present in the schema repository but absent from | |
the database, and drops unused database components. | |
Package-private for testing. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="createDB()"><!-- --></A><H3> | |
createDB</H3> | |
<PRE> | |
void <B>createDB</B>() | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Re-execute all SQL used for the creation of the current database; | |
this action is usually used when creating SQL scripts. | |
Package-private for testing. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="build()"><!-- --></A><H3> | |
build</H3> | |
<PRE> | |
void <B>build</B>() | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Re-execute all SQL used for the creation of the current database; | |
this action is usually used when creating SQL scripts. | |
Package-private for testing. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="dropDB()"><!-- --></A><H3> | |
dropDB</H3> | |
<PRE> | |
void <B>dropDB</B>() | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Drop the current database. Package-private for testing. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="record()"><!-- --></A><H3> | |
record</H3> | |
<PRE> | |
public void <B>record</B>()</PRE> | |
<DL> | |
<DD>Record the changes made to the DB in the current <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaFactory.html" title="interface in org.apache.openjpa.jdbc.schema"><CODE>SchemaFactory</CODE></A>. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="createTable(org.apache.openjpa.jdbc.schema.Table)"><!-- --></A><H3> | |
createTable</H3> | |
<PRE> | |
public boolean <B>createTable</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Add the given table to the database schema. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the operation was successful, false otherwise | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="dropTable(org.apache.openjpa.jdbc.schema.Table)"><!-- --></A><H3> | |
dropTable</H3> | |
<PRE> | |
public boolean <B>dropTable</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Drop the given table from the database schema. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the operation was successful, false otherwise | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="createSequence(org.apache.openjpa.jdbc.schema.Sequence)"><!-- --></A><H3> | |
createSequence</H3> | |
<PRE> | |
public boolean <B>createSequence</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Sequence.html" title="class in org.apache.openjpa.jdbc.schema">Sequence</A> seq) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Add the given sequence to the database schema. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the operation was successful, false otherwise | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="dropSequence(org.apache.openjpa.jdbc.schema.Sequence)"><!-- --></A><H3> | |
dropSequence</H3> | |
<PRE> | |
public boolean <B>dropSequence</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Sequence.html" title="class in org.apache.openjpa.jdbc.schema">Sequence</A> seq) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Drop the given sequence from the database schema. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the operation was successful, false otherwise | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="createIndex(org.apache.openjpa.jdbc.schema.Index, org.apache.openjpa.jdbc.schema.Table)"><!-- --></A><H3> | |
createIndex</H3> | |
<PRE> | |
public boolean <B>createIndex</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema">Index</A> idx, | |
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Add the given index to the database schema. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the operation was successful, false otherwise | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="createIndex(org.apache.openjpa.jdbc.schema.Index, org.apache.openjpa.jdbc.schema.Table, org.apache.openjpa.jdbc.schema.Unique[])"><!-- --></A><H3> | |
createIndex</H3> | |
<PRE> | |
public boolean <B>createIndex</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema">Index</A> idx, | |
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table, | |
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Unique.html" title="class in org.apache.openjpa.jdbc.schema">Unique</A>[] uniques) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="dropIndex(org.apache.openjpa.jdbc.schema.Index)"><!-- --></A><H3> | |
dropIndex</H3> | |
<PRE> | |
public boolean <B>dropIndex</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema">Index</A> idx) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Drop the given index from the database schema. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the operation was successful, false otherwise | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="addColumn(org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> | |
addColumn</H3> | |
<PRE> | |
public boolean <B>addColumn</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Add the given column to the database schema. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the operation was successful, false otherwise | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="dropColumn(org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> | |
dropColumn</H3> | |
<PRE> | |
public boolean <B>dropColumn</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Drop the given column from the database schema. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the operation was successful, false otherwise | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="addPrimaryKey(org.apache.openjpa.jdbc.schema.PrimaryKey)"><!-- --></A><H3> | |
addPrimaryKey</H3> | |
<PRE> | |
public boolean <B>addPrimaryKey</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/PrimaryKey.html" title="class in org.apache.openjpa.jdbc.schema">PrimaryKey</A> pk) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Add the given primary key to the database schema. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the operation was successful, false otherwise | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="dropPrimaryKey(org.apache.openjpa.jdbc.schema.PrimaryKey)"><!-- --></A><H3> | |
dropPrimaryKey</H3> | |
<PRE> | |
public boolean <B>dropPrimaryKey</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/PrimaryKey.html" title="class in org.apache.openjpa.jdbc.schema">PrimaryKey</A> pk) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Drop the given primary key from the database schema. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the operation was successful, false otherwise | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="addForeignKey(org.apache.openjpa.jdbc.schema.ForeignKey)"><!-- --></A><H3> | |
addForeignKey</H3> | |
<PRE> | |
public boolean <B>addForeignKey</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> fk) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Add the given foreign key to the database schema. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the operation was successful, false otherwise | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="dropForeignKey(org.apache.openjpa.jdbc.schema.ForeignKey)"><!-- --></A><H3> | |
dropForeignKey</H3> | |
<PRE> | |
public boolean <B>dropForeignKey</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> fk) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Drop the given foreign key from the database schema. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the operation was successful, false otherwise | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getDBSchemaGroup()"><!-- --></A><H3> | |
getDBSchemaGroup</H3> | |
<PRE> | |
public <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A> <B>getDBSchemaGroup</B>()</PRE> | |
<DL> | |
<DD>Return the database schema. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setDBSchemaGroup(org.apache.openjpa.jdbc.schema.SchemaGroup)"><!-- --></A><H3> | |
setDBSchemaGroup</H3> | |
<PRE> | |
public void <B>setDBSchemaGroup</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A> db)</PRE> | |
<DL> | |
<DD>Set the database schema. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="main(java.lang.String[])"><!-- --></A><H3> | |
main</H3> | |
<PRE> | |
public static void <B>main</B>(<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A>, | |
<A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Usage: java org.apache.openjpa.jdbc.schema.SchemaTool [option]* | |
[-action/-a <add | retain | drop | refresh | createDB | dropDB | |
| build | reflect | import | export>] | |
<.schema file or resource>* | |
Where the following options are recognized. | |
<ul> | |
<li><i>-properties/-p <properties file or resource></i>: The | |
path or resource name of a OpenJPA properties file containing | |
information such as the license key and connection data as | |
outlined in <A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf"><CODE>JDBCConfiguration</CODE></A>. Optional.</li> | |
<li><i>-<property name> <property value></i>: All bean | |
properties of the OpenJPA <A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf"><CODE>JDBCConfiguration</CODE></A> can be set by | |
using their names and supplying a value. For example: | |
<code>-licenseKey adslfja83r3lkadf</code></li> | |
<li><i>-ignoreErrors/-i <true/t | false/f></i>: If false, an | |
exception will will be thrown if the tool encounters any database | |
exceptions; defaults to <code>false</code>.</li> | |
<li><i>-file/-f <stdout | output file or resource></i>: Use this | |
option to write a SQL script for the planned schema modifications, | |
rather than committing them to the database. This option also | |
applies to the <code>export</code> and <code>reflect</code> actions.</li> | |
<li><i>-openjpaTables/-kt <true/t | false/f></i>: Under the | |
<code>reflect</code> action, whether to reflect on tables with | |
the name <code>OPENJPA_*</code>. Under other actions, whether to | |
drop such tables. Defaults to <code>false</code>.</li> | |
<li><i>-dropTables/-dt <true/t | false/f></i>: Set this option to | |
true to drop tables that appear to be unused during | |
<code>retain</code> and <code>refresh</code> actions. Defaults to | |
<code>true</code>.</li> | |
<li><i>-dropSequences/-dsq <true/t | false/f></i>: Set this option | |
to true to drop sequences that appear to be unused during | |
<code>retain</code> and <code>refresh</code> actions. Defaults to | |
<code>true</code>.</li> | |
<li><i>-primaryKeys/-pk <true/t | false/f></i>: Whether primary | |
keys on existing tables are manipulated. Defaults to true.</li> | |
<li><i>-foreignKeys/-fk <true/t | false/f></i>: Whether foreign | |
keys on existing tables are manipulated. Defaults to true.</li> | |
<li><i>-indexes/-ix <true/t | false/f></i>: Whether indexes | |
on existing tables are manipulated. Defaults to true.</li> | |
<li><i>-sequences/-sq <true/t | false/f></i>: Whether to | |
manipulate sequences. Defaults to true.</li> | |
<li><i>-record/-r <true/t | false/f></i>: Set this option to | |
<code>false</code> to prevent writing the schema changes to the | |
current <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaFactory.html" title="interface in org.apache.openjpa.jdbc.schema"><CODE>SchemaFactory</CODE></A>.</li> | |
</ul> | |
Actions can be composed in a comma-separated list. The various actions | |
are as follows. | |
<ul> | |
<li><i>add</i>: Bring the schema up-to-date with the latest | |
changes to the schema XML data by adding tables, columns, | |
indexes, etc. This action never drops any data. This is the | |
default action.</li> | |
<li><i>retain</i>: Keep all schema components in the schema XML, but | |
drop the rest from the database. This action never adds any data.</li> | |
<li><i>drop</i>: Drop all the schema components in the schema XML.</li> | |
<li><i>refresh</i>: Equivalent to retain, then add.</li> | |
<li><i>createDB</i>: Execute SQL to re-create the current database. | |
This action is typically used in conjuction with the | |
<code>file</code> option.</li> | |
<li><i>build</i>: Execute SQL to build the schema defined in the XML. | |
Because it doesn't take the current database schema into account, | |
this action is typically used in conjuction with the | |
<code>file</code> option.</li> | |
<li><i>reflect</i>: Reflect on the current database schema. Write the | |
schema's XML representation to the file specified with the | |
<code>file</code> option, or to stdout if no file is given.</li> | |
<li><i>dropDB</i>: Execute SQL to drop the current database. This | |
action implies <code>dropTables</code>.</li> | |
<li><i>deleteTableContents</i>: Execute SQL to delete all rows from | |
all tables that OpenJPA knows about.</li> | |
<li><i>import</i>: Import the given XML schema definition into the | |
current <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaFactory.html" title="interface in org.apache.openjpa.jdbc.schema"><CODE>SchemaFactory</CODE></A>.</li> | |
<li><i>export</i>: Export the current <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaFactory.html" title="interface in org.apache.openjpa.jdbc.schema"><CODE>SchemaFactory</CODE></A>'s recorded | |
schema to an XML schema definition file.</li> | |
</ul> | |
Examples: | |
<ul> | |
<li>Write a script to stdout to re-create the current database | |
schema:<br /> | |
<code>java org.apache.openjpa.jdbc.schema.SchemaTool -f stdout | |
-a createDB</code></li> | |
<li>Drop the current database schema:<br /> | |
<code>java org.apache.openjpa.jdbc.schema.SchemaTool | |
-a dropDB</code></li> | |
<li>Refresh the schema and delete all records in all tables:<br /> | |
<code>java org.apache.openjpa.jdbc.schema.SchemaTool | |
-a refresh,deleteTableContents</code></li> | |
<li>Create a schema based on an XML schema definition file:<br /> | |
<code>java org.apache.openjpa.jdbc.schema.SchemaTool | |
myschema.xml</code></li> | |
</ul> | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="run(org.apache.openjpa.jdbc.conf.JDBCConfiguration, java.lang.String[], org.apache.openjpa.lib.util.Options)"><!-- --></A><H3> | |
run</H3> | |
<PRE> | |
public static boolean <B>run</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf, | |
<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args, | |
<A HREF="../../../../../org/apache/openjpa/lib/util/Options.html" title="class in org.apache.openjpa.lib.util">Options</A> opts) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A>, | |
<A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Run the tool. Returns false if any invalid options were given. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#main(java.lang.String[])"><CODE>main(java.lang.String[])</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="run(org.apache.openjpa.jdbc.conf.JDBCConfiguration, java.lang.String[], org.apache.openjpa.jdbc.schema.SchemaTool.Flags, java.lang.ClassLoader)"><!-- --></A><H3> | |
run</H3> | |
<PRE> | |
public static boolean <B>run</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf, | |
<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args, | |
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.Flags.html" title="class in org.apache.openjpa.jdbc.schema">SchemaTool.Flags</A> flags, | |
<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</A> loader) | |
throws <A HREF="http://java.sun.com/j2se/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A>, | |
<A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<DD>Run the tool. Return false if invalid options were given. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> | |
</DD> | |
</DL> | |
<!-- ========= END OF CLASS DATA ========= --> | |
<HR> | |
<!-- ======= START OF BOTTOM NAVBAR ====== --> | |
<A NAME="navbar_bottom"><!-- --></A> | |
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_bottom_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SchemaTool.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaSerializer.html" title="interface in org.apache.openjpa.jdbc.schema"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.Flags.html" title="class in org.apache.openjpa.jdbc.schema"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/openjpa/jdbc/schema/SchemaTool.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="SchemaTool.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_bottom"></A> | |
<!-- ======== END OF BOTTOM NAVBAR ======= --> | |
<HR> | |
Copyright © 2006-2011 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. | |
</BODY> | |
</HTML> |