Skip to content

Commit b0efd3b

Browse files
committed
Added documentation for '1.7.3'.
1 parent 40a68b9 commit b0efd3b

866 files changed

Lines changed: 3473 additions & 2512 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
</button>
4444
<div class="navigation-controls--break ui-kit_mobile-only"></div>
4545
<div class="library-version" id="library-version">
46-
1.7.2 </div>
46+
1.7.3 </div>
4747
<div class="navigation-controls">
4848
<button class="navigation-controls--btn navigation-controls--btn_theme" id="theme-toggle-button"
4949
type="button">Switch theme

docs/navigation.html

Lines changed: 67 additions & 22 deletions
Large diffs are not rendered by default.

docs/package-list

Lines changed: 25 additions & 33 deletions
Large diffs are not rendered by default.

docs/scripts/pages.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/scripts/platform-content-handler.js

Lines changed: 8 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,8 @@ filteringContext = {
99
}
1010
let highlightedAnchor;
1111
let topNavbarOffset;
12-
let instances = [];
1312
let sourcesetNotification;
1413

15-
const samplesDarkThemeName = 'darcula'
16-
const samplesLightThemeName = 'idea'
17-
1814
window.addEventListener('load', () => {
1915
document.querySelectorAll("div[data-platform-hinted]")
2016
.forEach(elem => elem.addEventListener('click', (event) => togglePlatformDependent(event, elem)))
@@ -37,60 +33,26 @@ const darkModeSwitch = () => {
3733
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
3834
const darkModeEnabled = storage ? JSON.parse(storage) : osDarkSchemePreferred
3935
const element = document.getElementById("theme-toggle-button")
40-
initPlayground(darkModeEnabled ? samplesDarkThemeName : samplesLightThemeName)
36+
37+
// Notify external scripts about changing dark mode, runnable samples plugin depends on this
38+
if (window.onDarkModeChanged) {
39+
window.onDarkModeChanged(darkModeEnabled)
40+
}
4141

4242
element.addEventListener('click', () => {
4343
const enabledClasses = document.getElementsByTagName("html")[0].classList
4444
enabledClasses.toggle("theme-dark")
4545

4646
//if previously we had saved dark theme then we set it to light as this is what we save in local storage
4747
const darkModeEnabled = enabledClasses.contains("theme-dark")
48-
if (darkModeEnabled) {
49-
initPlayground(samplesDarkThemeName)
50-
} else {
51-
initPlayground(samplesLightThemeName)
48+
// Notify external scripts about changing dark mode, runnable samples plugin depends on this
49+
if (window.onDarkModeChanged) {
50+
window.onDarkModeChanged(darkModeEnabled)
5251
}
5352
safeLocalStorage.setItem(localStorageKey, JSON.stringify(darkModeEnabled))
5453
})
5554
}
5655

57-
const initPlayground = (theme) => {
58-
if (!samplesAreEnabled()) return
59-
instances.forEach(instance => instance.destroy())
60-
instances = []
61-
62-
// Manually tag code fragments as not processed by playground since we also manually destroy all of its instances
63-
document.querySelectorAll('code.runnablesample').forEach(node => {
64-
node.removeAttribute("data-kotlin-playground-initialized");
65-
66-
if (node.parentNode) {
67-
node.parentNode.setAttribute("runnable-code-sample", "");
68-
}
69-
})
70-
71-
KotlinPlayground('code.runnablesample', {
72-
getInstance: playgroundInstance => {
73-
instances.push(playgroundInstance)
74-
},
75-
theme: theme
76-
});
77-
}
78-
79-
// We check if type is accessible from the current scope to determine if samples script is present
80-
// As an alternative we could extract this samples-specific script to new js file but then we would handle dark mode in 2 separate files which is not ideal
81-
const samplesAreEnabled = () => {
82-
try {
83-
if (typeof KotlinPlayground === 'undefined') {
84-
// KotlinPlayground is exported universally as a global variable or as a module
85-
// Due to possible interaction with other js scripts KotlinPlayground may not be accessible directly from `window`, so we need an additional check
86-
KotlinPlayground = exports.KotlinPlayground;
87-
}
88-
return typeof KotlinPlayground === 'function';
89-
} catch (e) {
90-
return false
91-
}
92-
}
93-
9456
// Hash change is needed in order to allow for linking inside the same page with anchors
9557
// If this is not present user is forced to refresh the site in order to use an anchor
9658
window.onhashchange = handleAnchor
@@ -278,16 +240,6 @@ function refreshFiltering() {
278240
refreshFilterButtons()
279241
refreshPlatformTabs()
280242
refreshNoContentNotification()
281-
refreshPlaygroundSamples()
282-
}
283-
284-
function refreshPlaygroundSamples() {
285-
document.querySelectorAll('code.runnablesample').forEach(node => {
286-
const playground = node.KotlinPlayground;
287-
/* Some samples may be hidden by filter, they have 0px height for visible code area
288-
* after rendering. Call this method for re-calculate code area height */
289-
playground && playground.view.codemirror.refresh();
290-
});
291243
}
292244

293245
function refreshNoContentNotification() {

docs/sqlx4k-arrow/index.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
}
1919
}
2020
</script>
21-
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
2221
<script type="text/javascript" src="../scripts/sourceset_dependencies.js" async></script>
2322
<link href="../styles/style.css" rel="Stylesheet">
2423
<link href="../styles/main.css" rel="Stylesheet">
@@ -39,7 +38,7 @@
3938
</a> <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
4039
</button>
4140
<div class="navigation-controls--break ui-kit_mobile-only"></div>
42-
<div class="library-version" id="library-version">1.7.2
41+
<div class="library-version" id="library-version">1.7.3
4342
</div>
4443
<div class="navigation-controls">
4544
<ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

docs/sqlx4k-arrow/io.github.smyrgeorge.sqlx4k.arrow.impl.extensions/-db-result/index.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
}
1919
}
2020
</script>
21-
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
2221
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script>
2322
<link href="../../../styles/style.css" rel="Stylesheet">
2423
<link href="../../../styles/main.css" rel="Stylesheet">
@@ -39,7 +38,7 @@
3938
</a> <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
4039
</button>
4140
<div class="navigation-controls--break ui-kit_mobile-only"></div>
42-
<div class="library-version" id="library-version">1.7.2
41+
<div class="library-version" id="library-version">1.7.3
4342
</div>
4443
<div class="navigation-controls">
4544
<ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

