|
| 1 | +<!DOCTYPE HTML> |
| 2 | +<html lang="en"> |
| 3 | +<head> |
| 4 | +<!-- Generated by javadoc (21) on Fri Jul 04 10:52:10 PDT 2025 --> |
| 5 | +<title>GoogleSql (mug-root 8.8-SNAPSHOT API)</title> |
| 6 | +<meta name="viewport" content="width=device-width, initial-scale=1"> |
| 7 | +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 8 | +<meta name="dc.created" content="2025-07-04"> |
| 9 | +<meta name="description" content="declaration: package: com.google.mu.safesql, class: GoogleSql"> |
| 10 | +<meta name="generator" content="javadoc/ClassWriterImpl"> |
| 11 | +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| 12 | +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| 13 | +<script type="text/javascript" src="../../../../script.js"></script> |
| 14 | +<script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| 15 | +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| 16 | +</head> |
| 17 | +<body class="class-declaration-page"> |
| 18 | +<script type="text/javascript">var pathtoroot = "../../../../"; |
| 19 | +loadScripts(document, 'script');</script> |
| 20 | +<noscript> |
| 21 | +<div>JavaScript is disabled on your browser.</div> |
| 22 | +</noscript> |
| 23 | +<div class="flex-box"> |
| 24 | +<header role="banner" class="flex-header"> |
| 25 | +<nav role="navigation"> |
| 26 | +<!-- ========= START OF TOP NAVBAR ======= --> |
| 27 | +<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| 28 | +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| 29 | +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| 30 | +<li><a href="../../../../index.html">Overview</a></li> |
| 31 | +<li><a href="package-summary.html">Package</a></li> |
| 32 | +<li class="nav-bar-cell1-rev">Class</li> |
| 33 | +<li><a href="class-use/GoogleSql.html">Use</a></li> |
| 34 | +<li><a href="package-tree.html">Tree</a></li> |
| 35 | +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| 36 | +<li><a href="../../../../index-all.html">Index</a></li> |
| 37 | +<li><a href="../../../../help-doc.html#class">Help</a></li> |
| 38 | +</ul> |
| 39 | +<ul class="sub-nav-list-small"> |
| 40 | +<li> |
| 41 | +<p>Summary:</p> |
| 42 | +<ul> |
| 43 | +<li>Nested</li> |
| 44 | +<li>Field</li> |
| 45 | +<li>Constr</li> |
| 46 | +<li><a href="#method-summary">Method</a></li> |
| 47 | +</ul> |
| 48 | +</li> |
| 49 | +<li> |
| 50 | +<p>Detail:</p> |
| 51 | +<ul> |
| 52 | +<li>Field</li> |
| 53 | +<li>Constr</li> |
| 54 | +<li><a href="#method-detail">Method</a></li> |
| 55 | +</ul> |
| 56 | +</li> |
| 57 | +</ul> |
| 58 | +</div> |
| 59 | +<div class="sub-nav"> |
| 60 | +<div id="navbar-sub-list"> |
| 61 | +<ul class="sub-nav-list"> |
| 62 | +<li>Summary: </li> |
| 63 | +<li>Nested | </li> |
| 64 | +<li>Field | </li> |
| 65 | +<li>Constr | </li> |
| 66 | +<li><a href="#method-summary">Method</a></li> |
| 67 | +</ul> |
| 68 | +<ul class="sub-nav-list"> |
| 69 | +<li>Detail: </li> |
| 70 | +<li>Field | </li> |
| 71 | +<li>Constr | </li> |
| 72 | +<li><a href="#method-detail">Method</a></li> |
| 73 | +</ul> |
| 74 | +</div> |
| 75 | +<div class="nav-list-search"><a href="../../../../search.html">SEARCH</a> |
| 76 | +<input type="text" id="search-input" disabled placeholder="Search"> |
| 77 | +<input type="reset" id="reset-button" disabled value="reset"> |
| 78 | +</div> |
| 79 | +</div> |
| 80 | +<!-- ========= END OF TOP NAVBAR ========= --> |
| 81 | +<span class="skip-nav" id="skip-navbar-top"></span></nav> |
| 82 | +</header> |
| 83 | +<div class="flex-content"> |
| 84 | +<main role="main"> |
| 85 | +<!-- ======== START OF CLASS DATA ======== --> |
| 86 | +<div class="header"> |
| 87 | +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.google.mu.safesql</a></div> |
| 88 | +<h1 title="Class GoogleSql" class="title">Class GoogleSql</h1> |
| 89 | +</div> |
| 90 | +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| 91 | +<div class="inheritance">com.google.mu.safesql.GoogleSql</div> |
| 92 | +</div> |
| 93 | +<section class="class-description" id="class-description"> |
| 94 | +<hr> |
| 95 | +<div class="type-signature"><span class="annotations"><a href="../annotations/RequiresGuava.html" title="annotation interface in com.google.mu.annotations">@RequiresGuava</a> |
| 96 | +@CheckReturnValue |
| 97 | +<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| 98 | +</span><span class="modifiers">public final class </span><span class="element-name type-name-label">GoogleSql</span> |
| 99 | +<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| 100 | +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| 101 | +<div class="deprecation-comment">You most likely need <a href="SafeSql.html" title="class in com.google.mu.safesql"><code>SafeSql</code></a> to work with JDBC</div> |
| 102 | +</div> |
| 103 | +<div class="block">Facade class providing <a href="SafeQuery.html" title="class in com.google.mu.safesql"><code>SafeQuery</code></a> templates for GoogleSQL.</div> |
| 104 | +<dl class="notes"> |
| 105 | +<dt>Since:</dt> |
| 106 | +<dd>7.0</dd> |
| 107 | +</dl> |
| 108 | +</section> |
| 109 | +<section class="summary"> |
| 110 | +<ul class="summary-list"> |
| 111 | +<!-- ========== METHOD SUMMARY =========== --> |
| 112 | +<li> |
| 113 | +<section class="method-summary" id="method-summary"> |
| 114 | +<h2>Method Summary</h2> |
| 115 | +<div id="method-summary-table"> |
| 116 | +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| 117 | +<div id="method-summary-table.tabpanel" role="tabpanel"> |
| 118 | +<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| 119 | +<div class="table-header col-first">Modifier and Type</div> |
| 120 | +<div class="table-header col-second">Method</div> |
| 121 | +<div class="table-header col-last">Description</div> |
| 122 | +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="SafeQuery.html" title="class in com.google.mu.safesql">SafeQuery</a></code></div> |
| 123 | +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#from(java.lang.String,java.lang.Object...)" class="member-name-link">from</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> queryTemplate, |
| 124 | + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>... args)</code></div> |
| 125 | +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| 126 | +<div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| 127 | +<div class="block">Much like <a href="SafeQuery.html#of(java.lang.String,java.lang.Object...)"><code>SafeQuery.of(java.lang.String, java.lang.Object...)</code></a>, but with additional GoogleSQL translation rules.</div> |
| 128 | +</div> |
| 129 | +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="../util/StringFormat.Template.html" title="interface in com.google.mu.util">StringFormat.Template</a><wbr><<a href="SafeQuery.html" title="class in com.google.mu.safesql">SafeQuery</a>></code></div> |
| 130 | +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#template(java.lang.String)" class="member-name-link">template</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> formatString)</code></div> |
| 131 | +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| 132 | +<div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| 133 | +<div class="block">Much like <a href="SafeQuery.html#template(java.lang.String)"><code>SafeQuery.template(java.lang.String)</code></a>, but with additional GoogleSQL translation rules.</div> |
| 134 | +</div> |
| 135 | +</div> |
| 136 | +</div> |
| 137 | +</div> |
| 138 | +<div class="inherited-list"> |
| 139 | +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| 140 | +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| 141 | +</section> |
| 142 | +</li> |
| 143 | +</ul> |
| 144 | +</section> |
| 145 | +<section class="details"> |
| 146 | +<ul class="details-list"> |
| 147 | +<!-- ============ METHOD DETAIL ========== --> |
| 148 | +<li> |
| 149 | +<section class="method-details" id="method-detail"> |
| 150 | +<h2>Method Details</h2> |
| 151 | +<ul class="member-list"> |
| 152 | +<li> |
| 153 | +<section class="detail" id="from(java.lang.String,java.lang.Object...)"> |
| 154 | +<h3>from</h3> |
| 155 | +<div class="member-signature"><span class="annotations"><a href="../annotations/TemplateFormatMethod.html" title="annotation interface in com.google.mu.annotations">@TemplateFormatMethod</a> |
| 156 | +</span><span class="modifiers">public static</span> <span class="return-type"><a href="SafeQuery.html" title="class in com.google.mu.safesql">SafeQuery</a></span> <span class="element-name">from</span><wbr><span class="parameters">(@CompileTimeConstant <a href="../annotations/TemplateString.html" title="annotation interface in com.google.mu.annotations">@TemplateString</a> |
| 157 | + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> queryTemplate, |
| 158 | + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>... args)</span></div> |
| 159 | +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| 160 | +<div class="block">Much like <a href="SafeQuery.html#of(java.lang.String,java.lang.Object...)"><code>SafeQuery.of(java.lang.String, java.lang.Object...)</code></a>, but with additional GoogleSQL translation rules. |
| 161 | + |
| 162 | + <p>Specifically, <a href="https://docs.oracle.com/javase/8/docs/api/java/time/Instant.html" title="class or interface in java.time" class="external-link"><code>Instant</code></a> are translated to `TIMESTAMP()` GoogleSql function, <a href="https://docs.oracle.com/javase/8/docs/api/java/time/ZonedDateTime.html" title="class or interface in java.time" class="external-link"><code>ZonedDateTime</code></a> are translated to `DATETIME()` GoogleSql function, and <a href="https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html" title="class or interface in java.time" class="external-link"><code>LocalDate</code></a> are |
| 163 | + translated to `DATE()` GoogleSql function.</div> |
| 164 | +<dl class="notes"> |
| 165 | +<dt>Since:</dt> |
| 166 | +<dd>8.0</dd> |
| 167 | +</dl> |
| 168 | +</section> |
| 169 | +</li> |
| 170 | +<li> |
| 171 | +<section class="detail" id="template(java.lang.String)"> |
| 172 | +<h3>template</h3> |
| 173 | +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../util/StringFormat.Template.html" title="interface in com.google.mu.util">StringFormat.Template</a><<a href="SafeQuery.html" title="class in com.google.mu.safesql">SafeQuery</a>></span> <span class="element-name">template</span><wbr><span class="parameters">(@CompileTimeConstant |
| 174 | + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> formatString)</span></div> |
| 175 | +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| 176 | +<div class="block">Much like <a href="SafeQuery.html#template(java.lang.String)"><code>SafeQuery.template(java.lang.String)</code></a>, but with additional GoogleSQL translation rules. |
| 177 | + |
| 178 | + <p>Specifically, <a href="https://docs.oracle.com/javase/8/docs/api/java/time/Instant.html" title="class or interface in java.time" class="external-link"><code>Instant</code></a> are translated to `TIMESTAMP()` GoogleSql function, |
| 179 | + <a href="https://docs.oracle.com/javase/8/docs/api/java/time/ZonedDateTime.html" title="class or interface in java.time" class="external-link"><code>ZonedDateTime</code></a> are translated to `DATETIME()` GoogleSql function, |
| 180 | + and <a href="https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html" title="class or interface in java.time" class="external-link"><code>LocalDate</code></a> are translated to `DATE()` GoogleSql function.</div> |
| 181 | +</section> |
| 182 | +</li> |
| 183 | +</ul> |
| 184 | +</section> |
| 185 | +</li> |
| 186 | +</ul> |
| 187 | +</section> |
| 188 | +<!-- ========= END OF CLASS DATA ========= --> |
| 189 | +</main> |
| 190 | +<footer role="contentinfo"> |
| 191 | +<hr> |
| 192 | +<p class="legal-copy"><small>Copyright © 2025. All rights reserved.</small></p> |
| 193 | +</footer> |
| 194 | +</div> |
| 195 | +</div> |
| 196 | +</body> |
| 197 | +</html> |
0 commit comments