Packages

ecto_entity

1.0.1
1.0.1 1.0.0 0.1.4 0.1.3 0.1.2 0.1.1

An Elixir Ecto Package to Boost Your Productivity and Achieve 90% throughput in Just 10% of the Time.

HexDocs

Current section

Files

Jump to
Readme
6 Versions
5 Dependencies
Dependants
Files
Activity
ecto_entity doc crud.html
Raw

doc/crud.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.1">



    <title>CRUD Cheatsheet — ecto_entity v1.0.1</title>

    <link rel="stylesheet" href="dist/html-elixir-HHVY3JYD.css" />



      <style>@media print { @page { size: landscape; } }</style>





    <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-cheatmd">

    <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.1

      </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/cheatsheets/CRUD.cheatmd#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>





    <button onclick="window.print()" title="Print Cheatsheet" class="icon-action" rel="print">

      <i class="ri-printer-line" aria-hidden="true"></i>

      <span class="sr-only">Print cheatsheet</span>

    </button>



  <span>CRUD Cheatsheet</span>

</h1>



<p>Assume that your schema looks like the following:</p><pre><code class="makeup elixir" translate="no"><span class="w">  </span><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.Person</span><span class="w"> </span><span class="k" data-group-id="5891040674-1">do</span><span class="w">

    </span><span class="kn">import</span><span class="w"> </span><span class="nc">Ecto.Changeset</span><span class="w">

    </span><span class="kn">use</span><span class="w"> </span><span class="nc">Ecto.Schema</span><span class="w">

    </span><span class="kn">use</span><span class="w"> </span><span class="nc">Ecto.Entity</span><span class="w"> </span><span class="c1"># Gems brought by the Ecto Entity</span><span class="w">



    </span><span class="n">schema</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="w"> </span><span class="k" data-group-id="5891040674-2">do</span><span class="w">

      </span><span class="n">field</span><span class="w"> </span><span class="ss">:first_name</span><span class="p">,</span><span class="w"> </span><span class="ss">:string</span><span class="w">

      </span><span class="n">field</span><span class="w"> </span><span class="ss">:last_name</span><span class="p">,</span><span class="w"> </span><span class="ss">:string</span><span class="w">

      </span><span class="n">field</span><span class="w"> </span><span class="ss">:age</span><span class="p">,</span><span class="w"> </span><span class="ss">:integer</span><span class="w">

    </span><span class="k" data-group-id="5891040674-2">end</span><span class="w">



    </span><span class="kd">def</span><span class="w"> </span><span class="nf">changeset</span><span class="p" data-group-id="5891040674-3">(</span><span class="n">entity</span><span class="p">,</span><span class="w"> </span><span class="n">attrs</span><span class="p" data-group-id="5891040674-3">)</span><span class="w"> </span><span class="k" data-group-id="5891040674-4">do</span><span class="w">

      </span><span class="n">entity</span><span class="w">

      </span><span class="o">|&gt;</span><span class="w"> </span><span class="n">cast</span><span class="p" data-group-id="5891040674-5">(</span><span class="n">attrs</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5891040674-6">[</span><span class="ss">:first_name</span><span class="p">,</span><span class="w"> </span><span class="ss">:last_name</span><span class="p" data-group-id="5891040674-6">]</span><span class="p" data-group-id="5891040674-5">)</span><span class="w">

      </span><span class="o">|&gt;</span><span class="w"> </span><span class="n">validate_required</span><span class="p" data-group-id="5891040674-7">(</span><span class="p" data-group-id="5891040674-8">[</span><span class="ss">:first_name</span><span class="p">,</span><span class="w"> </span><span class="ss">:last_name</span><span class="p" data-group-id="5891040674-8">]</span><span class="p" data-group-id="5891040674-7">)</span><span class="w">

    </span><span class="k" data-group-id="5891040674-4">end</span><span class="w">

  </span><span class="k" data-group-id="5891040674-1">end</span></code></pre><section class="h2 col-2"><h2 id="create" class="col-2 section-heading">

  <a href="#create" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">create</p>

  </a>

  CREATE

</h2>

<section class="h3"><h3 id="create-insert-new-records" class="section-heading">

  <a href="#create-insert-new-records" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">create-insert-new-records</p>

  </a>

  Create / Insert new records

</h3>

<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)&gt; </span><span class="nc">MyApp.Person</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="8328592315-1">(</span><span class="p" data-group-id="8328592315-2">%{</span><span class="w">

</span><span class="n">...</span><span class="w">  </span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Hand&quot;</span><span class="p">,</span><span class="w"> 

</span><span class="n">...</span><span class="w">  </span><span class="ss">last_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Turner&quot;</span><span class="p">,</span><span class="w"> 

</span><span class="n">...</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="8328592315-2">}</span><span class="p" data-group-id="8328592315-1">)</span><span class="w">

