-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Oct 3, 2024
1 parent
5977809
commit 7d843b5
Showing
16 changed files
with
28 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| {"documenter":{"julia_version":"1.7.3","generation_timestamp":"2024-10-03T08:14:22","documenter_version":"1.7.0"}} | ||
| {"documenter":{"julia_version":"1.7.3","generation_timestamp":"2024-10-03T09:19:42","documenter_version":"1.7.0"}} |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Configuration · SearchLight - Concise, secure, cross-platform query builder and ORM for Julia</title><meta name="title" content="Configuration · SearchLight - Concise, secure, cross-platform query builder and ORM for Julia"/><meta property="og:title" content="Configuration · SearchLight - Concise, secure, cross-platform query builder and ORM for Julia"/><meta property="twitter:title" content="Configuration · SearchLight - Concise, secure, cross-platform query builder and ORM for Julia"/><meta name="description" content="Documentation for SearchLight - Concise, secure, cross-platform query builder and ORM for Julia."/><meta property="og:description" content="Documentation for SearchLight - Concise, secure, cross-platform query builder and ORM for Julia."/><meta property="twitter:description" content="Documentation for SearchLight - Concise, secure, cross-platform query builder and ORM for Julia."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../index.html">SearchLight - Concise, secure, cross-platform query builder and ORM for Julia</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../index.html">Home</a></li><li><span class="tocitem">SearchLight API</span><ul><li><a class="tocitem" href="callbacks.html">Callbacks</a></li><li class="is-active"><a class="tocitem" href="configuration.html">Configuration</a></li><li><a class="tocitem" href="exceptions.html">Exceptions</a></li><li><a class="tocitem" href="filetemplates.html">FileTemplates</a></li><li><a class="tocitem" href="generator.html">Generator</a></li><li><a class="tocitem" href="migrations.html">Migrations</a></li><li><a class="tocitem" href="modeltypes.html">ModelTypes</a></li><li><a class="tocitem" href="querybuilder.html">QueryBuilder</a></li><li><a class="tocitem" href="relationships.html">Relationships</a></li><li><a class="tocitem" href="searchlight.html">SearchLight</a></li><li><a class="tocitem" href="serializer.html">Serializer</a></li><li><input class="collapse-toggle" id="menuitem-2-12" type="checkbox"/><label class="tocitem" for="menuitem-2-12"><span class="docs-label">Serializers</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="serializers/json.html">JsonSerializer</a></li></ul></li><li><a class="tocitem" href="transactions.html">Transactions</a></li><li><a class="tocitem" href="validation.html">Validation</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">SearchLight API</a></li><li class="is-active"><a href="configuration.html">Configuration</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="configuration.html">Configuration</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/GenieFramework/SearchLight.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/GenieFramework/SearchLight.jl/blob/master/docs/src/API/configuration.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><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="SearchLight.Configuration.env" href="#SearchLight.Configuration.env"><code>SearchLight.Configuration.env</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">env() :: String</code></pre><p>Returns the current environment.</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia> Configuration.env() | ||
| "dev"</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/SearchLight.jl/blob/fb0dcb103be4176a7f9f37f8cc55a69a4357ee38/src/Configuration.jl#L18-L28">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="SearchLight.Configuration.read_db_connection_data" href="#SearchLight.Configuration.read_db_connection_data"><code>SearchLight.Configuration.read_db_connection_data</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">read_db_connection_data(db_settings_file::String) :: Dict{Any,Any}</code></pre><p>Attempts to read the database configuration file and returns the part corresponding to the current environment as a <code>Dict</code>. Does not check if <code>db_settings_file</code> actually exists so it can throw errors. If the database connection information for the current environment does not exist, it returns an empty <code>Dict</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia> Configuration.read_db_connection_data(...) | ||
| "dev"</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/SearchLight.jl/blob/100cea89b6dc3a4a938ad3563872e3bc59cb084e/src/Configuration.jl#L18-L28">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="SearchLight.Configuration.read_db_connection_data" href="#SearchLight.Configuration.read_db_connection_data"><code>SearchLight.Configuration.read_db_connection_data</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">read_db_connection_data(db_settings_file::String) :: Dict{Any,Any}</code></pre><p>Attempts to read the database configuration file and returns the part corresponding to the current environment as a <code>Dict</code>. Does not check if <code>db_settings_file</code> actually exists so it can throw errors. If the database connection information for the current environment does not exist, it returns an empty <code>Dict</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia> Configuration.read_db_connection_data(...) | ||
| Dict{Any,Any} with 6 entries: | ||
| "host" => "localhost" | ||
| "password" => "..." | ||
| "username" => "..." | ||
| "port" => 5432 | ||
| "database" => "..." | ||
| "adapter" => "PostgreSQL"</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/SearchLight.jl/blob/fb0dcb103be4176a7f9f37f8cc55a69a4357ee38/src/Configuration.jl#L32-L50">source</a></section></article><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>load</code>. Check Documenter's build log for details.</p></div></div><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="SearchLight.Configuration.Settings" href="#SearchLight.Configuration.Settings"><code>SearchLight.Configuration.Settings</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">mutable struct Settings</code></pre><p>App configuration - sets up the app's defaults. Individual options are overwritten in the corresponding environment file.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/SearchLight.jl/blob/fb0dcb103be4176a7f9f37f8cc55a69a4357ee38/src/Configuration.jl#L98-L102">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="callbacks.html">« Callbacks</a><a class="docs-footer-nextpage" href="exceptions.html">Exceptions »</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="Thursday 3 October 2024 08:14">Thursday 3 October 2024</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| "adapter" => "PostgreSQL"</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/SearchLight.jl/blob/100cea89b6dc3a4a938ad3563872e3bc59cb084e/src/Configuration.jl#L32-L50">source</a></section></article><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>load</code>. Check Documenter's build log for details.</p></div></div><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="SearchLight.Configuration.Settings" href="#SearchLight.Configuration.Settings"><code>SearchLight.Configuration.Settings</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">mutable struct Settings</code></pre><p>App configuration - sets up the app's defaults. Individual options are overwritten in the corresponding environment file.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/SearchLight.jl/blob/100cea89b6dc3a4a938ad3563872e3bc59cb084e/src/Configuration.jl#L98-L102">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="callbacks.html">« Callbacks</a><a class="docs-footer-nextpage" href="exceptions.html">Exceptions »</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="Thursday 3 October 2024 09:19">Thursday 3 October 2024</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.