Current section
Files
Jump to
Current section
Files
doc/conditions.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.29.4">
<meta name="project" content="ecto_entity v1.0.0">
<title>Conditions — ecto_entity v1.0.0</title>
<link rel="stylesheet" href="dist/html-elixir-HHVY3JYD.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-XWGFFSCD.js"></script>
<script src="dist/sidebar_items-374D99DB.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-JDI3AVDD.js"></script>
</head>
<body data-type="extras" class="page-extra">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="readme.html" class="sidebar-projectName" translate="no">
ecto_entity
</a>
<div class="sidebar-projectVersion" translate="no">
v1.0.0
</div>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="icon-action display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<a href="https://github.com/kamaroly/ecto_entity/blob/main/guides/howtos/Conditions.md#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span>Conditions</span>
</h1>
<p>Conditions help you to retrieve data based on the specific conditions. You may do it using where condition.</p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)> </span><span class="nc">Person</span><span class="o">.</span><span class="n">where</span><span class="p" data-group-id="9926594655-1">(</span><span class="ss">:first_name</span><span class="p">,</span><span class="w"> </span><span class="s">"Kamaro"</span><span class="p" data-group-id="9926594655-1">)</span><span class="w">
</span><span class="p" data-group-id="9926594655-2">#</span><span class="nc" data-group-id="9926594655-2">Ecto.Query</span><span class="p" data-group-id="9926594655-2"><</span><span class="n">from</span><span class="w"> </span><span class="n">p0</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="nc">Person</span><span class="p">,</span><span class="w"> </span><span class="ss">where</span><span class="p">:</span><span class="w"> </span><span class="n">p0</span><span class="o">.</span><span class="n">first_name</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="o">^</span><span class="s">"Kamaro"</span><span class="p" data-group-id="9926594655-2">></span></code></pre><p>You may return the first entry that matches the provided where condition like the following:</p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)> </span><span class="nc">Person</span><span class="o">.</span><span class="n">where_first</span><span class="p" data-group-id="5326893873-1">(</span><span class="ss">:first_name</span><span class="p">,</span><span class="w"> </span><span class="s">"Dominic"</span><span class="p" data-group-id="5326893873-1">)</span><span class="w">
</span><span class="p" data-group-id="5326893873-2">%</span><span class="nc" data-group-id="5326893873-2">Person</span><span class="p" data-group-id="5326893873-2">{</span><span class="w">
</span><span class="ss">__meta__</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5326893873-3">#</span><span class="nc" data-group-id="5326893873-3">Ecto.Schema.Metadata</span><span class="p" data-group-id="5326893873-3"><</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">"people"</span><span class="p" data-group-id="5326893873-3">></span><span class="p">,</span><span class="w">
</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="mi">42</span><span class="p">,</span><span class="w">
</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Dominic"</span><span class="p">,</span><span class="w">
</span><span class="ss">last_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Cummings"</span><span class="p">,</span><span class="w">
</span><span class="ss">age</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="w">
</span><span class="p" data-group-id="5326893873-2">}</span></code></pre><p>Or return all entries that matches a given condition like the following:</p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)> </span><span class="nc">Person</span><span class="o">.</span><span class="n">where_all</span><span class="p" data-group-id="9396458693-1">(</span><span class="ss">:age</span><span class="p">,</span><span class="w"> </span><span class="mi">6</span><span class="p" data-group-id="9396458693-1">)</span><span class="w">
</span><span class="p" data-group-id="9396458693-2">[</span><span class="w">
</span><span class="p" data-group-id="9396458693-3">%</span><span class="nc" data-group-id="9396458693-3">Person</span><span class="p" data-group-id="9396458693-3">{</span><span class="w">
</span><span class="ss">__meta__</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9396458693-4">#</span><span class="nc" data-group-id="9396458693-4">Ecto.Schema.Metadata</span><span class="p" data-group-id="9396458693-4"><</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">"people"</span><span class="p" data-group-id="9396458693-4">></span><span class="p">,</span><span class="w">
</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="mi">9</span><span class="p">,</span><span class="w">
</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Kihn"</span><span class="p">,</span><span class="w">
</span><span class="ss">last_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Graham"</span><span class="p">,</span><span class="w">
</span><span class="ss">age</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="w">
</span><span class="p" data-group-id="9396458693-3">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="9396458693-5">%</span><span class="nc" data-group-id="9396458693-5">Person</span><span class="p" data-group-id="9396458693-5">{</span><span class="w">
</span><span class="ss">__meta__</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9396458693-6">#</span><span class="nc" data-group-id="9396458693-6">Ecto.Schema.Metadata</span><span class="p" data-group-id="9396458693-6"><</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">"people"</span><span class="p" data-group-id="9396458693-6">></span><span class="p">,</span><span class="w">
</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="mi">15</span><span class="p">,</span><span class="w">
</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Cummerata"</span><span class="p">,</span><span class="w">
</span><span class="ss">last_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Altenwerth"</span><span class="p">,</span><span class="w">
</span><span class="ss">age</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="w">
</span><span class="p" data-group-id="9396458693-5">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="9396458693-7">%</span><span class="nc" data-group-id="9396458693-7">Person</span><span class="p" data-group-id="9396458693-7">{</span><span class="w">
</span><span class="ss">__meta__</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9396458693-8">#</span><span class="nc" data-group-id="9396458693-8">Ecto.Schema.Metadata</span><span class="p" data-group-id="9396458693-8"><</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">"people"</span><span class="p" data-group-id="9396458693-8">></span><span class="p">,</span><span class="w">
</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="mi">37</span><span class="p">,</span><span class="w">
</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Pollich"</span><span class="p">,</span><span class="w">
</span><span class="ss">last_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Crist"</span><span class="p">,</span><span class="w">
</span><span class="ss">age</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="w">
</span><span class="p" data-group-id="9396458693-7">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="9396458693-9">%</span><span class="nc" data-group-id="9396458693-9">Person</span><span class="p" data-group-id="9396458693-9">{</span><span class="w">
</span><span class="ss">__meta__</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9396458693-10">#</span><span class="nc" data-group-id="9396458693-10">Ecto.Schema.Metadata</span><span class="p" data-group-id="9396458693-10"><</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">"people"</span><span class="p" data-group-id="9396458693-10">></span><span class="p">,</span><span class="w">
</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="mi">39</span><span class="p">,</span><span class="w">
</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Daugherty"</span><span class="p">,</span><span class="w">
</span><span class="ss">last_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Mills"</span><span class="p">,</span><span class="w">
</span><span class="ss">age</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="w">
</span><span class="p" data-group-id="9396458693-9">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="9396458693-11">%</span><span class="nc" data-group-id="9396458693-11">Person</span><span class="p" data-group-id="9396458693-11">{</span><span class="w">
</span><span class="ss">__meta__</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9396458693-12">#</span><span class="nc" data-group-id="9396458693-12">Ecto.Schema.Metadata</span><span class="p" data-group-id="9396458693-12"><</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">"people"</span><span class="p" data-group-id="9396458693-12">></span><span class="p">,</span><span class="w">
</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="mi">41</span><span class="p">,</span><span class="w">
</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Alfonso"</span><span class="p">,</span><span class="w">
</span><span class="ss">last_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Nitzsche"</span><span class="p">,</span><span class="w">
</span><span class="ss">age</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="w">
</span><span class="p" data-group-id="9396458693-11">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="9396458693-13">%</span><span class="nc" data-group-id="9396458693-13">Person</span><span class="p" data-group-id="9396458693-13">{</span><span class="w">
</span><span class="ss">__meta__</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9396458693-14">#</span><span class="nc" data-group-id="9396458693-14">Ecto.Schema.Metadata</span><span class="p" data-group-id="9396458693-14"><</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">"people"</span><span class="p" data-group-id="9396458693-14">></span><span class="p">,</span><span class="w">
</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="mi">42</span><span class="p">,</span><span class="w">
</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Dominic"</span><span class="p">,</span><span class="w">
</span><span class="ss">last_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Cummings"</span><span class="p">,</span><span class="w">
</span><span class="ss">age</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="w">
</span><span class="p" data-group-id="9396458693-13">}</span><span class="w">
</span><span class="p" data-group-id="9396458693-2">]</span><span class="w"> </span></code></pre>
<div class="bottom-actions">
<div class="bottom-actions-item">
<a href="association.html" class="bottom-actions-button" rel="prev">
<span class="subheader">
← Previous Page
</span>
<span class="title">
Associations
</span>
</a>
</div>
<div class="bottom-actions-item">
<a href="db.html" class="bottom-actions-button" rel="next">
<span class="subheader">
Next Page →
</span>
<span class="title">
DB
</span>
</a>
</div>
</div>
<footer class="footer">
<p>
<span class="line">
<a href="https://hex.pm/packages/ecto_entity/1.0.0" class="footer-hex-package">Hex Package</a>
<a href="https://preview.hex.pm/preview/ecto_entity/1.0.0">Hex Preview</a>
(<a href="https://preview.hex.pm/preview/ecto_entity/1.0.0/show/guides/howtos/Conditions.md">current file</a>)
</span>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="ecto_entity.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.29.4) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>