</span><span class="p" data-group-id="8328592315-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w">

 </span><span class="p" data-group-id="8328592315-4">%</span><span class="nc" data-group-id="8328592315-4">Person</span><span class="p" data-group-id="8328592315-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="8328592315-5">#</span><span class="nc" data-group-id="8328592315-5">Ecto.Schema.Metadata</span><span class="p" data-group-id="8328592315-5">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="8328592315-5">&gt;</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">5</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">&quot;Hand&quot;</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">&quot;Turner&quot;</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="8328592315-4">}</span><span class="p" data-group-id="8328592315-3">}</span></code></pre></section><section class="h3"><h3 id="create-many" class="section-heading">

  <a href="#create-many" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">create-many</p>

  </a>

  Create Many

</h3>

<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)&gt; </span><span class="nc">MyApp.Person</span><span class="o">.</span><span class="n">create_many</span><span class="p" data-group-id="5034310355-1">(</span><span class="p" data-group-id="5034310355-2">[</span><span class="w">

</span><span class="n">...</span><span class="w">  </span><span class="p" data-group-id="5034310355-3">%{</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Parisian&quot;</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">&quot;Beier&quot;</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="p" data-group-id="5034310355-3">}</span><span class="p">,</span><span class="w">

</span><span class="n">...</span><span class="w">  </span><span class="p" data-group-id="5034310355-4">%{</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Lang&quot;</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">&quot;Emard&quot;</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="p" data-group-id="5034310355-4">}</span><span class="w">

</span><span class="p" data-group-id="5034310355-2">]</span><span class="p" data-group-id="5034310355-1">)</span><span class="w">

</span><span class="p" data-group-id="5034310355-5">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5034310355-6">%{</span><span class="ss">insert_all</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5034310355-7">{</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="5034310355-7">}</span><span class="p" data-group-id="5034310355-6">}</span><span class="p" data-group-id="5034310355-5">}</span></code></pre></section></section><section class="h2 col-2"><h2 id="read" class="col-2 section-heading">

  <a href="#read" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">read</p>

  </a>

  READ

</h2>

<section class="h3"><h3 id="retrieve-all-entries" class="section-heading">

  <a href="#retrieve-all-entries" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">retrieve-all-entries</p>

  </a>

  Retrieve all entries

</h3>

<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)&gt; </span><span class="nc">MyApp.Person</span><span class="o">.</span><span class="n">all</span><span class="p" data-group-id="8938386382-1">(</span><span class="p" data-group-id="8938386382-1">)</span><span class="w">

</span><span class="p" data-group-id="8938386382-2">[</span><span class="w">

    </span><span class="p" data-group-id="8938386382-3">%</span><span class="nc" data-group-id="8938386382-3">Person</span><span class="p" data-group-id="8938386382-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="8938386382-4">#</span><span class="nc" data-group-id="8938386382-4">Ecto.Schema.Metadata</span><span class="p" data-group-id="8938386382-4">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="8938386382-4">&gt;</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">&quot;German&quot;</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">&quot;OConnell&quot;</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="8938386382-3">}</span><span class="p">,</span><span class="w">

    </span><span class="p" data-group-id="8938386382-5">%</span><span class="nc" data-group-id="8938386382-5">Person</span><span class="p" data-group-id="8938386382-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="8938386382-6">#</span><span class="nc" data-group-id="8938386382-6">Ecto.Schema.Metadata</span><span class="p" data-group-id="8938386382-6">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="8938386382-6">&gt;</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">&quot;Fritsch&quot;</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">&quot;Kassulke&quot;</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">8</span><span class="w">

    </span><span class="p" data-group-id="8938386382-5">}</span><span class="p">,</span><span class="w">

    </span><span class="p" data-group-id="8938386382-7">%</span><span class="nc" data-group-id="8938386382-7">Person</span><span class="p" data-group-id="8938386382-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="8938386382-8">#</span><span class="nc" data-group-id="8938386382-8">Ecto.Schema.Metadata</span><span class="p" data-group-id="8938386382-8">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="8938386382-8">&gt;</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">3</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">&quot;Russel&quot;</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">&quot;Collins&quot;</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="8938386382-7">}</span><span class="w">

