Ecto v0.2.8

Modules summary

Ecto.Adapter

This module specifies the adapter API that an adapter is required to implement

Ecto.Adapter.Migrations

Specifies the adapter migrations API

Ecto.Adapter.Storage

Specifies the adapter storage API

Ecto.Adapter.TestTransactions

Specifies the adapter test transactions API

Ecto.Adapter.Transactions

Specifies the adapter transactions API

Ecto.Adapters.Postgres

This is the adapter module for PostgreSQL. It handles and pools the connections to the postgres database with poolboy

Ecto.Associations.Assoc

This module provides the assoc selector merger and utilities around it

Ecto.Associations.BelongsTo.Proxy

A belongs_to association

Ecto.Associations.HasMany.Proxy

A has_many association

Ecto.Associations.HasOne.Proxy

A has_one association

Ecto.Associations.Preloader

This module provides assoc selector merger

Ecto.Date
Ecto.DateTime
Ecto.Interval
Ecto.Migration
Ecto.Migrator

This module provides the migration API

Ecto.Model

Models are Elixir modules with Ecto-specific behaviour

Ecto.Model.Callbacks

Define module-level callbacks in models

Ecto.Model.Schema

Defines a schema for a model

Ecto.Model.Validations

Conveniences for defining module-level validations in models

Ecto.Query

Provides the Query DSL

Ecto.Query.API

The Query API available by default in Ecto queries

Ecto.Query.Util

This module provide utility functions on queries

Ecto.Reflections.BelongsTo

The reflection struct for a belongs_to association. Its fields are:

Ecto.Reflections.HasMany

The struct record for a has_many association. Its fields are:

Ecto.Reflections.HasOne

The reflection record for a has_one association. Its fields are:

Ecto.Repo

This module is used to define a repository. A repository maps to a data store, for example an SQL database. A repository must implement conf/0 and set an adapter (see Ecto.Adapter) to be used for the repository

Ecto.Storage

Convenience functions around the data store of a repository

Ecto.Time
Ecto.Utils

Convenience functions used throughout Ecto and imported into users modules

Ecto.Validator

Validates a given struct or dict given a set of predicates

Ecto.Validator.Predicates

A handful of predicates to be used in validations

Mix.Tasks.Ecto.Create

Create the database for the given repository, as specified in the repo's url

Mix.Tasks.Ecto.Drop

Drop the database for the given repository, as specified in the repo's url

Mix.Tasks.Ecto.Gen.Migration

Generates a migration for the given repository

Mix.Tasks.Ecto.Gen.Repo

Generates a new repository

Mix.Tasks.Ecto.Migrate

Runs the pending migrations for the given repository

Mix.Tasks.Ecto.Rollback

Reverts applied migrations in the given repository

Exceptions summary

Ecto.AssociationNotLoadedError
Ecto.InvalidModel
Ecto.InvalidURL
Ecto.MigrationError
Ecto.NoPrimaryKey
Ecto.NotSingleResult
Ecto.Query.TypeCheckError

Exception raised when a query does not type check. Read Ecto.Query and Ecto.Query.API docs for more information

Ecto.QueryError

Protocols summary

Ecto.Queryable

The Queryable protocol is responsible for converting a structure to an Ecto.Query struct. The only function required to implement is to_query which does the conversion