Provide Reference Documentation for DDL

[aeneasr]

It would be great to get an overview of all available options for each respective datatype and the full vocabulary.

For example, README.md is missing t.Timestamps().

[duckbrain]

Here's the functions and opts I could find reading the source code. I omitted functions that didn't seem to be relevant to a fizz migration file. I added some descriptions, but it's far from fleshed-out docs.

• Top-level functions: https://github.com/gobuffalo/fizz/blob/v1.11.0/bubbler.go#L30
  • exec - Execute an External Command
  • create_table - Create a Table
    • opts
      • timestamps - boolean include created_at and updated_at timestamp columns (default: true)
  • change_column
  • add_column
  • drop_column
  • rename_column
  • raw
  • sql
  • add_index
  • drop_index
  • rename_index
  • add_foreign_key
  • drop_foreign_key
    • opts
      • if_exists boollean adds IF EXISTS to SQL if true
  • drop_table
  • rename_table
• Table functions: https://pkg.go.dev/github.com/gobuffalo/fizz?tab=doc#Table
  • Column(name, type, opts) - Add a column to the table
    • type: documented in README
    • opts
      • null - boolean if column should be nullable (default false)
      • default - Default value of column
      • default_raw - SQL fragment of default value of column
      • size - length of string types
      • precision - precision of decimal types
      • scale - scale of decimal types (ignored if precision not set)
      • first - Make this the first column
      • after - Add this column after the named one
      • primary - Column is one of the primary keys
  • ForeignKey(columnName, foreignKeyRef, opts) - Add a foreign key constraint to a column on the table
    • opts
      • on_update - ON UPDATE SQL fragment
      • on_delete - ON DELETE SQL fragment
  • Index - Adds an index to a column(s) on the table
    • opts
      • name - Give an explicit name to the index
      • unique - Enforce a unique index
  • PrimaryKey(columnNames...) - Marks the named columns as primary keys before adding them to the table.
    • Called after adding the columns
    • Can probably be excluded from docs, since it's redundant with an option on Column
  • DisableTimestamps - Disables timestamps from being added (sets opt to false)
  • Timestamps - Explicitly enables timestamp columns to be added (default)

I used a regex: options\["[a-z_]+"\] to find them.