Returns an index struct that can be given to Ecto.Migration create/1, drop/1, etc.

Expects the table name as the first argument and the field(s) as the second. The fields can be atoms, representing the JSONb column name, or a list of strings, representing the JSONb column name + JSON attributes to index.

options

Options

• :name - the name of the index. Defaults to "#{"idxgin" | "idxginp"}#{table}_#{fields}".
• :unique - indicates whether the index should be unique. Defaults to false.
• :concurrently - indicates whether the index should be created/dropped concurrently.
• :prefix - specify an optional prefix for the index.
• :where - specify conditions for a partial index.
• :comment - adds a comment to the index.

examples

Examples

With no name provided, the name of the below index defaults to idxginp_products_category:

create json_index("products", :category)

The name can also be set explicitly:

create json_index("products", :category, name: :my_special_name)

With no name provided, the name of the below index defaults to idxgin_products_category_tags:

create json_index("products", ["category", "tags"])

Partial indexes are created by specifying a :where option, note that you need to use the necessary JSONb expressions:

create json_index(
  "account",
  :email_provider,
  where: "email_provider #>> '{email_provider,google,smtp_host}' = 'smtp.gmail.com'",
  name: :gmail_provider_index
)