docs/sqlx4k-arrow/io.github.smyrgeorge.sqlx4k.arrow.impl.extensions/index.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
}
1919
}
2020
</script>
21-
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
2221
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async></script>
2322
<link href="../../styles/style.css" rel="Stylesheet">
2423
<link href="../../styles/main.css" rel="Stylesheet">
@@ -39,7 +38,7 @@
3938
</a> <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
4039
</button>
4140
<div class="navigation-controls--break ui-kit_mobile-only"></div>
42-
<div class="library-version" id="library-version">1.7.2
41+
<div class="library-version" id="library-version">1.7.3
4342
</div>
4443
<div class="navigation-controls">
4544
<ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

docs/sqlx4k-arrow/io.github.smyrgeorge.sqlx4k.arrow.impl.extensions/to-db-result.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
}
1919
}
2020
</script>
21-
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
2221
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async></script>
2322
<link href="../../styles/style.css" rel="Stylesheet">
2423
<link href="../../styles/main.css" rel="Stylesheet">
@@ -39,7 +38,7 @@
3938
</a> <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
4039
</button>
4140
<div class="navigation-controls--break ui-kit_mobile-only"></div>
42-
<div class="library-version" id="library-version">1.7.2
41+
<div class="library-version" id="library-version">1.7.3
4342
</div>
4443
<div class="navigation-controls">
4544
<ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

