Skip to content

Commit 2a1f88a

Browse files
committed
Javadoc regenerated
1 parent 6178171 commit 2a1f88a

File tree

1 file changed

+24
-16
lines changed

1 file changed

+24
-16
lines changed

apidocs/com/google/mu/safesql/SafeSql.html

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1477,7 +1477,8 @@ <h3>paginateLazily</h3>
14771477
<a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;? extends T&gt;&nbsp;resultType)</span></div>
14781478
<div class="block">Paginate the encapsulated query by fetching up to <code>pageSize</code> rows for each page.
14791479

1480-
<p>If <code>orderByKeys</code> is non-empty, the column values are used to control pagination.
1480+
<p>If <code>orderByKeys</code> is non-empty, they refer to the columns that must uniquely identify
1481+
a row. These column values are then used to control pagination.
14811482
For example, if <code>[groupId, timestamp]</code> can uniquely identify a row, the generated
14821483
SQL will use <code>"groupId" &gt; ? OR ("groupId" = ? AND "timestamp" &gt; ?)</code> for the next page,
14831484
comparing against the previous page's last row.
@@ -1488,10 +1489,11 @@ <h3>paginateLazily</h3>
14881489

14891490
<p>The standard SQL <code>FETCH NEXT ROWS</code> syntax is used for pagination.
14901491
If <code>orderByKeys</code> is empty, the paginated query will use <code>OFFSET</code> keyword
1491-
to specify the next page offset.
1492+
instead of the sort key columns to specify the next page offset.
14921493

1493-
<p>All column names are automatically double-quoted to avoid clashing with keywords or spaces
1494-
in identifiers. If your DB is case sensitive, make sure you pass in the accurate case.
1494+
<p>The <code>orderByKeys</code> column names are automatically double-quoted to avoid clashing
1495+
with keywords or spaces in identifiers.
1496+
If your DB is case sensitive, make sure you pass in the accurate case.
14951497

14961498
<p>The method is lazy. Paginated queries are only sent when the returned stream is consumed.
14971499
The caller should close the <code>connection</code> after done, which will close the cached
@@ -1523,7 +1525,8 @@ <h3>paginateLazily</h3>
15231525
<a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;? extends T&gt;&nbsp;resultType)</span></div>
15241526
<div class="block">Paginate the encapsulated query by fetching up to <code>pageSize</code> rows for each page.
15251527

1526-
<p>If <code>orderByKeys</code> is non-empty, the column values are used to control pagination.
1528+
<p>If <code>orderByKeys</code> is non-empty, they refer to the columns that must uniquely identify
1529+
a row. These column values are then used to control pagination.
15271530
For example, if <code>[groupId, timestamp]</code> can uniquely identify a row, the generated
15281531
SQL will use <code>"groupId" &gt; ? OR ("groupId" = ? AND "timestamp" &gt; ?)</code> for the next page,
15291532
comparing against the previous page's last row.
@@ -1534,10 +1537,11 @@ <h3>paginateLazily</h3>
15341537

15351538
<p>The standard SQL <code>FETCH NEXT ROWS</code> syntax is used for pagination.
15361539
If <code>orderByKeys</code> is empty, the paginated query will use <code>OFFSET</code> keyword
1537-
to specify the next page offset.
1540+
instead of the sort key columns to specify the next page offset.
15381541

1539-
<p>All column names are automatically double-quoted to avoid clashing with keywords or spaces
1540-
in identifiers. If your DB is case sensitive, make sure you pass in the accurate case.
1542+
<p>The <code>orderByKeys</code> column names are automatically double-quoted to avoid clashing
1543+
with keywords or spaces in identifiers.
1544+
If your DB is case sensitive, make sure you pass in the accurate case.
15411545

