Básico

Esta tradução está atualizada.

Ecto é um projeto oficial do Elixir que fornece uma camada de banco de dados e linguagem integrada para consultas. Com Ecto podemos criar migrações, definir esquemas, inserir e atualizar registros, e fazer consultas.

Sumário

Adaptadores

O Ecto suporta diferentes banco de dados através do uso de adaptadores. Alguns exemplos de adaptadores são:

  • PostgreSQL
  • MySQL
  • SQLite

Nessa lição configuraremos o Ecto para usar o adaptador do PostgreSQL.

Começando

Nesta lição, cobriremos três partes do Ecto:

  • O repositório: provê a interface com nosso banco de dados, incluindo a conexão.
  • Migrações: um mecanismo para criar, modificar e destruir tabelas e índices no banco de dados.
  • Esquemas: estruturas especiais para representar linhas em tabelas no banco de dados.

Para iniciar criaremos uma aplicação com uma árvore de supervisão:

$ mix new friends --sup
$ cd friends

Adicione o ecto e o postgrex como dependências no seu mix.exs:

defp deps do
  [
    {:ecto_sql, "~> 3.2"},
    {:postgrex, "~> 0.15"}
  ]
end

Depois, busque as dependências usando:

$ mix deps.get

Criando um repositório

Um repositório no Ecto mapeia a um banco de dados, como o nosso banco no Postgres. Toda a comunicação ao banco de dados será feita através desse repositório.

Crie um repositório rodando:

$ mix ecto.gen.repo -r Friends.Repo

Essa tarefa irá gerar toda a configuração requirida para conectar a um banco de dados em config/config.exs, incluindo a configuração do adaptador. Esse é o arquivo de configuração para nosso banco de dados Friends:

config :friends, Friends.Repo,
  database: "friends_repo",
  username: "postgres",
  password: "",
  hostname: "localhost",

Ela também gera um módulo chamado Friends.Repo em lib/friends/repo.ex

defmodule Friends.Repo do
  use Ecto.Repo,
    otp_app: :friends,
    adapter: Ecto.Adapters.Postgres
end

Nós iremos utilizar o módulo Friends.Repo para consultar o banco de dados. Nós também dizemos a esse módulo para encontrar suas configurações na aplicação :friends e selecionamos o adaptador Ecto.Adapters.Postgres.

A seguir, iremos configurar o Friends.Repo como supervisor de nossa árvore de supervisão em lib/friends/application.ex. Isso irá iniciar o processo do Ecto assim que nossa aplicação iniciar.

def start(_type, _args) do
  # List all child processes to be supervised
  children = [
    Friends.Repo,
  ]

...

Depois disso, precisamos adicionar a seguinte linha no nosso config/config.exs:

config :friends, ecto_repos: [Friends.Repo]

Isso irá permitir à nossa aplicação rodar tarefas mix do Ecto a partir da linha de comando.

Já concluímos a configuração do repositório! Agora podemos criar o banco de dados no PostgreSQL com o seguinte comando:

$ mix ecto.create

Ecto vai utilizar a informação no arquivo config/config.exs para determinar como se conectar ao Postgres e como nomear o banco de dados.

Se você receber algum erro, certifique-se de que os dados de configuração estão corretos e de que sua instância do postgres está rodando.

Migrações

Para criar e modificar tabelas no banco de dados, utilizamos as migrações do Ecto. Cada migração descreve uma série de ações para serem realizadas no nosso banco, como quais tabelas criar ou atualizar.

Como nosso banco de dados ainda não tem nenhuma tabela, precisaremos criar uma migração para adicionar alguma. A convenção no Ecto é pluralizar o nome das tabelas, portanto, para essa aplicação precisaremos de uma tabela people, então vamos começar nossas migrações assim.

A melhor maneira de criar migrações é a tarefa ecto.gen.migration <nome>, então em nosso caso vamos usar:

$ mix ecto.gen.migration create_people

Isso irá gerar um novo arquivo na pasta priv/repo/migrations contendo uma timestamp no nome. Se navegarmos para esse diretório e abrirmos a migração, veremos algo assim:

defmodule Friends.Repo.Migrations.CreatePeople do
  use Ecto.Migration

  def change do

  end
end

Vamos começar modificando a função change/0 para criar uma nova tabela people com os campos name (nome) e age (idade):

defmodule Friends.Repo.Migrations.CreatePeople do
  use Ecto.Migration

  def change do
    create table(:people) do
      add :name, :string, null: false
      add :age, :integer, default: 0
    end
  end
end

Você também pode ver acima que definimos o tipo de dados das colunas. Adicionalmente, nós incluímos null: false e default: 0 como opções.

Agora vamos rodar nossa migração:

$ mix ecto.migrate

Esquemas

Agora que criamos nossa tabela inicial, precisamos dizer mais sobre ela ao Ecto, e parte de como fazemos isso é através de esquemas. Um esquema é um módulo que define um mapeando dos campos de uma tabela.

Enquanto nas tabelas utilizamos o plural, no esquema tipicamente se utiliza o singular. Então criamos um esquema Person para nossa tabela.

Criamos ele em lib/friends/person.ex

defmodule Friends.Person do
  use Ecto.Schema

  schema "people" do
    field :name, :string
    field :age, :integer, default: 0
  end
end

Aqui você pode ver que o módulo Friends.Person diz ao Ecto que esse esquema se refere à tabela people e que temos duas colunas: name que é uma string e age, que é um inteiro de padrão 0.

Vamos dar uma olhada em nosso esquema abrindo iex -S mix e criando uma nova pessoa:

iex> %Friends.Person{}
%Friends.Person{age: 0, name: nil}

Como esperado, recebemos uma nova Person com o valor padrão aplicado a age. Agora, vamos criar uma pessoa “real”:

iex>  person = %Friends.Person{name: "Tom", age: 11}
%Friends.Person{age: 11, name: "Tom"}

Como esquemas são apenas structs, podemos interagir com eles da maneira que estamos habituados:

iex> person.name
"Tom"
iex> Map.get(person, :name)
"Tom"
iex> %{name: name} = person
%Friends.Person{age: 11, name: "Tom"}
iex> name
"Tom"

De maneira similar, podemos atualizar nossos esquemas como poderíamos fazer com qualquer outro map ou struct em Elixir:

iex> %{person | age: 18}
%Friends.Person{age: 18, name: "Tom"}
iex> Map.put(person, :name, "Jerry"}
%Friends.Person{age: 11, name: "Jerry"}

Em nossa próxima lição, sobre changesets, iremos dar uma olhada em como validar as nossas mudanças e, finalmente, em como fazer elas persistir no banco de dados.

Caught a mistake or want to contribute to the lesson? Edit this page on GitHub!