1
mirror of https://github.com/CarmJos/EasySQL.git synced 2026-06-04 15:28:20 +08:00
Files
EasySQL/cc/carm/lib/easysql/api/builder/TableMetadataBuilder.html
T
2023-03-15 23:16:32 +08:00

365 lines
14 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="zh">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 15 15:16:08 UTC 2023 -->
<title>TableMetadataBuilder (EasySQL-API 0.4.7 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-03-15">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.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.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TableMetadataBuilder (EasySQL-API 0.4.7 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":18,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TableMetadataBuilder.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">cc.carm.lib.easysql.api.builder</a></div>
<h2 title="Interface TableMetadataBuilder" class="title">Interface TableMetadataBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="../SQLBuilder.html" title="interface in cc.carm.lib.easysql.api">SQLBuilder</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">TableMetadataBuilder</span>
extends <a href="../SQLBuilder.html" title="interface in cc.carm.lib.easysql.api">SQLBuilder</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>&lt;R&gt;&nbsp;java.util.concurrent.CompletableFuture&lt;R&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchColumns(java.lang.String,cc.carm.lib.easysql.api.function.SQLFunction)">fetchColumns</a></span>&#8203;(@Nullable java.lang.String&nbsp;columnPattern,
@NotNull <a href="../function/SQLFunction.html" title="interface in cc.carm.lib.easysql.api.function">SQLFunction</a>&lt;java.sql.ResultSet,&#8203;R&gt;&nbsp;reader)</code></th>
<td class="colLast">
<div class="block">对表内的数据列元数据进行读取</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.concurrent.CompletableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isColumnExists(java.lang.String)">isColumnExists</a></span>&#8203;(@NotNull java.lang.String&nbsp;columnPattern)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default java.util.concurrent.CompletableFuture&lt;@Unmodifiable java.util.Set&lt;java.lang.String&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listColumns()">listColumns</a></span>()</code></th>
<td class="colLast">
<div class="block">列出所有表内的全部列。</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.concurrent.CompletableFuture&lt;@Unmodifiable java.util.Set&lt;java.lang.String&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listColumns(java.lang.String)">listColumns</a></span>&#8203;(@Nullable java.lang.String&nbsp;columnPattern)</code></th>
<td class="colLast">
<div class="block">列出所有满足表达式的列。</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.concurrent.CompletableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateExist()">validateExist</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.cc.carm.lib.easysql.api.SQLBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;cc.carm.lib.easysql.api.<a href="../SQLBuilder.html" title="interface in cc.carm.lib.easysql.api">SQLBuilder</a></h3>
<code><a href="../SQLBuilder.html#getManager()">getManager</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="validateExist()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateExist</h4>
<pre class="methodSignature">java.util.concurrent.CompletableFuture&lt;java.lang.Boolean&gt;&nbsp;validateExist()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>本表是否存在</dd>
</dl>
</li>
</ul>
<a id="fetchColumns(java.lang.String,cc.carm.lib.easysql.api.function.SQLFunction)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchColumns</h4>
<pre class="methodSignature">&lt;R&gt;&nbsp;java.util.concurrent.CompletableFuture&lt;R&gt;&nbsp;fetchColumns&#8203;(@Nullable
@Nullable java.lang.String&nbsp;columnPattern,
@NotNull
@NotNull <a href="../function/SQLFunction.html" title="interface in cc.carm.lib.easysql.api.function">SQLFunction</a>&lt;java.sql.ResultSet,&#8203;R&gt;&nbsp;reader)</pre>
<div class="block">对表内的数据列元数据进行读取</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>R</code> - 结果类型</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>columnPattern</code> - 列的名称匹配表达式, 为空则匹配所有列</dd>
<dd><code>reader</code> - 读取的方法</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>读取结果</dd>
</dl>
</li>
</ul>
<a id="isColumnExists(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isColumnExists</h4>
<pre class="methodSignature">java.util.concurrent.CompletableFuture&lt;java.lang.Boolean&gt;&nbsp;isColumnExists&#8203;(@NotNull
@NotNull java.lang.String&nbsp;columnPattern)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>columnPattern</code> - 需要判断的列名表达式</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>对应列是否存在</dd>
</dl>
</li>
</ul>
<a id="listColumns()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listColumns</h4>
<pre class="methodSignature">default&nbsp;java.util.concurrent.CompletableFuture&lt;@Unmodifiable java.util.Set&lt;java.lang.String&gt;&gt;&nbsp;listColumns()</pre>
<div class="block">列出所有表内的全部列。</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>表内全部数据列的列名</dd>
</dl>
</li>
</ul>
<a id="listColumns(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>listColumns</h4>
<pre class="methodSignature">java.util.concurrent.CompletableFuture&lt;@Unmodifiable java.util.Set&lt;java.lang.String&gt;&gt;&nbsp;listColumns&#8203;(@Nullable
@Nullable java.lang.String&nbsp;columnPattern)</pre>
<div class="block">列出所有满足表达式的列。</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>columnPattern</code> - 列名表达式,为空则列出全部</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>所有满足表达式的列名</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TableMetadataBuilder.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2023. All rights reserved.</small></p>
</footer>
</body>
</html>