</span><span class="p" data-group-id="8938386382-2">]</span></code></pre></section><section class="h3"><h3 id="finding-an-entry-by-id" class="section-heading">

  <a href="#finding-an-entry-by-id" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">finding-an-entry-by-id</p>

  </a>

  Finding an entry by ID

</h3>

<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)&gt; </span><span class="nc">MyApp.Person</span><span class="o">.</span><span class="n">find</span><span class="p" data-group-id="8230403388-1">(</span><span class="mi">5</span><span class="p" data-group-id="8230403388-1">)</span><span class="w">

</span><span class="p" data-group-id="8230403388-2">%</span><span class="nc" data-group-id="8230403388-2">Person</span><span class="p" data-group-id="8230403388-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="8230403388-3">#</span><span class="nc" data-group-id="8230403388-3">Ecto.Schema.Metadata</span><span class="p" data-group-id="8230403388-3">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="8230403388-3">&gt;</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">5</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">&quot;Kristopher&quot;</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">&quot;Keeling&quot;</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="8230403388-2">}</span></code></pre></section><section class="h3"><h3 id="retrieve-many-by-identifiers" class="section-heading">

  <a href="#retrieve-many-by-identifiers" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">retrieve-many-by-identifiers</p>

  </a>

  Retrieve many by identifiers

</h3>

<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)&gt; </span><span class="nc">Person</span><span class="o">.</span><span class="n">find</span><span class="p" data-group-id="1774533589-1">(</span><span class="p" data-group-id="1774533589-2">[</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p" data-group-id="1774533589-2">]</span><span class="p" data-group-id="1774533589-1">)</span><span class="w">

</span><span class="p" data-group-id="1774533589-3">[</span><span class="w">

  </span><span class="p" data-group-id="1774533589-4">%</span><span class="nc" data-group-id="1774533589-4">Person</span><span class="p" data-group-id="1774533589-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="1774533589-5">#</span><span class="nc" data-group-id="1774533589-5">Ecto.Schema.Metadata</span><span class="p" data-group-id="1774533589-5">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="1774533589-5">&gt;</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">&quot;Bruen&quot;</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">&quot;Sporer&quot;</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="1774533589-4">}</span><span class="p">,</span><span class="w">

  </span><span class="p" data-group-id="1774533589-6">%</span><span class="nc" data-group-id="1774533589-6">Person</span><span class="p" data-group-id="1774533589-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="1774533589-7">#</span><span class="nc" data-group-id="1774533589-7">Ecto.Schema.Metadata</span><span class="p" data-group-id="1774533589-7">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="1774533589-7">&gt;</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">&quot;Herman&quot;</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">&quot;Jerde&quot;</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="1774533589-6">}</span><span class="p">,</span><span class="w">

  </span><span class="p" data-group-id="1774533589-8">%</span><span class="nc" data-group-id="1774533589-8">Person</span><span class="p" data-group-id="1774533589-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="1774533589-9">#</span><span class="nc" data-group-id="1774533589-9">Ecto.Schema.Metadata</span><span class="p" data-group-id="1774533589-9">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="1774533589-9">&gt;</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">3</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">&quot;Macey&quot;</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">&quot;Treutel&quot;</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="1774533589-8">}</span><span class="w">

</span><span class="p" data-group-id="1774533589-3">]</span></code></pre></section><section class="h3"><h3 id="retrieve-a-number-of-entries" class="section-heading">

  <a href="#retrieve-a-number-of-entries" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">retrieve-a-number-of-entries</p>

  </a>

  Retrieve a number of entries

</h3>

<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)&gt; </span><span class="nc">Person</span><span class="o">.</span><span class="n">take</span><span class="p" data-group-id="2257886025-1">(</span><span class="mi">2</span><span class="p" data-group-id="2257886025-1">)</span><span class="w">

  </span><span class="p" data-group-id="2257886025-2">[</span><span class="w">

  </span><span class="p" data-group-id="2257886025-3">%</span><span class="nc" data-group-id="2257886025-3">Person</span><span class="p" data-group-id="2257886025-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="2257886025-4">#</span><span class="nc" data-group-id="2257886025-4">Ecto.Schema.Metadata</span><span class="p" data-group-id="2257886025-4">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="2257886025-4">&gt;</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">&quot;German&quot;</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">&quot;OConnell&quot;</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="2257886025-3">}</span><span class="p">,</span><span class="w">

  </span><span class="p" data-group-id="2257886025-5">%</span><span class="nc" data-group-id="2257886025-5">Person</span><span class="p" data-group-id="2257886025-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="2257886025-6">#</span><span class="nc" data-group-id="2257886025-6">Ecto.Schema.Metadata</span><span class="p" data-group-id="2257886025-6">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="2257886025-6">&gt;</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">&quot;Fritsch&quot;</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">&quot;Kassulke&quot;</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">8</span><span class="w">

  </span><span class="p" data-group-id="2257886025-5">}</span><span class="w">

