Current section
Files
Jump to
Current section
Files
doc/getting-started.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>Getting Started — ecto_entity v1.0.1</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.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/introduction/Getting Started.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>Getting Started</span>
</h1>
<p>This guide is an introduction to Ecto Entity, the missing Phoenix Ecto package to achieve +80% of common operations
less than 20% of effort it would normally take.
Ecto Entity provides a standardized API and a set of abstractions for interacting with database tables, so that your phoenix Elixir developers
can focus on what's specific to your project.</p><p>In this guide, we're going to learn some basics about Ecto Entity, such as creating,
reading, updating and destroying records from a database. If you want
to see the code from this guide, you can view it <a href="https://github.com/kamaroly/ecto_entity">at kamaroly/ecto_entity on GitHub</a>.</p><p><strong>This guide will require you to have setup Entity beforehand.</strong></p><h2 id="installation" class="section-heading">
<a href="#installation" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">installation</p>
</a>
Installation
</h2>
<p>To add Entity to your application, The first step is to add Entity to your <code class="inline">mix.exs</code> file,
which we'll do by changing the <code class="inline">deps</code> definition in that file to this:</p><pre><code class="makeup elixir" translate="no"><span class="w">
</span><span class="kd">defp</span><span class="w"> </span><span class="nf">deps</span><span class="w"> </span><span class="k" data-group-id="4640047021-1">do</span><span class="w">
</span><span class="p" data-group-id="4640047021-2">[</span><span class="w">
</span><span class="p" data-group-id="4640047021-3">{</span><span class="ss">:ecto_entity</span><span class="p">,</span><span class="w"> </span><span class="s">"~> 1.0.0"</span><span class="p" data-group-id="4640047021-3">}</span><span class="w">
</span><span class="p" data-group-id="4640047021-2">]</span><span class="w">
</span><span class="k" data-group-id="4640047021-1">end</span><span class="w">
</span></code></pre><p>Then, to install it, you will run this command:</p><pre><code class="makeup elixir" translate="no"><span class="n">mix</span><span class="w"> </span><span class="n">deps</span><span class="o">.</span><span class="n">get</span></code></pre><h2 id="configure-your-ecto-repo" class="section-heading">
<a href="#configure-your-ecto-repo" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">configure-your-ecto-repo</p>
</a>
Configure Your Ecto Repo
</h2>
<p>Ecto Entity needs to know what repository to use while running database query. To do that, add <code class="inline">config :ecto_entity, app_name: :your_app_name</code> to your <code class="inline">config/config.exs</code> file.
<code class="inline">:your_app_name</code> will be often the app configured in <code class="inline">mix.exs</code> under <code class="inline">project</code> > <code class="inline">app</code>.</p><pre><code class="makeup elixir" translate="no"><span class="kn">import</span><span class="w"> </span><span class="nc">Config</span><span class="w">
</span><span class="c1"># Configure your APP name so that Ecto Entity can know</span><span class="w">
</span><span class="c1"># What Ecto Repo to use for the entity</span><span class="w">
</span><span class="n">config</span><span class="w"> </span><span class="ss">:ecto_entity</span><span class="p">,</span><span class="w"> </span><span class="ss">app_name</span><span class="p">:</span><span class="w"> </span><span class="ss">:your_ecto_elixir_app_name</span><span class="w">
</span><span class="c1"># Configure you pub server like the following. Replace `:app_name` with your app name</span><span class="w">
</span><span class="n">config</span><span class="w"> </span><span class="ss">:app_name</span><span class="p">,</span><span class="w"> </span><span class="ss">pubsub_server</span><span class="p">:</span><span class="w"> </span><span class="nc">Ecto.Entity.PubSub</span></code></pre><h2 id="adding-entity-to-your-schema" class="section-heading">
<a href="#adding-entity-to-your-schema" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">adding-entity-to-your-schema</p>
</a>
Adding Entity To Your Schema
</h2>
<p>To start off with, we'll need to include <code class="inline">Entity</code> in our existing Phoenix Schema using <code class="inline">use Ecto.Entity</code> in your Schema module, 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="3993858928-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"># Include Entity in your normal schema</span><span class="w">
</span><span class="n">schema</span><span class="w"> </span><span class="s">"people"</span><span class="w"> </span><span class="k" data-group-id="3993858928-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="3993858928-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="3993858928-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="3993858928-3">)</span><span class="w"> </span><span class="k" data-group-id="3993858928-4">do</span><span class="w">
</span><span class="n">entity</span><span class="w">
</span><span class="o">|></span><span class="w"> </span><span class="n">cast</span><span class="p" data-group-id="3993858928-5">(</span><span class="n">attrs</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3993858928-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="3993858928-6">]</span><span class="p" data-group-id="3993858928-5">)</span><span class="w">
</span><span class="o">|></span><span class="w"> </span><span class="n">validate_required</span><span class="p" data-group-id="3993858928-7">(</span><span class="p" data-group-id="3993858928-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="3993858928-8">]</span><span class="p" data-group-id="3993858928-7">)</span><span class="w">
</span><span class="k" data-group-id="3993858928-4">end</span><span class="w">
</span><span class="k" data-group-id="3993858928-1">end</span></code></pre><blockquote><p>NOTE: You must define a <code class="inline">changeset/2</code> function to create and update your schema</p></blockquote>
<div class="bottom-actions">
<div class="bottom-actions-item">
<a href="changelog.html" class="bottom-actions-button" rel="prev">
<span class="subheader">
← Previous Page
</span>
<span class="title">
Changelog for v0.1.x
</span>
</a>
</div>
<div class="bottom-actions-item">
<a href="create.html" class="bottom-actions-button" rel="next">
<span class="subheader">
Next Page →
</span>
<span class="title">
Create
</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/introduction/Getting Started.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>