Current section
Files
Jump to
Current section
Files
doc/delete.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>Delete — 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/Delete.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>Delete</span>
</h1>
<h2 id="delete-1" class="section-heading">
<a href="#delete-1" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">delete-1</p>
</a>
<code class="inline">delete/1</code>
</h2>
<p>You may use <code class="inline">delete/1</code> or <code class="inline">destroy/1</code> to delete an existing table entry identifies by its 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">delete</span><span class="p" data-group-id="5966604896-1">(</span><span class="mi">7</span><span class="p" data-group-id="5966604896-1">)</span><span class="w">
</span><span class="p" data-group-id="5966604896-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="5966604896-3">%</span><span class="nc" data-group-id="5966604896-3">Person</span><span class="p" data-group-id="5966604896-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="5966604896-4">#</span><span class="nc" data-group-id="5966604896-4">Ecto.Schema.Metadata</span><span class="p" data-group-id="5966604896-4"><</span><span class="ss">:deleted</span><span class="p">,</span><span class="w"> </span><span class="s">"people"</span><span class="p" data-group-id="5966604896-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">7</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">"Glover"</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">"Schimmel"</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">2</span><span class="w">
</span><span class="p" data-group-id="5966604896-3">}</span><span class="p" data-group-id="5966604896-2">}</span></code></pre><p><code class="inline">delete/1</code> works the same as <code class="inline">destroy/1</code>. It's just a preference in pronunciation. </p><p>if you want to delete all table entries, you may <code class="inline">delete/0</code></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">destroy</span><span class="p" data-group-id="2074507339-1">(</span><span class="mi">2</span><span class="p" data-group-id="2074507339-1">)</span><span class="w">
</span><span class="p" data-group-id="2074507339-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="2074507339-3">%</span><span class="nc" data-group-id="2074507339-3">Person</span><span class="p" data-group-id="2074507339-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="2074507339-4">#</span><span class="nc" data-group-id="2074507339-4">Ecto.Schema.Metadata</span><span class="p" data-group-id="2074507339-4"><</span><span class="ss">:deleted</span><span class="p">,</span><span class="w"> </span><span class="s">"people"</span><span class="p" data-group-id="2074507339-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">2</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">"Ruecker"</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">"Lemke"</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">0</span><span class="w">
</span><span class="p" data-group-id="2074507339-3">}</span><span class="p" data-group-id="2074507339-2">}</span></code></pre><p>You may want to delete many records at once. You can do so by passing a list of the ids like the following. When you pass a list of ids to delete or destroy, Ecto.entity return {count_of_deleted_entities, nil}</p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(2)> </span><span class="nc">Person</span><span class="o">.</span><span class="n">delete</span><span class="p" data-group-id="5633134871-1">(</span><span class="p" data-group-id="5633134871-2">[</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">6</span><span class="p" data-group-id="5633134871-2">]</span><span class="p" data-group-id="5633134871-1">)</span><span class="w">
</span><span class="p" data-group-id="5633134871-3">{</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="5633134871-3">}</span></code></pre><h2 id="delete_except-1" class="section-heading">
<a href="#delete_except-1" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">delete_except-1</p>
</a>
<code class="inline">delete_except/1</code>
</h2>
<p>You may wish to delete entries with exception using <code class="inline">delete_except/</code> or <code class="inline">destroy_except/</code></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">delete_except</span><span class="p" data-group-id="8961700319-1">(</span><span class="p" data-group-id="8961700319-2">[</span><span class="mi">47</span><span class="p">,</span><span class="w"> </span><span class="mi">48</span><span class="p" data-group-id="8961700319-2">]</span><span class="p" data-group-id="8961700319-1">)</span><span class="w">
</span><span class="p" data-group-id="8961700319-3">{</span><span class="mi">48</span><span class="p">,</span><span class="w"> </span><span class="no">nil</span><span class="p" data-group-id="8961700319-3">}</span><span class="w">
</span><span class="gp unselectable">iex(2)> </span><span class="nc">Person</span><span class="o">.</span><span class="n">all</span><span class="p" data-group-id="8961700319-4">(</span><span class="p" data-group-id="8961700319-4">)</span><span class="w">
</span><span class="p" data-group-id="8961700319-5">[</span><span class="w">
</span><span class="p" data-group-id="8961700319-6">%</span><span class="nc" data-group-id="8961700319-6">Person</span><span class="p" data-group-id="8961700319-6">{</span><span class="w">
</span><span class="ss">__meta__</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="8961700319-7">#</span><span class="nc" data-group-id="8961700319-7">Ecto.Schema.Metadata</span><span class="p" data-group-id="8961700319-7"><</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="8961700319-7">></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">47</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">"Toy"</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">"Weimann"</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">3</span><span class="w">
</span><span class="p" data-group-id="8961700319-6">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="8961700319-8">%</span><span class="nc" data-group-id="8961700319-8">Person</span><span class="p" data-group-id="8961700319-8">{</span><span class="w">
</span><span class="ss">__meta__</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="8961700319-9">#</span><span class="nc" data-group-id="8961700319-9">Ecto.Schema.Metadata</span><span class="p" data-group-id="8961700319-9"><</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="8961700319-9">></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">48</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">"Wilderman"</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">"Treutel"</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">9</span><span class="w">
</span><span class="p" data-group-id="8961700319-8">}</span><span class="w">
</span><span class="p" data-group-id="8961700319-5">]</span></code></pre><h2 id="truncate-0" class="section-heading">
<a href="#truncate-0" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">truncate-0</p>
</a>
<code class="inline">truncate/0</code>
</h2>
<p>You may truncate a database table by <code class="inline">truncate/0</code>. <code class="inline">truncate</code> delete all entries and reset the table index.</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">truncate</span><span class="p" data-group-id="6318919582-1">(</span><span class="p" data-group-id="6318919582-1">)</span><span class="w">
</span><span class="p" data-group-id="6318919582-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="6318919582-3">%</span><span class="nc" data-group-id="6318919582-3">MyXQL.Result</span><span class="p" data-group-id="6318919582-3">{</span><span class="w">
</span><span class="ss">columns</span><span class="p">:</span><span class="w"> </span><span class="no">nil</span><span class="p">,</span><span class="w">
</span><span class="ss">connection_id</span><span class="p">:</span><span class="w"> </span><span class="mi">788</span><span class="p">,</span><span class="w">
</span><span class="ss">last_insert_id</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="ss">num_rows</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="ss">rows</span><span class="p">:</span><span class="w"> </span><span class="no">nil</span><span class="p">,</span><span class="w">
</span><span class="ss">num_warnings</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
</span><span class="p" data-group-id="6318919582-3">}</span><span class="p" data-group-id="6318919582-2">}</span></code></pre>
<div class="bottom-actions">
<div class="bottom-actions-item">
<a href="update.html" class="bottom-actions-button" rel="prev">
<span class="subheader">
← Previous Page
</span>
<span class="title">
Update
</span>
</a>
</div>
<div class="bottom-actions-item">
<a href="association.html" class="bottom-actions-button" rel="next">
<span class="subheader">
Next Page →
</span>
<span class="title">
Associations
</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/Delete.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>