docs/sqlx4k-arrow/io.github.smyrgeorge.sqlx4k.arrow/-arrow-context-crud-repository/batch-insert.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
}
1919
}
2020
</script>
21-
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
2221
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script>
2322
<link href="../../../styles/style.css" rel="Stylesheet">
2423
<link href="../../../styles/main.css" rel="Stylesheet">
@@ -39,7 +38,7 @@
3938
</a> <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
4039
</button>
4140
<div class="navigation-controls--break ui-kit_mobile-only"></div>
42-
<div class="library-version" id="library-version">1.7.2
41+
<div class="library-version" id="library-version">1.7.3
4342
</div>
4443
<div class="navigation-controls">
4544
<ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">
@@ -95,7 +94,7 @@
9594
<div class="cover ">
9695
<h1 class="cover"><span>batch</span><wbr><span><span>Insert</span></span></h1>
9796
</div>
98-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":sqlx4k-arrow/commonMain"><div class="symbol monospace"><span class="token keyword">context</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="../../../sqlx4k/io.github.smyrgeorge.sqlx4k/-query-executor/index.html">QueryExecutor</a></span></span><span class="token punctuation">)</span><br><span class="token keyword">abstract </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="batch-insert.html"><span class="token function">batchInsert</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">entities<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../io.github.smyrgeorge.sqlx4k.arrow.impl.extensions/-db-result/index.html">DbResult</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/smyrgeorge/sqlx4k/tree/main/sqlx4k-arrow/src/commonMain/kotlin/io/github/smyrgeorge/sqlx4k/arrow/ArrowContextCrudRepository.kt#L87">source</a>)</span></span></div><p class="paragraph">Inserts multiple entities into the data source using the specified driver context.</p><p class="paragraph">This method performs an asynchronous batch insert operation and returns the result. If the operation is successful, the result will contain the list of inserted entities. In case of failure, the result contains the error details.</p><p class="paragraph">Note: Batch insert is not supported for MySQL dialect (no multi-row INSERT with RETURNING).</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">A <a href="../../io.github.smyrgeorge.sqlx4k.arrow.impl.extensions/-db-result/index.html">DbResult</a> containing the list of inserted entities of type <a href="index.html">T</a> if the operation is successful, or an error if the operation fails.</p></span><h4 class="tableheader">Parameters</h4><div class="table"><div class="table-row table-row_content" data-filterable-current=":sqlx4k-arrow/commonMain" data-filterable-set=":sqlx4k-arrow/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>entities</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The collection of entities of type <a href="index.html">T</a> to be inserted into the data source.</p></div></div></div></div></div></div></div>
97+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":sqlx4k-arrow/commonMain"><div class="symbol monospace"><span class="token keyword">context</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="../../../sqlx4k/io.github.smyrgeorge.sqlx4k/-query-executor/index.html">QueryExecutor</a></span></span><span class="token punctuation">)</span><br><span class="token keyword">abstract </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="batch-insert.html"><span class="token function">batchInsert</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">entities<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../io.github.smyrgeorge.sqlx4k.arrow.impl.extensions/-db-result/index.html">DbResult</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/smyrgeorge/sqlx4k/tree/main/sqlx4k-arrow/src/commonMain/kotlin/io/github/smyrgeorge/sqlx4k/arrow/ArrowContextCrudRepository.kt#L87">source</a>)</span></span></div><p class="paragraph">Inserts multiple entities into the data source using the specified driver context.</p><p class="paragraph">This method performs an asynchronous batch insert operation and returns the result. If the operation is successful, the result will contain the list of inserted entities. In case of failure, the result contains the error details.</p><p class="paragraph">Note: Batch insert is not supported for MySQL dialect (no multi-row INSERT with RETURNING).</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">A <a href="../../io.github.smyrgeorge.sqlx4k.arrow.impl.extensions/-db-result/index.html">DbResult</a> containing the list of inserted entities of type <a href="index.html">T</a> if the operation is successful, or an error if the operation fails.</p></span><h4 class="tableheader">Parameters</h4><div class="table"><div class="table-row table-row_content" data-filterable-current=":sqlx4k-arrow/commonMain" data-filterable-set=":sqlx4k-arrow/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>entities</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The collection of entities of type <a href="index.html">T</a> to be inserted into the data source.</p></div></div></div></div></div></div></div>
9998
</div>
10099
<div class="footer">
101100
<div class="footer--container">

0 commit comments

Comments
 (0)