| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_67) on Sat Sep 20 17:22:58 FET 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>DbAdapter (Cayenne Documentation 3.1 API)</title> |
| <meta name="date" content="2014-09-20"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DbAdapter (Cayenne Documentation 3.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DbAdapter.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/cayenne/dba/AutoAdapter.html" title="class in org.apache.cayenne.dba"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/dba/DbAdapterFactory.html" title="interface in org.apache.cayenne.dba"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/dba/DbAdapter.html" target="_top">Frames</a></li> |
| <li><a href="DbAdapter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.cayenne.dba</div> |
| <h2 title="Interface DbAdapter" class="title">Interface DbAdapter</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/cayenne/dba/AutoAdapter.html" title="class in org.apache.cayenne.dba">AutoAdapter</a>, <a href="../../../../org/apache/cayenne/dba/db2/DB2Adapter.html" title="class in org.apache.cayenne.dba.db2">DB2Adapter</a>, <a href="../../../../org/apache/cayenne/dba/derby/DerbyAdapter.html" title="class in org.apache.cayenne.dba.derby">DerbyAdapter</a>, <a href="../../../../org/apache/cayenne/dba/frontbase/FrontBaseAdapter.html" title="class in org.apache.cayenne.dba.frontbase">FrontBaseAdapter</a>, <a href="../../../../org/apache/cayenne/dba/h2/H2Adapter.html" title="class in org.apache.cayenne.dba.h2">H2Adapter</a>, <a href="../../../../org/apache/cayenne/dba/hsqldb/HSQLDBAdapter.html" title="class in org.apache.cayenne.dba.hsqldb">HSQLDBAdapter</a>, <a href="../../../../org/apache/cayenne/dba/hsqldb/HSQLDBNoSchemaAdapter.html" title="class in org.apache.cayenne.dba.hsqldb">HSQLDBNoSchemaAdapter</a>, <a href="../../../../org/apache/cayenne/dba/ingres/IngresAdapter.html" title="class in org.apache.cayenne.dba.ingres">IngresAdapter</a>, <a href="../../../../org/apache/cayenne/dba/JdbcAdapter.html" title="class in org.apache.cayenne.dba">JdbcAdapter</a>, <a href="../../../../org/apache/cayenne/dba/mysql/MySQLAdapter.html" title="class in org.apache.cayenne.dba.mysql">MySQLAdapter</a>, <a href="../../../../org/apache/cayenne/dba/openbase/OpenBaseAdapter.html" title="class in org.apache.cayenne.dba.openbase">OpenBaseAdapter</a>, <a href="../../../../org/apache/cayenne/dba/oracle/Oracle8Adapter.html" title="class in org.apache.cayenne.dba.oracle">Oracle8Adapter</a>, <a href="../../../../org/apache/cayenne/dba/oracle/OracleAdapter.html" title="class in org.apache.cayenne.dba.oracle">OracleAdapter</a>, <a href="../../../../org/apache/cayenne/dba/postgres/PostgresAdapter.html" title="class in org.apache.cayenne.dba.postgres">PostgresAdapter</a>, <a href="../../../../org/apache/cayenne/dba/sqlite/SQLiteAdapter.html" title="class in org.apache.cayenne.dba.sqlite">SQLiteAdapter</a>, <a href="../../../../org/apache/cayenne/dba/sqlserver/SQLServerAdapter.html" title="class in org.apache.cayenne.dba.sqlserver">SQLServerAdapter</a>, <a href="../../../../org/apache/cayenne/dba/sybase/SybaseAdapter.html" title="class in org.apache.cayenne.dba.sybase">SybaseAdapter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">DbAdapter</span></pre> |
| <div class="block">A Cayenne extension point that abstracts the differences between specifics of JDBC |
| interfaces to various databases. Cayenne already ships with a number of built-in |
| adapters for most common databases and users can provide their own custom adapters.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#bindParameter(java.sql.PreparedStatement,%20java.lang.Object,%20int,%20int,%20int)">bindParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/sql/PreparedStatement.html?is-external=true" title="class or interface in java.sql">PreparedStatement</a> statement, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| int pos, |
| int sqlType, |
| int scale)</code> |
| <div class="block">Binds an object value to PreparedStatement's numbered parameter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#buildAttribute(java.lang.String,%20java.lang.String,%20int,%20int,%20int,%20boolean)">buildAttribute</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName, |
| int type, |
| int size, |
| int scale, |
| boolean allowNulls)</code> |
| <div class="block">Creates and returns a DbAttribute based on supplied parameters (usually obtained |
| from database meta data).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#createFkConstraint(org.apache.cayenne.map.DbRelationship)">createFkConstraint</a></strong>(<a href="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a> rel)</code> |
| <div class="block">Returns a SQL string that can be used to create a foreign key constraint for the |
| relationship, or null if foreign keys are not supported.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#createTable(org.apache.cayenne.map.DbEntity)">createTable</a></strong>(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> entity)</code> |
| <div class="block">Returns a SQL string that can be used to create database table corresponding to |
| <code>entity</code> parameter.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#createTableAppendColumn(java.lang.StringBuffer,%20org.apache.cayenne.map.DbAttribute)">createTableAppendColumn</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> sqlBuffer, |
| <a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a> column)</code> |
| <div class="block">Append the column type part of a "create table" to the given <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang"><code>StringBuffer</code></a></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#createUniqueConstraint(org.apache.cayenne.map.DbEntity,%20java.util.Collection)">createUniqueConstraint</a></strong>(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> source, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>> columns)</code> |
| <div class="block">Returns a DDL string to create a unique constraint over a set of columns, or null |
| if the unique constraints are not supported.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#dropTableStatements(org.apache.cayenne.map.DbEntity)">dropTableStatements</a></strong>(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> table)</code> |
| <div class="block">Returns a collection of SQL statements needed to drop a database table.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#externalTypesForJdbcType(int)">externalTypesForJdbcType</a></strong>(int type)</code> |
| <div class="block">Returns an array of RDBMS types that can be used with JDBC <code>type</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#getAction(org.apache.cayenne.query.Query,%20org.apache.cayenne.access.DataNode)">getAction</a></strong>(<a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> query, |
| <a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a> node)</code> |
| <div class="block">Returns an instance of SQLAction that should handle the query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#getBatchTerminator()">getBatchTerminator</a></strong>()</code> |
| <div class="block">Returns a String used to terminate a batch in command-line tools.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/access/types/ExtendedTypeMap.html" title="class in org.apache.cayenne.access.types">ExtendedTypeMap</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#getExtendedTypes()">getExtendedTypes</a></strong>()</code> |
| <div class="block">Returns a map of ExtendedTypes that is used to translate values between Java and |
| JDBC layer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/dba/PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#getPkGenerator()">getPkGenerator</a></strong>()</code> |
| <div class="block">Returns primary key generator associated with this DbAdapter.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/access/trans/QualifierTranslator.html" title="class in org.apache.cayenne.access.trans">QualifierTranslator</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#getQualifierTranslator(org.apache.cayenne.access.trans.QueryAssembler)">getQualifierTranslator</a></strong>(<a href="../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</a> queryAssembler)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/dba/QuotingStrategy.html" title="interface in org.apache.cayenne.dba">QuotingStrategy</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#getQuotingStrategy(boolean)">getQuotingStrategy</a></strong>(boolean needQuotes)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/merge/MergerFactory.html" title="class in org.apache.cayenne.merge">MergerFactory</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#mergerFactory()">mergerFactory</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#supportsBatchUpdates()">supportsBatchUpdates</a></strong>()</code> |
| <div class="block">Returns <code>true</code> if the target database supports batch updates.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#supportsGeneratedKeys()">supportsGeneratedKeys</a></strong>()</code> |
| <div class="block">Returns true if a target database supports key autogeneration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#supportsUniqueConstraints()">supportsUniqueConstraints</a></strong>()</code> |
| <div class="block">Returns true if a target database supports UNIQUE constraints.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#tableTypeForTable()">tableTypeForTable</a></strong>()</code> |
| <div class="block">Returns the name of the table type (as returned by |
| <code>DatabaseMetaData.getTableTypes</code>) for a simple user table.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/dba/DbAdapter.html#tableTypeForView()">tableTypeForView</a></strong>()</code> |
| <div class="block">Returns the name of the table type (as returned by |
| <code>DatabaseMetaData.getTableTypes</code>) for a view table.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getBatchTerminator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBatchTerminator</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getBatchTerminator()</pre> |
| <div class="block">Returns a String used to terminate a batch in command-line tools. E.g. ";" on |
| Oracle or "go" on Sybase.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.0.4</dd></dl> |
| </li> |
| </ul> |
| <a name="getQualifierTranslator(org.apache.cayenne.access.trans.QueryAssembler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQualifierTranslator</h4> |
| <pre><a href="../../../../org/apache/cayenne/access/trans/QualifierTranslator.html" title="class in org.apache.cayenne.access.trans">QualifierTranslator</a> getQualifierTranslator(<a href="../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</a> queryAssembler)</pre> |
| </li> |
| </ul> |
| <a name="getAction(org.apache.cayenne.query.Query, org.apache.cayenne.access.DataNode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAction</h4> |
| <pre><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a> getAction(<a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> query, |
| <a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a> node)</pre> |
| <div class="block">Returns an instance of SQLAction that should handle the query.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="supportsUniqueConstraints()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportsUniqueConstraints</h4> |
| <pre>boolean supportsUniqueConstraints()</pre> |
| <div class="block">Returns true if a target database supports UNIQUE constraints.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="supportsGeneratedKeys()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportsGeneratedKeys</h4> |
| <pre>boolean supportsGeneratedKeys()</pre> |
| <div class="block">Returns true if a target database supports key autogeneration. This feature also |
| requires JDBC3-compliant driver.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="supportsBatchUpdates()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportsBatchUpdates</h4> |
| <pre>boolean supportsBatchUpdates()</pre> |
| <div class="block">Returns <code>true</code> if the target database supports batch updates.</div> |
| </li> |
| </ul> |
| <a name="dropTableStatements(org.apache.cayenne.map.DbEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropTableStatements</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> dropTableStatements(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> table)</pre> |
| <div class="block">Returns a collection of SQL statements needed to drop a database table.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="createTable(org.apache.cayenne.map.DbEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> createTable(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> entity)</pre> |
| <div class="block">Returns a SQL string that can be used to create database table corresponding to |
| <code>entity</code> parameter.</div> |
| </li> |
| </ul> |
| <a name="createUniqueConstraint(org.apache.cayenne.map.DbEntity, java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createUniqueConstraint</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> createUniqueConstraint(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> source, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>> columns)</pre> |
| <div class="block">Returns a DDL string to create a unique constraint over a set of columns, or null |
| if the unique constraints are not supported.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="createFkConstraint(org.apache.cayenne.map.DbRelationship)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFkConstraint</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> createFkConstraint(<a href="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a> rel)</pre> |
| <div class="block">Returns a SQL string that can be used to create a foreign key constraint for the |
| relationship, or null if foreign keys are not supported.</div> |
| </li> |
| </ul> |
| <a name="externalTypesForJdbcType(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>externalTypesForJdbcType</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] externalTypesForJdbcType(int type)</pre> |
| <div class="block">Returns an array of RDBMS types that can be used with JDBC <code>type</code>. Valid |
| JDBC types are defined in java.sql.Types.</div> |
| </li> |
| </ul> |
| <a name="getExtendedTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtendedTypes</h4> |
| <pre><a href="../../../../org/apache/cayenne/access/types/ExtendedTypeMap.html" title="class in org.apache.cayenne.access.types">ExtendedTypeMap</a> getExtendedTypes()</pre> |
| <div class="block">Returns a map of ExtendedTypes that is used to translate values between Java and |
| JDBC layer.</div> |
| </li> |
| </ul> |
| <a name="getPkGenerator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPkGenerator</h4> |
| <pre><a href="../../../../org/apache/cayenne/dba/PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a> getPkGenerator()</pre> |
| <div class="block">Returns primary key generator associated with this DbAdapter.</div> |
| </li> |
| </ul> |
| <a name="buildAttribute(java.lang.String, java.lang.String, int, int, int, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildAttribute</h4> |
| <pre><a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a> buildAttribute(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName, |
| int type, |
| int size, |
| int scale, |
| boolean allowNulls)</pre> |
| <div class="block">Creates and returns a DbAttribute based on supplied parameters (usually obtained |
| from database meta data).</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - database column name</dd><dd><code>typeName</code> - database specific type name, may be used as a hint to determine the |
| right JDBC type.</dd><dd><code>type</code> - JDBC column type</dd><dd><code>size</code> - database column size (ignored if less than zero)</dd><dd><code>scale</code> - database column scale, i.e. the number of decimal digits (ignored if |
| less than zero)</dd><dd><code>allowNulls</code> - database column nullable parameter</dd></dl> |
| </li> |
| </ul> |
| <a name="bindParameter(java.sql.PreparedStatement, java.lang.Object, int, int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bindParameter</h4> |
| <pre>void bindParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/sql/PreparedStatement.html?is-external=true" title="class or interface in java.sql">PreparedStatement</a> statement, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| int pos, |
| int sqlType, |
| int scale) |
| throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a>, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Binds an object value to PreparedStatement's numbered parameter.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd> |
| <dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="tableTypeForTable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tableTypeForTable</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tableTypeForTable()</pre> |
| <div class="block">Returns the name of the table type (as returned by |
| <code>DatabaseMetaData.getTableTypes</code>) for a simple user table.</div> |
| </li> |
| </ul> |
| <a name="tableTypeForView()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tableTypeForView</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tableTypeForView()</pre> |
| <div class="block">Returns the name of the table type (as returned by |
| <code>DatabaseMetaData.getTableTypes</code>) for a view table.</div> |
| </li> |
| </ul> |
| <a name="mergerFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mergerFactory</h4> |
| <pre><a href="../../../../org/apache/cayenne/merge/MergerFactory.html" title="class in org.apache.cayenne.merge">MergerFactory</a> mergerFactory()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="createTableAppendColumn(java.lang.StringBuffer, org.apache.cayenne.map.DbAttribute)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTableAppendColumn</h4> |
| <pre>void createTableAppendColumn(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> sqlBuffer, |
| <a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a> column)</pre> |
| <div class="block">Append the column type part of a "create table" to the given <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang"><code>StringBuffer</code></a></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sqlBuffer</code> - the <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang"><code>StringBuffer</code></a> to append the column type to</dd><dd><code>column</code> - the <a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map"><code>DbAttribute</code></a> defining the column to append type for</dd><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getQuotingStrategy(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getQuotingStrategy</h4> |
| <pre><a href="../../../../org/apache/cayenne/dba/QuotingStrategy.html" title="interface in org.apache.cayenne.dba">QuotingStrategy</a> getQuotingStrategy(boolean needQuotes)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DbAdapter.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/cayenne/dba/AutoAdapter.html" title="class in org.apache.cayenne.dba"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/dba/DbAdapterFactory.html" title="interface in org.apache.cayenne.dba"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/dba/DbAdapter.html" target="_top">Frames</a></li> |
| <li><a href="DbAdapter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2001–2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |