Current section
Files
Jump to
Current section
Files
doc/update.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 v0.1.4">
<title>Update — ecto_entity v0.1.4</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-35F8C836.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">
v0.1.4
</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/Update.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>Update</span>
</h1>
<p>Updates an existing entry</p><h2 id="update-2" class="section-heading">
<a href="#update-2" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">update-2</p>
</a>
<code class="inline">update/2</code>
</h2>
<p>Updates an existing record identified by an ID</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">update</span><span class="p" data-group-id="2680459902-1">(</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="2680459902-2">%{</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="2680459902-2">}</span><span class="p" data-group-id="2680459902-1">)</span><span class="w">
</span><span class="p" data-group-id="2680459902-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="2680459902-4">%</span><span class="nc" data-group-id="2680459902-4">Person</span><span class="p" data-group-id="2680459902-4">{</span><span class="w">
</span><span class="ss">__meta__</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="2680459902-5">#</span><span class="nc" data-group-id="2680459902-5">Ecto.Schema.Metadata</span><span class="p" data-group-id="2680459902-5"><</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="2680459902-5">></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">1</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">"Kamaro"</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">"Yundt"</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">7</span><span class="w">
</span><span class="p" data-group-id="2680459902-4">}</span><span class="p" data-group-id="2680459902-3">}</span></code></pre><p>Updates an existing record identified by its Schema(Model)</p><pre><code class="makeup elixir" translate="no"><span class="c1"># Find a person by id 1</span><span class="w">
</span><span class="gp unselectable">iex(1)> </span><span class="n">person</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Person</span><span class="o">.</span><span class="n">find</span><span class="p" data-group-id="1265747637-1">(</span><span class="mi">1</span><span class="p" data-group-id="1265747637-1">)</span><span class="w">
</span><span class="p" data-group-id="1265747637-2">%</span><span class="nc" data-group-id="1265747637-2">Person</span><span class="p" data-group-id="1265747637-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="1265747637-3">#</span><span class="nc" data-group-id="1265747637-3">Ecto.Schema.Metadata</span><span class="p" data-group-id="1265747637-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="1265747637-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">1</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">"Weber"</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">"Ok 2"</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">7</span><span class="w">
</span><span class="p" data-group-id="1265747637-2">}</span><span class="w">
</span><span class="gp unselectable">iex(2)> </span><span class="nc">Person</span><span class="o">.</span><span class="n">update</span><span class="p" data-group-id="1265747637-4">(</span><span class="n">person</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1265747637-5">%{</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="1265747637-5">}</span><span class="p" data-group-id="1265747637-4">)</span><span class="w">
</span><span class="p" data-group-id="1265747637-6">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="1265747637-7">%</span><span class="nc" data-group-id="1265747637-7">Person</span><span class="p" data-group-id="1265747637-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="1265747637-8">#</span><span class="nc" data-group-id="1265747637-8">Ecto.Schema.Metadata</span><span class="p" data-group-id="1265747637-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="1265747637-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">1</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">"Kamaro"</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">"Ok 2"</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">7</span><span class="w">
</span><span class="p" data-group-id="1265747637-7">}</span><span class="p" data-group-id="1265747637-6">}</span></code></pre><h2 id="update_many-1" class="section-heading">
<a href="#update_many-1" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">update_many-1</p>
</a>
<code class="inline">update_many/1</code>
</h2>
<p>You may update many entries at once using <code class="inline">update_many/2</code> like the following</p><pre><code class="makeup elixir" translate="no"><span class="w">
</span><span class="gp unselectable">iex(1)> </span><span class="n">query</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Person</span><span class="o">.</span><span class="n">not_in_ids</span><span class="p" data-group-id="2815789561-1">(</span><span class="mi">1</span><span class="p" data-group-id="2815789561-1">)</span><span class="w">
</span><span class="p" data-group-id="2815789561-2">#</span><span class="nc" data-group-id="2815789561-2">Ecto.Query</span><span class="p" data-group-id="2815789561-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">id</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="o">^</span><span class="p" data-group-id="2815789561-3">[</span><span class="mi">1</span><span class="p" data-group-id="2815789561-3">]</span><span class="p" data-group-id="2815789561-2">></span><span class="w">
</span><span class="gp unselectable">iex(2)></span><span class="nc">Person</span><span class="o">.</span><span class="n">update_many</span><span class="p" data-group-id="2815789561-4">(</span><span class="n">query</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="2815789561-5">[</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Kamaro Paul"</span><span class="p" data-group-id="2815789561-5">]</span><span class="p" data-group-id="2815789561-4">)</span><span class="w">
</span><span class="p" data-group-id="2815789561-6">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="2815789561-7">%{</span><span class="ss">update_all</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="2815789561-8">{</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="no">nil</span><span class="p" data-group-id="2815789561-8">}</span><span class="p" data-group-id="2815789561-7">}</span><span class="p" data-group-id="2815789561-6">}</span></code></pre>
<div class="bottom-actions">
<div class="bottom-actions-item">
<a href="read.html" class="bottom-actions-button" rel="prev">
<span class="subheader">
← Previous Page
</span>
<span class="title">
Read
</span>
</a>
</div>
<div class="bottom-actions-item">
<a href="delete.html" class="bottom-actions-button" rel="next">
<span class="subheader">
Next Page →
</span>
<span class="title">
Delete
</span>
</a>
</div>
</div>
<footer class="footer">
<p>
<span class="line">
<a href="https://hex.pm/packages/ecto_entity/0.1.4" class="footer-hex-package">Hex Package</a>
<a href="https://preview.hex.pm/preview/ecto_entity/0.1.4">Hex Preview</a>
(<a href="https://preview.hex.pm/preview/ecto_entity/0.1.4/show/guides/howtos/Update.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>