</span><span class="p" data-group-id="2257886025-2">]</span></code></pre></section></section><section class="h2 col-2"><h2 id="update" class="col-2 section-heading">

  <a href="#update" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">update</p>

  </a>

  UPDATE

</h2>

<section class="h3"><h3 id="update-a-record-by-identified-by-id" class="section-heading">

  <a href="#update-a-record-by-identified-by-id" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">update-a-record-by-identified-by-id</p>

  </a>

  Update a record by identified by ID

</h3>

<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)&gt; </span><span class="nc">Person</span><span class="o">.</span><span class="n">update</span><span class="p" data-group-id="8085140535-1">(</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8085140535-2">%{</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Kamaro&quot;</span><span class="p" data-group-id="8085140535-2">}</span><span class="p" data-group-id="8085140535-1">)</span><span class="w">

</span><span class="p" data-group-id="8085140535-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w">

</span><span class="p" data-group-id="8085140535-4">%</span><span class="nc" data-group-id="8085140535-4">Person</span><span class="p" data-group-id="8085140535-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="8085140535-5">#</span><span class="nc" data-group-id="8085140535-5">Ecto.Schema.Metadata</span><span class="p" data-group-id="8085140535-5">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="8085140535-5">&gt;</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">&quot;Kamaro&quot;</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">&quot;Yundt&quot;</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="8085140535-4">}</span><span class="p" data-group-id="8085140535-3">}</span></code></pre></section><section class="h3"><h3 id="update-many-records-at-once" class="section-heading">

  <a href="#update-many-records-at-once" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">update-many-records-at-once</p>

  </a>

  Update Many Records at once

</h3>

<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)&gt; </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="7402128520-1">(</span><span class="mi">1</span><span class="p" data-group-id="7402128520-1">)</span><span class="w">

</span><span class="p" data-group-id="7402128520-2">#</span><span class="nc" data-group-id="7402128520-2">Ecto.Query</span><span class="p" data-group-id="7402128520-2">&lt;</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="7402128520-3">[</span><span class="mi">1</span><span class="p" data-group-id="7402128520-3">]</span><span class="p" data-group-id="7402128520-2">&gt;</span><span class="w">

</span><span class="gp unselectable">iex(2)&gt; </span><span class="nc">Person</span><span class="o">.</span><span class="n">update_many</span><span class="p" data-group-id="7402128520-4">(</span><span class="n">query</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="7402128520-5">[</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Kamaro Paul&quot;</span><span class="p" data-group-id="7402128520-5">]</span><span class="p" data-group-id="7402128520-4">)</span><span class="w">

</span><span class="p" data-group-id="7402128520-6">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="7402128520-7">%{</span><span class="ss">update_all</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="7402128520-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="7402128520-8">}</span><span class="p" data-group-id="7402128520-7">}</span><span class="p" data-group-id="7402128520-6">}</span></code></pre></section><section class="h3"><h3 id="update-by-entity" class="section-heading">

  <a href="#update-by-entity" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">update-by-entity</p>

  </a>

  Update by entity

</h3>

<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)&gt; </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="6859556513-1">(</span><span class="mi">1</span><span class="p" data-group-id="6859556513-1">)</span><span class="w">

</span><span class="p" data-group-id="6859556513-2">%</span><span class="nc" data-group-id="6859556513-2">Person</span><span class="p" data-group-id="6859556513-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="6859556513-3">#</span><span class="nc" data-group-id="6859556513-3">Ecto.Schema.Metadata</span><span class="p" data-group-id="6859556513-3">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="6859556513-3">&gt;</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">&quot;Weber&quot;</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">&quot;Ok 2&quot;</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="6859556513-2">}</span><span class="w">

