Intro
Creating a project
# mix phx.new <name>
mix phx.new my_app
Options
--live |
include LiveView |
--database |
possible values are: postgres, mysql, mssql |
--no-webpack |
|
--no-ecto |
|
--no-html |
|
--no-gettext |
|
--no-dashboard |
do not include Phoenix.LiveDashboard |
--install |
will fetch and install dependencies (including npm js) |
--no-install |
Generators
migration
# mix ecto.gen.migration <migration name>
mix ecto.gen.migration add_posts_table
Other generators
certchannelembeddedpresencesecret
schema
# mix phx.gen.schema <schema module> <plural model name> <attributes>
mix phx.gen.schema Blog.Post blog_posts title:string views:integer
This command will create the following files:
- a schema file in
lib/my_app/blog/post.ex, with ablog_poststable - a migration file (use
--no-migrationto skip this)
Attribute types
:string- this is the default type if no type is given:integer:float:decimal:boolean:map:array:references:text:date:time:time_usec:naive_datetime:naive_datetime_usec:utc_datetime:utc_datetime_usec:uuid:binary:datetime- An alias for:naive_datetime
user_id:references:users will result in a migration with an :integer column of :user_id and create an index.
tags:array:string will create an array type if the database supports it.
Unique columns can be generated with title:unique or unique_int:integer:unique
Options
--table cms_posts |
change the name of the generated table |
--no-migration |
context
# mix phx.gen.context <context> <schema> <plural schema> <attributes>
mix phx.gen.context Accounts User users name:string age:integer
This command will create the following files:
- a context module in
accounts.ex - a schema file in
accounts/user.ex, with auserstable - a migration file
Options
--table cms_posts |
change the name of the table generated |
--no-schema |
|
--no-migration |
html
# mix phx.gen.html <context> <schema> <plural schema> <attributes>
mix phx.gen.html Accounts User users name:string age:integer
This command will create the following files:
- a context module in
lib/app/accounts.exfor the accounts API - a schema file in
lib/app/accounts/user.ex, with an users table - a view file in
lib/app_web/views/user_view.ex - a controller file in
lib/app_web/controllers/user_controller.ex - default CRUD templates in
lib/app_web/templates/user
Options
--no-context |
|
--no-schema |
json
# mix phx.gen.html <context> <schema> <plural schema> <attributes>
mix phx.gen.json Accounts User users name:string age:integer
This command will create the following files:
- a context module in
lib/app/accounts.exfor the accounts API - a schema file in
lib/app/accounts/user.ex, with an users table - a view file in
lib/app_web/views/user_view.ex - a controller file in
lib/app_web/controllers/user_controller.ex
Options
--no-context--no-schema
live
# mix phx.gen.live <context> <schema> <plural schema> <attributes>
mix phx.gen.live Accounts User users name:string age:integer
This command will create the following files:
- a context module in
lib/app/accounts.exfor the accounts API - a schema file in
lib/app/accounts/user.ex, with an users table - a view file in
lib/app_web/views/user_view.ex - a LiveView in
lib/app_web/live/user_live/show_live.ex - a LiveView in
lib/app_web/live/user_live/index_live.ex - a LiveComponent in
lib/app_web/live/user_live/form_component.ex - a LiveComponent in
lib/app_web/live/modal_component.ex - a helpers modules in l
ib/app_web/live/live_helpers.ex
Options
--no-context |
|
--no-schema |