blob: 21c93d55cec2292bd3914c7be1dfd133367d1d2a [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.calcite.sql.ddl (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.calcite.sql.ddl (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.calcite.sql.ddl</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Parse tree for SQL DDL statements.
<p>These are available in the extended SQL parser that is part of Calcite's
"server" module; the core parser in the "core" module only supports SELECT
and DML.
<p>If you are writing a project that requires DDL it is likely that your
DDL syntax is different than ours. We recommend that you copy-paste this
the parser and its supporting classes into your own module, rather than try
to extend this one.</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlAttributeDefinition.html" title="class in org.apache.calcite.sql.ddl">SqlAttributeDefinition</a></th>
<td class="colLast">
<div class="block">Parse tree for SqlAttributeDefinition,
which is part of a <a href="SqlCreateType.html" title="class in org.apache.calcite.sql.ddl"><code>SqlCreateType</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlCheckConstraint.html" title="class in org.apache.calcite.sql.ddl">SqlCheckConstraint</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>UNIQUE</code>, <code>PRIMARY KEY</code> constraints.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlColumnDeclaration.html" title="class in org.apache.calcite.sql.ddl">SqlColumnDeclaration</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>UNIQUE</code>, <code>PRIMARY KEY</code> constraints.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlCreateForeignSchema.html" title="class in org.apache.calcite.sql.ddl">SqlCreateForeignSchema</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>CREATE FOREIGN SCHEMA</code> statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlCreateFunction.html" title="class in org.apache.calcite.sql.ddl">SqlCreateFunction</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>CREATE FUNCTION</code> statement.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlCreateMaterializedView.html" title="class in org.apache.calcite.sql.ddl">SqlCreateMaterializedView</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>CREATE MATERIALIZED VIEW</code> statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlCreateMaterializedView.MaterializedViewTable.html" title="class in org.apache.calcite.sql.ddl">SqlCreateMaterializedView.MaterializedViewTable</a></th>
<td class="colLast">
<div class="block">A table that implements a materialized view.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlCreateSchema.html" title="class in org.apache.calcite.sql.ddl">SqlCreateSchema</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>CREATE SCHEMA</code> statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlCreateTable.html" title="class in org.apache.calcite.sql.ddl">SqlCreateTable</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>CREATE TABLE</code> statement.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlCreateTable.AbstractModifiableTable.html" title="class in org.apache.calcite.sql.ddl">SqlCreateTable.AbstractModifiableTable</a></th>
<td class="colLast">
<div class="block">Abstract base class for implementations of <a href="../../schema/ModifiableTable.html" title="interface in org.apache.calcite.schema"><code>ModifiableTable</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlCreateTable.ColumnDef.html" title="class in org.apache.calcite.sql.ddl">SqlCreateTable.ColumnDef</a></th>
<td class="colLast">
<div class="block">Column definition.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlCreateTable.MutableArrayTable.html" title="class in org.apache.calcite.sql.ddl">SqlCreateTable.MutableArrayTable</a></th>
<td class="colLast">
<div class="block">Table backed by a Java list.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlCreateType.html" title="class in org.apache.calcite.sql.ddl">SqlCreateType</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>CREATE TYPE</code> statement.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlCreateView.html" title="class in org.apache.calcite.sql.ddl">SqlCreateView</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>CREATE VIEW</code> statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlDdlNodes.html" title="class in org.apache.calcite.sql.ddl">SqlDdlNodes</a></th>
<td class="colLast">
<div class="block">Utilities concerning <a href="../SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> for DDL.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlDropFunction.html" title="class in org.apache.calcite.sql.ddl">SqlDropFunction</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>DROP FUNCTION</code> statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlDropMaterializedView.html" title="class in org.apache.calcite.sql.ddl">SqlDropMaterializedView</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>DROP MATERIALIZED VIEW</code> statement.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlDropObject.html" title="class in org.apache.calcite.sql.ddl">SqlDropObject</a></th>
<td class="colLast">
<div class="block">Base class for parse trees of <code>DROP TABLE</code>, <code>DROP VIEW</code>,
<code>DROP MATERIALIZED VIEW</code> and <code>DROP TYPE</code> statements.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlDropSchema.html" title="class in org.apache.calcite.sql.ddl">SqlDropSchema</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>DROP TABLE</code> statement.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlDropTable.html" title="class in org.apache.calcite.sql.ddl">SqlDropTable</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>DROP TABLE</code> statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlDropType.html" title="class in org.apache.calcite.sql.ddl">SqlDropType</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>DROP TYPE</code> statement.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlDropView.html" title="class in org.apache.calcite.sql.ddl">SqlDropView</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>DROP VIEW</code> statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlKeyConstraint.html" title="class in org.apache.calcite.sql.ddl">SqlKeyConstraint</a></th>
<td class="colLast">
<div class="block">Parse tree for <code>UNIQUE</code>, <code>PRIMARY KEY</code> constraints.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlDdlNodes.FileType.html" title="enum in org.apache.calcite.sql.ddl">SqlDdlNodes.FileType</a></th>
<td class="colLast">
<div class="block">File type for CREATE FUNCTION.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>