</span><span class="gp unselectable">iex(2)&gt; </span><span class="nc">Person</span><span class="o">.</span><span class="n">update</span><span class="p" data-group-id="6859556513-4">(</span><span class="n">person</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6859556513-5">%{</span><span class="ss">first_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Kamaro&quot;</span><span class="p" data-group-id="6859556513-5">}</span><span class="p" data-group-id="6859556513-4">)</span><span class="w">

  </span><span class="p" data-group-id="6859556513-6">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w">

  </span><span class="p" data-group-id="6859556513-7">%</span><span class="nc" data-group-id="6859556513-7">Person</span><span class="p" data-group-id="6859556513-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="6859556513-8">#</span><span class="nc" data-group-id="6859556513-8">Ecto.Schema.Metadata</span><span class="p" data-group-id="6859556513-8">&lt;</span><span class="ss">:loaded</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="6859556513-8">&gt;</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">&quot;Kamaro&quot;</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">&quot;Ok 2&quot;</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="6859556513-7">}</span><span class="p" data-group-id="6859556513-6">}</span></code></pre></section></section><section class="h2 col-2"><h2 id="delete" class="col-2 section-heading">

  <a href="#delete" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">delete</p>

  </a>

  DELETE

</h2>

<section class="h3"><h3 id="delete-an-entry" class="section-heading">

  <a href="#delete-an-entry" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">delete-an-entry</p>

  </a>

  Delete an entry

</h3>

<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)&gt; </span><span class="nc">Person</span><span class="o">.</span><span class="n">delete</span><span class="p" data-group-id="6566717761-1">(</span><span class="mi">7</span><span class="p" data-group-id="6566717761-1">)</span><span class="w">

</span><span class="p" data-group-id="6566717761-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w">

</span><span class="p" data-group-id="6566717761-3">%</span><span class="nc" data-group-id="6566717761-3">Person</span><span class="p" data-group-id="6566717761-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="6566717761-4">#</span><span class="nc" data-group-id="6566717761-4">Ecto.Schema.Metadata</span><span class="p" data-group-id="6566717761-4">&lt;</span><span class="ss">:deleted</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;people&quot;</span><span class="p" data-group-id="6566717761-4">&gt;</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">&quot;Glover&quot;</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">&quot;Schimmel&quot;</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="6566717761-3">}</span><span class="p" data-group-id="6566717761-2">}</span></code></pre></section><section class="h3"><h3 id="delete-entries-except-record-matching-ids" class="section-heading">

  <a href="#delete-entries-except-record-matching-ids" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">delete-entries-except-record-matching-ids</p>

  </a>

  Delete entries except record matching IDs

</h3>

<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)&gt; </span><span class="nc">Person</span><span class="o">.</span><span class="n">delete_except</span><span class="p" data-group-id="8382902064-1">(</span><span class="p" data-group-id="8382902064-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="8382902064-2">]</span><span class="p" data-group-id="8382902064-1">)</span><span class="w">

</span><span class="p" data-group-id="8382902064-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="8382902064-3">}</span></code></pre></section><section class="h3"><h3 id="empty-the-entire-table" class="section-heading">

  <a href="#empty-the-entire-table" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>

  <p class="sr-only">empty-the-entire-table</p>

  </a>

  Empty the entire table

</h3>

<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex(1)&gt; </span><span class="nc">Person</span><span class="o">.</span><span class="n">truncate</span><span class="p" data-group-id="8218599072-1">(</span><span class="p" data-group-id="8218599072-1">)</span><span class="w">

</span><span class="p" data-group-id="8218599072-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w">

 </span><span class="p" data-group-id="8218599072-3">%</span><span class="nc" data-group-id="8218599072-3">MyXQL.Result</span><span class="p" data-group-id="8218599072-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="8218599072-3">}</span><span class="p" data-group-id="8218599072-2">}</span></code></pre></section></section>

<div class="bottom-actions">

  <div class="bottom-actions-item">



      <a href="db.html" class="bottom-actions-button" rel="prev">

        <span class="subheader">

          ← Previous Page

        </span>

        <span class="title">

DB

        </span>

      </a>



  </div>

  <div class="bottom-actions-item">



      <a href="associations.html" class="bottom-actions-button" rel="next">

        <span class="subheader">

          Next Page →

        </span>

        <span class="title">

Association

        </span>

      </a>



  </div>

</div>

      <footer class="footer">

        <p>



            <span class="line">

              <a href="https://hex.pm/packages/ecto_entity/1.0.1" class="footer-hex-package">Hex Package</a>



              <a href="https://preview.hex.pm/preview/ecto_entity/1.0.1">Hex Preview</a>



                (<a href="https://preview.hex.pm/preview/ecto_entity/1.0.1/show/guides/cheatsheets/CRUD.cheatmd">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>