Blueprint

Register a custom macro.

Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Mix another object into the class.

Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Check if macro is registered.

Flush the existing macros.

Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Dynamically handle calls to the class.

Dynamically handle calls to the class.

Create a new schema blueprint.

Execute the blueprint against the database.

Get the raw SQL statements for the blueprint.

Ensure the commands on the blueprint are valid for the connection type.

Add the commands that are implied by the blueprint's state.

Add the index commands fluently specified on columns.

Add the fluent commands specified on any columns.

Add the alter commands if whenever needed.

Determine if the blueprint has a create command.

Indicate that the table needs to be created.

Specify the storage engine that should be used for the table.

Specify that the InnoDB storage engine should be used for the table (MySQL only).

Specify the character set that should be used for the table.

Specify the collation that should be used for the table.

Indicate that the table needs to be temporary.

Indicate that the table should be dropped.

Indicate that the table should be dropped if it exists.

Indicate that the given columns should be dropped.

Indicate that the given columns should be renamed.

Indicate that the given primary key should be dropped.

Indicate that the given unique key should be dropped.

Indicate that the given index should be dropped.

Indicate that the given fulltext index should be dropped.

Indicate that the given spatial index should be dropped.

Indicate that the given foreign key should be dropped.

Indicate that the given column and foreign key should be dropped.

Indicate that the given foreign key should be dropped.

Indicate that the given foreign key should be dropped.

Indicate that the given indexes should be renamed.

Indicate that the timestamp columns should be dropped.

Indicate that the timestamp columns should be dropped.

Indicate that the soft delete column should be dropped.

Indicate that the soft delete column should be dropped.

Indicate that the remember token column should be dropped.

Indicate that the polymorphic columns should be dropped.

Rename the table to a given name.

Specify the primary key(s) for the table.

Specify a unique index for the table.

Specify an index for the table.

Specify a fulltext index for the table.

Specify a spatial index for the table.

Specify a vector index for the table.

Specify a raw index for the table.

Specify a foreign key for the table.

Create a new auto-incrementing big integer column on the table (8-byte, 0 to 18,446,744,073,709,551,615).

Create a new auto-incrementing integer column on the table (4-byte, 0 to 4,294,967,295).

Create a new auto-incrementing integer column on the table (4-byte, 0 to 4,294,967,295).

Create a new auto-incrementing tiny integer column on the table (1-byte, 0 to 255).

Create a new auto-incrementing small integer column on the table (2-byte, 0 to 65,535).

Create a new auto-incrementing medium integer column on the table (3-byte, 0 to 16,777,215).

Create a new auto-incrementing big integer column on the table (8-byte, 0 to 18,446,744,073,709,551,615).

Create a new char column on the table.

Create a new string column on the table.

Create a new tiny text column on the table (up to 255 characters).

Create a new text column on the table (up to 65,535 characters / ~64 KB).

Create a new medium text column on the table (up to 16,777,215 characters / ~16 MB).

Create a new long text column on the table (up to 4,294,967,295 characters / ~4 GB).

Create a new integer (4-byte) column on the table.

Range: -2,147,483,648 to 2,147,483,647 (signed) or 0 to 4,294,967,295 (unsigned).

Create a new tiny integer (1-byte) column on the table.

Range: -128 to 127 (signed) or 0 to 255 (unsigned).

Create a new small integer (2-byte) column on the table.

Range: -32,768 to 32,767 (signed) or 0 to 65,535 (unsigned).

Create a new medium integer (3-byte) column on the table.

Range: -8,388,608 to 8,388,607 (signed) or 0 to 16,777,215 (unsigned).

Create a new big integer (8-byte) column on the table.

Range: -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807 (signed) or 0 to 18,446,744,073,709,551,615 (unsigned).

Create a new unsigned integer column on the table (4-byte, 0 to 4,294,967,295).

Create a new unsigned tiny integer column on the table (1-byte, 0 to 255).

Create a new unsigned small integer column on the table (2-byte, 0 to 65,535).

Create a new unsigned medium integer column on the table (3-byte, 0 to 16,777,215).

Create a new unsigned big integer column on the table (8-byte, 0 to 18,446,744,073,709,551,615).

Create a new unsigned big integer column on the table (8-byte, 0 to 18,446,744,073,709,551,615).

Create a foreign ID column for the given model.

Create a foreign UUID column for the given model.

Create a new float column on the table.

Create a new double column on the table.

Create a new decimal column on the table.

Create a new boolean column on the table.

Create a new enum column on the table.

Create a new set column on the table.

Create a new json column on the table.

Create a new jsonb column on the table.

Create a new date column on the table.

Create a new date-time column on the table.

Create a new date-time column (with time zone) on the table.

Create a new time column on the table.

Create a new time column (with time zone) on the table.

Create a new timestamp column on the table.

Create a new timestamp (with time zone) column on the table.

Add nullable creation and update timestamps to the table.

Add nullable creation and update timestamps to the table.

Alias for self::timestamps().

Add nullable creation and update timestampTz columns to the table.

Add nullable creation and update timestampTz columns to the table.

Alias for self::timestampsTz().

Add creation and update datetime columns to the table.

Add a "deleted at" timestamp for the table.

Add a "deleted at" timestampTz for the table.

Add a "deleted at" datetime column to the table.

Create a new year column on the table.

Create a new binary column on the table.

Create a new UUID column on the table.

Create a new UUID column on the table with a foreign key constraint.

Create a new ULID column on the table.

Create a new ULID column on the table with a foreign key constraint.

Create a new IP address column on the table.

Create a new MAC address column on the table.

Create a new geometry column on the table.

Create a new geography column on the table.

Create a new generated, computed column on the table.

Create a new vector column on the table.

Create a new tsvector column on the table.

Add the proper columns for a polymorphic table.

Add nullable columns for a polymorphic table.

Add the proper columns for a polymorphic table using numeric IDs (incremental).

Add nullable columns for a polymorphic table using numeric IDs (incremental).

Add the proper columns for a polymorphic table using UUIDs.

Add nullable columns for a polymorphic table using UUIDs.

Add the proper columns for a polymorphic table using ULIDs.

Add nullable columns for a polymorphic table using ULIDs.

Add the remember_token column to the table.

Create a new custom column on the table.

Add a comment to the table.

Create a new index command on the blueprint.

Create a new drop index command on the blueprint.

Create a default index name for the table.

Add a new column to the blueprint.

Add a new column definition to the blueprint.

Add the columns from the callback after the given column.

Remove a column from the schema blueprint.

Add a new command to the blueprint.

Create a new Fluent command.

Get the table the blueprint describes.

Get the columns on the blueprint.

Get the commands on the blueprint.

Get the state of the blueprint.

Get the columns on the blueprint that should be added.

Get the default time precision.

Flush all static state.