Ecto Schema and Database Migrations
Define Ecto schemas to map Elixir structs to database tables and manage schema changes with migrations.
Ecto Schema and Database Migrations is a free Elixir & Phoenix: Scalable Backend Development lesson on CoddyKit — lesson 1 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Elixir & Phoenix: Scalable Backend Development learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.
What is Ecto?
Welcome to Ecto! It's Elixir's powerful toolkit for interacting with databases. Think of it as your bridge between Elixir data and your database.
Ecto isn't a traditional Object-Relational Mapper (ORM). Instead, it's a data mapper. This means it focuses on mapping data between your Elixir application (using structs) and your database tables, giving you more control and less 'magic'.
Elixir Structs: Data Shapes
Before Ecto maps data to a database, Elixir uses structs to define data shapes. A struct is a special kind of map that ensures a predefined set of keys and default values.
Ecto schemas build upon this idea, extending structs to understand how their fields correspond to database columns.
Try running this simple struct example:
defmodule UserData do
defstruct name: "", age: 0, email: ""
end
# Create struct instances
user1 = %UserData{name: "Alice", age: 30}
user2 = %UserData{email: "bob@example.com"}
IO.puts "User 1: #{inspect user1}"
IO.puts "User 2: #{inspect user2}"
IO.puts "User 1's age: #{user1.age}"Defining an Ecto Schema
An Ecto schema is an Elixir module that describes how an Elixir struct maps to a database table. It defines the fields, their types, and any special options.
Here's how you'd define a basic User schema, mapping to a users table in your database:
defmodule MyApp.User do
use Ecto.Schema
schema "users" do
field :name, :string
field :email, :string
field :age, :integer
timestamps()
end
endCommon Schema Field Types
When defining fields in your schema, you specify their type. Ecto provides many common types that map directly to database types:
:string: For text data (e.g., names, emails).:integer: For whole numbers.:floator:decimal: For numbers with decimal points.:boolean: For true/false values.:datetimeor:naive_datetime: For date and time values.:binary: For raw binary data.
Choosing the right type helps Ecto validate data and create appropriate database columns.
Primary Keys & Timestamps
Ecto schemas automatically include a primary key, usually an id column of type :integer. You don't need to define it explicitly.
The timestamps() macro is super handy! It automatically adds two fields to your schema and database table:
:inserted_at: Stores when the record was created.:updated_at: Stores when the record was last modified.
These fields are crucial for tracking changes and are automatically managed by Ecto.
Introducing Database Migrations
Your Ecto schemas define the *desired* structure of your database. But how do you apply these changes to the actual database?
This is where migrations come in! A migration is an Elixir script that describes changes to your database schema, like creating tables, adding columns, or changing types. They ensure your database schema evolves in a controlled, versioned way.
Generating a Migration File
You create new migration files using the Mix command mix ecto.gen.migration. You provide a descriptive name for the migration:
mix ecto.gen.migration create_users_tableThis command will generate a new Elixir file in your priv/repo/migrations directory. The filename will include a timestamp, ensuring migrations are applied in the correct order.
Anatomy of a Migration
A migration file contains an Elixir module with a change/0 function. Inside this function, you define your database operations. For example, creating a table:
defmodule MyApp.Repo.Migrations.CreateUsersTable do
use Ecto.Migration
def change do
create table(:users) do
add :name, :string, null: false
add :email, :string, null: false
add :age, :integer
timestamps()
end
create unique_index(:users, [:email])
end
endRunning Your Migrations
Once you've defined your migrations, you apply them to your database using another Mix command:
mix ecto.migrateEcto keeps track of which migrations have been run. If you need to undo the last migration, you can use mix ecto.rollback.
Always run migrations in your development environment first to catch any issues!
Schema vs. Migration
Let's check your understanding of Ecto schemas and migrations.
Recap: Schemas & Migrations
You've taken the first step into Ecto!
- We learned that Ecto schemas define how Elixir structs map to database tables, specifying fields and types.
- We explored how migrations are versioned scripts that apply these schema changes to your actual database.
- You now know how to define a basic schema, generate migration files, and apply them using Mix commands.
Next, we'll dive deeper into interacting with your database using Ecto.Repo and ensuring data integrity with Changesets.
Frequently asked questions
Is the “Ecto Schema and Database Migrations” lesson free?
Yes — the full text of “Ecto Schema and Database Migrations” is free to read here on the web, and the Elixir & Phoenix: Scalable Backend Development course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Elixir & Phoenix: Scalable Backend Development course, upgrade to CoddyKit PRO.
What will I learn in “Ecto Schema and Database Migrations”?
Define Ecto schemas to map Elixir structs to database tables and manage schema changes with migrations. You practise Elixir & Phoenix: Scalable Backend Development with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start Elixir & Phoenix: Scalable Backend Development?
No prior experience is required. Elixir & Phoenix: Scalable Backend Development on CoddyKit is structured for beginners through advanced learners; this is — lesson 1 of 4, so you can start here or from the beginning and move at your own pace.
How long does the “Ecto Schema and Database Migrations” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this Elixir & Phoenix: Scalable Backend Development lesson?
Yes. Every Elixir & Phoenix: Scalable Backend Development lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.
All lessons in this course
- Ecto Schema and Database Migrations
- Repo, Changesets, and Queries
- Associations and Embedded Schemas
- Transactions and Ecto.Multi