Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify that index names can be a string or an atom #639

Merged
merged 1 commit into from
Oct 22, 2024
Merged

Clarify that index names can be a string or an atom #639

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions lib/ecto/migration.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ defmodule Ecto.Migration do
@type t :: %__MODULE__{
table: String.t(),
prefix: String.t() | nil,
name: atom,
name: String.t() | atom,
columns: [atom | String.t()],
unique: boolean,
concurrently: boolean,
Expand Down Expand Up @@ -779,7 +779,8 @@ defmodule Ecto.Migration do

## Options

* `:name` - the name of the index. Defaults to "#{table}_#{column}_index".
* `:name` - the name of the index. Can be provided as a string or an atom.
Defaults to "#{table}_#{column}_index".
* `:prefix` - specify an optional prefix for the index.
* `:unique` - indicates whether the index should be unique. Defaults to `false`.
* `:comment` - adds a comment to the index.
Expand Down
Loading