Skip to content

Commit

Permalink
build based on e6935c8
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 8, 2024
1 parent 1d01700 commit d6ceb53
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-08T00:46:59","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-08T00:47:30","documenter_version":"1.7.0"}}
2 changes: 1 addition & 1 deletion dev/apireference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@
from autoincrement</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jcharistech/Jorm.jl/blob/e6935c8169256bdd22947e9d546efcbf9e624fd0/src/JormUtils.jl#L141-L147">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Jorm.tablename-Tuple{Any}" href="#Jorm.tablename-Tuple{Any}"><code>Jorm.tablename</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">tablename(model)
Generate the table name for a given model. The table name is derived from the model&#39;s type name, converting it to lowercase and joining words with underscores.</code></pre><p>struct MyModel end println(tablename(MyModel)) # Output: &quot;my_model&quot;</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jcharistech/Jorm.jl/blob/e6935c8169256bdd22947e9d546efcbf9e624fd0/src/Jorm.jl#L37-L43">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Jorm.update!-Tuple{SQLite.DB, Any, Any, Any}" href="#Jorm.update!-Tuple{SQLite.DB, Any, Any, Any}"><code>Jorm.update!</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">update!(db::SQLite.DB, model, id, data)
Update data to the DB for a given model</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jcharistech/Jorm.jl/blob/e6935c8169256bdd22947e9d546efcbf9e624fd0/src/Jorm.jl#L303-L306">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Jorm.@raw_sql-Tuple{String}" href="#Jorm.@raw_sql-Tuple{String}"><code>Jorm.@raw_sql</code></a><span class="docstring-category">Macro</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">macro raw_sql(v::String)
-&gt; RawSQL</code></pre><p>Create a <code>RawSQL</code> instance from a given SQL query string.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jcharistech/Jorm.jl/blob/e6935c8169256bdd22947e9d546efcbf9e624fd0/src/Jorm.jl#L26-L31">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../working_with_webapps/">« Jorm.jl with WebApps</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Sunday 8 September 2024 00:46">Sunday 8 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
-&gt; RawSQL</code></pre><p>Create a <code>RawSQL</code> instance from a given SQL query string.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jcharistech/Jorm.jl/blob/e6935c8169256bdd22947e9d546efcbf9e624fd0/src/Jorm.jl#L26-L31">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../working_with_webapps/">« Jorm.jl with WebApps</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Sunday 8 September 2024 00:47">Sunday 8 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@
result = Jorm.delete!(db, BlogArticle, 1)
result = Jorm.read_one(db, BlogArticle, 1)
@test isempty(result)</code></pre><h4 id="Closing-the-Database-Connection"><a class="docs-heading-anchor" href="#Closing-the-Database-Connection">Closing the Database Connection</a><a id="Closing-the-Database-Connection-1"></a><a class="docs-heading-anchor-permalink" href="#Closing-the-Database-Connection" title="Permalink"></a></h4><p>Close the database connection and delete the database file if needed:</p><pre><code class="language-julia hljs">Jorm.disconnect(db)
Jorm.delete_db(connection_string)</code></pre><h3 id="Other-Julia-ORM-Like-Libraries"><a class="docs-heading-anchor" href="#Other-Julia-ORM-Like-Libraries">Other Julia ORM Like Libraries</a><a id="Other-Julia-ORM-Like-Libraries-1"></a><a class="docs-heading-anchor-permalink" href="#Other-Julia-ORM-Like-Libraries" title="Permalink"></a></h3><p>Jorm.jl is a simple and young ORM tool for working with Web Apps and Databases, but it&#39;s not ideal for all applications. For users with more specialized needs, consider using:</p><ul><li>SearchLight.jl</li><li>FunnyORM.jl</li><li>SQLite.jl</li><li>LibPQ.jl</li><li>Wasabi.jl</li><li>etc</li><li></li></ul><h3 id="Questions"><a class="docs-heading-anchor" href="#Questions">Questions</a><a id="Questions-1"></a><a class="docs-heading-anchor-permalink" href="#Questions" title="Permalink"></a></h3><p>If there is something you expect Jorm.jl to be capable of, but cannot figure out how to do, please reach out with questions. Additionally you can check out the introduction to Jorm.jl.</p><p>Documentation for <a href="https://github.com/jcharistech/Jorm.jl">Jorm</a>.</p><p><em>Jesus Saves @JCharisTech</em></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="working_with_webapps/">Jorm.jl with WebApps »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Sunday 8 September 2024 00:46">Sunday 8 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Jorm.delete_db(connection_string)</code></pre><h3 id="Other-Julia-ORM-Like-Libraries"><a class="docs-heading-anchor" href="#Other-Julia-ORM-Like-Libraries">Other Julia ORM Like Libraries</a><a id="Other-Julia-ORM-Like-Libraries-1"></a><a class="docs-heading-anchor-permalink" href="#Other-Julia-ORM-Like-Libraries" title="Permalink"></a></h3><p>Jorm.jl is a simple and young ORM tool for working with Web Apps and Databases, but it&#39;s not ideal for all applications. For users with more specialized needs, consider using:</p><ul><li>SearchLight.jl</li><li>FunnyORM.jl</li><li>SQLite.jl</li><li>LibPQ.jl</li><li>Wasabi.jl</li><li>etc</li><li></li></ul><h3 id="Questions"><a class="docs-heading-anchor" href="#Questions">Questions</a><a id="Questions-1"></a><a class="docs-heading-anchor-permalink" href="#Questions" title="Permalink"></a></h3><p>If there is something you expect Jorm.jl to be capable of, but cannot figure out how to do, please reach out with questions. Additionally you can check out the introduction to Jorm.jl.</p><p>Documentation for <a href="https://github.com/jcharistech/Jorm.jl">Jorm</a>.</p><p><em>Jesus Saves @JCharisTech</em></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="working_with_webapps/">Jorm.jl with WebApps »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Sunday 8 September 2024 00:47">Sunday 8 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/working_with_webapps/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@
end

# Start the server
serve(port=8001)</code></pre><h4 id="View-in-Browser"><a class="docs-heading-anchor" href="#View-in-Browser">View in Browser</a><a id="View-in-Browser-1"></a><a class="docs-heading-anchor-permalink" href="#View-in-Browser" title="Permalink"></a></h4><p>Once you start the server ,you can check your browser or any web client to see the API endpoints available on <code>http://localhost:8001</code></p><p>This is one of the ways that provides a clear and concise guide on how to set up and use the CRUD API with <code>Oxygen.jl</code> and <code>Jorm.jl</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../apireference/">API Reference »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Sunday 8 September 2024 00:46">Sunday 8 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
serve(port=8001)</code></pre><h4 id="View-in-Browser"><a class="docs-heading-anchor" href="#View-in-Browser">View in Browser</a><a id="View-in-Browser-1"></a><a class="docs-heading-anchor-permalink" href="#View-in-Browser" title="Permalink"></a></h4><p>Once you start the server ,you can check your browser or any web client to see the API endpoints available on <code>http://localhost:8001</code></p><p>This is one of the ways that provides a clear and concise guide on how to set up and use the CRUD API with <code>Oxygen.jl</code> and <code>Jorm.jl</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../apireference/">API Reference »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Sunday 8 September 2024 00:47">Sunday 8 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 comments on commit d6ceb53

Please sign in to comment.