15421546
<p>The method is lazy. Paginated queries are only sent when the returned stream is consumed.
15431547
The caller should close the <code>connection</code> after done, which will close the cached
@@ -1569,7 +1573,8 @@ <h3>paginateLazily</h3>
15691573
<a href="SqlFunction.html" title="interface in com.google.mu.safesql">SqlFunction</a>&lt;? super <a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.sql/java/sql/ResultSet.html" title="class or interface in java.sql" class="external-link">ResultSet</a>, ? extends T&gt;&nbsp;rowMapper)</span></div>
15701574
<div class="block">Paginate the encapsulated query by fetching up to <code>pageSize</code> rows for each page.
15711575

1572-
<p>If <code>orderByKeys</code> is non-empty, the column values are used to control pagination.
1576+
<p>If <code>orderByKeys</code> is non-empty, they refer to the columns that must uniquely identify
1577+
a row. These column values are then used to control pagination.
15731578
For example, if <code>[groupId, timestamp]</code> can uniquely identify a row, the generated
15741579
SQL will use <code>"groupId" &gt; ? OR ("groupId" = ? AND "timestamp" &gt; ?)</code> for the next page,
15751580
comparing against the previous page's last row.
@@ -1580,10 +1585,11 @@ <h3>paginateLazily</h3>
15801585

15811586
<p>The standard SQL <code>FETCH NEXT ROWS</code> syntax is used for pagination.
15821587
If <code>orderByKeys</code> is empty, the paginated query will use <code>OFFSET</code> keyword
1583-
to specify the next page offset.
1588+
instead of the sort key columns to specify the next page offset.
15841589

1585-
<p>All column names are automatically double-quoted to avoid clashing with keywords or spaces
1586-
in identifiers. If your DB is case sensitive, make sure you pass in the accurate case.
1590+
<p>The <code>orderByKeys</code> column names are automatically double-quoted to avoid clashing
1591+
with keywords or spaces in identifiers.
1592+
If your DB is case sensitive, make sure you pass in the accurate case.
15871593

15881594
<p>The method is lazy. Paginated queries are only sent when the returned stream is consumed.
15891595
The caller should close the <code>connection</code> after done, which will close the cached
@@ -1615,7 +1621,8 @@ <h3>paginateLazily</h3>
16151621
<a href="SqlFunction.html" title="interface in com.google.mu.safesql">SqlFunction</a>&lt;? super <a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.sql/java/sql/ResultSet.html" title="class or interface in java.sql" class="external-link">ResultSet</a>, ? extends T&gt;&nbsp;rowMapper)</span></div>
16161622
<div class="block">Paginate the encapsulated query by fetching up to <code>pageSize</code> rows for each page.
16171623

1618-
<p>If <code>orderByKeys</code> is non-empty, the column values are used to control pagination.
1624+
<p>If <code>orderByKeys</code> is non-empty, they refer to the columns that must uniquely identify
1625+
a row. These column values are then used to control pagination.
16191626
For example, if <code>[groupId, timestamp]</code> can uniquely identify a row, the generated
16201627
SQL will use <code>"groupId" &gt; ? OR ("groupId" = ? AND "timestamp" &gt; ?)</code> for the next page,
16211628
comparing against the previous page's last row.
@@ -1626,10 +1633,11 @@ <h3>paginateLazily</h3>
16261633

16271634
<p>The standard SQL <code>FETCH NEXT ROWS</code> syntax is used for pagination.
16281635
If <code>orderByKeys</code> is empty, the paginated query will use <code>OFFSET</code> keyword
1629-
to specify the next page offset.
1636+
instead of the sort key columns to specify the next page offset.
16301637

1631-
<p>All column names are automatically double-quoted to avoid clashing with keywords or spaces
1632-
in identifiers. If your DB is case sensitive, make sure you pass in the accurate case.
1638+
<p>The <code>orderByKeys</code> column names are automatically double-quoted to avoid clashing
1639+
with keywords or spaces in identifiers.
1640+
If your DB is case sensitive, make sure you pass in the accurate case.
16331641

16341642
<p>The method is lazy. Paginated queries are only sent when the returned stream is consumed.
16351643
The caller should close the <code>connection</code> after done, which will close the cached

0 commit comments

Comments
 (0)