1. Documentation
  2. API
  3. Library
  4. Database
  5. Schema
  6. Blueprint

October\Rain\Database\Schema\Blueprint

Extends:

  • Illuminate\Database\Schema\Blueprint

Proxy class

Public properties

There are no public properties in the class.

Show inherited public properties

Inherited public properties

  • public string $engine - defined in Illuminate\Database\Schema\Blueprint. The storage engine that should be used for the table.
  • public $charset - defined in Illuminate\Database\Schema\Blueprint. The default character set that should be used for the table.
  • public $collation - defined in Illuminate\Database\Schema\Blueprint. The collation that should be used for the table.
  • public bool $temporary - defined in Illuminate\Database\Schema\Blueprint. Whether to make the table temporary.

Protected properties

There are no protected properties in the class.

Show inherited protected properties

Inherited protected properties

  • protected string $table - defined in Illuminate\Database\Schema\Blueprint. The table the blueprint describes.
  • protected string $prefix - defined in Illuminate\Database\Schema\Blueprint. The prefix of the table.
  • protected Illuminate\Database\Schema\ColumnDefinition[] $columns - defined in Illuminate\Database\Schema\Blueprint. The columns that should be added to the table.
  • protected Illuminate\Support\Fluent[] $commands - defined in Illuminate\Database\Schema\Blueprint. The commands that should be run for the table.
  • protected static array $macros - defined in Illuminate\Database\Schema\Blueprint. The registered string macros.

Public methods

Show inherited public methods

Inherited public methods

  • public mixed __call(string $method, array $parameters) - defined in Illuminate\Database\Schema\Blueprint. Dynamically handle calls to the class.
  • public static mixed __callStatic(string $method, array $parameters) - defined in Illuminate\Database\Schema\Blueprint. Dynamically handle calls to the class.
  • public void __construct(string $table, Closure|null $callback=NULL, string $prefix='') - defined in Illuminate\Database\Schema\Blueprint. Create a new schema blueprint.
  • public Illuminate\Database\Schema\ColumnDefinition addColumn(string $type, string $name, array $parameters=array()) - defined in Illuminate\Database\Schema\Blueprint. Add a new column to the blueprint.
  • public void addFluentCommands(Illuminate\Database\Schema\Grammars\Grammar $grammar) - defined in Illuminate\Database\Schema\Blueprint. Add the fluent commands specified on any columns.
  • public Illuminate\Database\Schema\ColumnDefinition bigIncrements(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new auto-incrementing big integer (8-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition bigInteger(string $column, bool $autoIncrement=false, bool $unsigned=false) - defined in Illuminate\Database\Schema\Blueprint. Create a new big integer (8-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition binary(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new binary column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition boolean(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new boolean column on the table.
  • public void build(Illuminate\Database\Connection $connection, Illuminate\Database\Schema\Grammars\Grammar $grammar) - defined in Illuminate\Database\Schema\Blueprint. Execute the blueprint against the database.
  • public Illuminate\Database\Schema\ColumnDefinition char(string $column, int|null $length=NULL) - defined in Illuminate\Database\Schema\Blueprint. Create a new char column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition computed(string $column, string $expression) - defined in Illuminate\Database\Schema\Blueprint. Create a new generated, computed column on the table.
  • public Illuminate\Support\Fluent create() - defined in Illuminate\Database\Schema\Blueprint. Indicate that the table needs to be created.
  • public Illuminate\Database\Schema\ColumnDefinition date(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new date column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition dateTime(string $column, int $precision=0) - defined in Illuminate\Database\Schema\Blueprint. Create a new date-time column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition dateTimeTz(string $column, int $precision=0) - defined in Illuminate\Database\Schema\Blueprint. Create a new date-time column (with time zone) on the table.
  • public Illuminate\Database\Schema\ColumnDefinition decimal(string $column, int $total=8, int $places=2) - defined in Illuminate\Database\Schema\Blueprint. Create a new decimal column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition double(string $column, int|null $total=NULL, int|null $places=NULL) - defined in Illuminate\Database\Schema\Blueprint. Create a new double column on the table.
  • public Illuminate\Support\Fluent drop() - defined in Illuminate\Database\Schema\Blueprint. Indicate that the table should be dropped.
  • public Illuminate\Support\Fluent dropColumn(array|mixed $columns) - defined in Illuminate\Database\Schema\Blueprint. Indicate that the given columns should be dropped.
  • public Illuminate\Support\Fluent dropForeign(string|array $index) - defined in Illuminate\Database\Schema\Blueprint. Indicate that the given foreign key should be dropped.
  • public Illuminate\Support\Fluent dropIfExists() - defined in Illuminate\Database\Schema\Blueprint. Indicate that the table should be dropped if it exists.
  • public Illuminate\Support\Fluent dropIndex(string|array $index) - defined in Illuminate\Database\Schema\Blueprint. Indicate that the given index should be dropped.
  • public void dropMorphs(string $name, string|null $indexName=NULL) - defined in Illuminate\Database\Schema\Blueprint. Indicate that the polymorphic columns should be dropped.
  • public Illuminate\Support\Fluent dropPrimary(string|array|null $index=NULL) - defined in Illuminate\Database\Schema\Blueprint. Indicate that the given primary key should be dropped.
  • public void dropRememberToken() - defined in Illuminate\Database\Schema\Blueprint. Indicate that the remember token column should be dropped.
  • public void dropSoftDeletes(string $column='deleted_at') - defined in Illuminate\Database\Schema\Blueprint. Indicate that the soft delete column should be dropped.
  • public void dropSoftDeletesTz(string $column='deleted_at') - defined in Illuminate\Database\Schema\Blueprint. Indicate that the soft delete column should be dropped.
  • public Illuminate\Support\Fluent dropSpatialIndex(string|array $index) - defined in Illuminate\Database\Schema\Blueprint. Indicate that the given spatial index should be dropped.
  • public void dropTimestamps() - defined in Illuminate\Database\Schema\Blueprint. Indicate that the timestamp columns should be dropped.
  • public void dropTimestampsTz() - defined in Illuminate\Database\Schema\Blueprint. Indicate that the timestamp columns should be dropped.
  • public Illuminate\Support\Fluent dropUnique(string|array $index) - defined in Illuminate\Database\Schema\Blueprint. Indicate that the given unique key should be dropped.
  • public Illuminate\Database\Schema\ColumnDefinition enum(string $column, array $allowed) - defined in Illuminate\Database\Schema\Blueprint. Create a new enum column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition float(string $column, int $total=8, int $places=2) - defined in Illuminate\Database\Schema\Blueprint. Create a new float column on the table.
  • public Illuminate\Support\Fluent|\Illuminate\Database\Schema\ForeignKeyDefinition foreign(string|array $columns, string|null $name=NULL) - defined in Illuminate\Database\Schema\Blueprint. Specify a foreign key for the table.
  • public Illuminate\Database\Schema\ColumnDefinition geometry(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new geometry column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition geometryCollection(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new geometrycollection column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition[] getAddedColumns() - defined in Illuminate\Database\Schema\Blueprint. Get the columns on the blueprint that should be added.
  • public Illuminate\Database\Schema\ColumnDefinition[] getChangedColumns() - defined in Illuminate\Database\Schema\Blueprint. Get the columns on the blueprint that should be changed.
  • public Illuminate\Database\Schema\ColumnDefinition[] getColumns() - defined in Illuminate\Database\Schema\Blueprint. Get the columns on the blueprint.
  • public Illuminate\Support\Fluent[] getCommands() - defined in Illuminate\Database\Schema\Blueprint. Get the commands on the blueprint.
  • public string getTable() - defined in Illuminate\Database\Schema\Blueprint. Get the table the blueprint describes.
  • public static bool hasMacro(string $name) - defined in Illuminate\Database\Schema\Blueprint. Checks if macro is registered.
  • public Illuminate\Database\Schema\ColumnDefinition increments(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new auto-incrementing integer (4-byte) column on the table.
  • public Illuminate\Support\Fluent index(string|array $columns, string|null $name=NULL, string|null $algorithm=NULL) - defined in Illuminate\Database\Schema\Blueprint. Specify an index for the table.
  • public Illuminate\Database\Schema\ColumnDefinition integer(string $column, bool $autoIncrement=false, bool $unsigned=false) - defined in Illuminate\Database\Schema\Blueprint. Create a new integer (4-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition integerIncrements(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new auto-incrementing integer (4-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition ipAddress(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new IP address column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition json(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new json column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition jsonb(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new jsonb column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition lineString(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new linestring column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition longText(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new long text column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition macAddress(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new MAC address column on the table.
  • public static void macro(string $name, object|callable $macro) - defined in Illuminate\Database\Schema\Blueprint. Register a custom macro.
  • public Illuminate\Database\Schema\ColumnDefinition mediumIncrements(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new auto-incrementing medium integer (3-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition mediumInteger(string $column, bool $autoIncrement=false, bool $unsigned=false) - defined in Illuminate\Database\Schema\Blueprint. Create a new medium integer (3-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition mediumText(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new medium text column on the table.
  • public static void mixin(object $mixin, bool $replace=true) - defined in Illuminate\Database\Schema\Blueprint. Mix another object into the class.
  • public void morphs(string $name, string|null $indexName=NULL) - defined in Illuminate\Database\Schema\Blueprint. Add the proper columns for a polymorphic table.
  • public Illuminate\Database\Schema\ColumnDefinition multiLineString(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new multilinestring column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition multiPoint(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new multipoint column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition multiPolygon(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new multipolygon column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition multiPolygonZ(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new multipolygon column on the table.
  • public void nullableMorphs(string $name, string|null $indexName=NULL) - defined in Illuminate\Database\Schema\Blueprint. Add nullable columns for a polymorphic table.
  • public void nullableTimestamps(int $precision=0) - defined in Illuminate\Database\Schema\Blueprint. Add nullable creation and update timestamps to the table.
  • public void nullableUuidMorphs(string $name, string|null $indexName=NULL) - defined in Illuminate\Database\Schema\Blueprint. Add nullable columns for a polymorphic table using UUIDs.
  • public Illuminate\Database\Schema\ColumnDefinition point(string $column, int|null $srid=NULL) - defined in Illuminate\Database\Schema\Blueprint. Create a new point column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition polygon(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new polygon column on the table.
  • public Illuminate\Support\Fluent primary(string|array $columns, string|null $name=NULL, string|null $algorithm=NULL) - defined in Illuminate\Database\Schema\Blueprint. Specify the primary key(s) for the table.
  • public Illuminate\Database\Schema\ColumnDefinition rememberToken() - defined in Illuminate\Database\Schema\Blueprint. Adds the remember_token column to the table.
  • public $this removeColumn(string $name) - defined in Illuminate\Database\Schema\Blueprint. Remove a column from the schema blueprint.
  • public Illuminate\Support\Fluent rename(string $to) - defined in Illuminate\Database\Schema\Blueprint. Rename the table to a given name.
  • public Illuminate\Support\Fluent renameColumn(string $from, string $to) - defined in Illuminate\Database\Schema\Blueprint. Indicate that the given columns should be renamed.
  • public Illuminate\Support\Fluent renameIndex(string $from, string $to) - defined in Illuminate\Database\Schema\Blueprint. Indicate that the given indexes should be renamed.
  • public Illuminate\Database\Schema\ColumnDefinition set(string $column, array $allowed) - defined in Illuminate\Database\Schema\Blueprint. Create a new set column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition smallIncrements(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new auto-incrementing small integer (2-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition smallInteger(string $column, bool $autoIncrement=false, bool $unsigned=false) - defined in Illuminate\Database\Schema\Blueprint. Create a new small integer (2-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition softDeletes(string $column='deleted_at', int $precision=0) - defined in Illuminate\Database\Schema\Blueprint. Add a "deleted at" timestamp for the table.
  • public Illuminate\Database\Schema\ColumnDefinition softDeletesTz(string $column='deleted_at', int $precision=0) - defined in Illuminate\Database\Schema\Blueprint. Add a "deleted at" timestampTz for the table.
  • public Illuminate\Support\Fluent spatialIndex(string|array $columns, string|null $name=NULL) - defined in Illuminate\Database\Schema\Blueprint. Specify a spatial index for the table.
  • public Illuminate\Database\Schema\ColumnDefinition string(string $column, int|null $length=NULL) - defined in Illuminate\Database\Schema\Blueprint. Create a new string column on the table.
  • public void temporary() - defined in Illuminate\Database\Schema\Blueprint. Indicate that the table needs to be temporary.
  • public Illuminate\Database\Schema\ColumnDefinition text(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new text column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition time(string $column, int $precision=0) - defined in Illuminate\Database\Schema\Blueprint. Create a new time column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition timeTz(string $column, int $precision=0) - defined in Illuminate\Database\Schema\Blueprint. Create a new time column (with time zone) on the table.
  • public Illuminate\Database\Schema\ColumnDefinition timestamp(string $column, int $precision=0) - defined in Illuminate\Database\Schema\Blueprint. Create a new timestamp column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition timestampTz(string $column, int $precision=0) - defined in Illuminate\Database\Schema\Blueprint. Create a new timestamp (with time zone) column on the table.
  • public void timestamps(int $precision=0) - defined in Illuminate\Database\Schema\Blueprint. Add nullable creation and update timestamps to the table.
  • public void timestampsTz(int $precision=0) - defined in Illuminate\Database\Schema\Blueprint. Add creation and update timestampTz columns to the table.
  • public Illuminate\Database\Schema\ColumnDefinition tinyIncrements(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new auto-incrementing tiny integer (1-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition tinyInteger(string $column, bool $autoIncrement=false, bool $unsigned=false) - defined in Illuminate\Database\Schema\Blueprint. Create a new tiny integer (1-byte) column on the table.
  • public array toSql(Illuminate\Database\Connection $connection, Illuminate\Database\Schema\Grammars\Grammar $grammar) - defined in Illuminate\Database\Schema\Blueprint. Get the raw SQL statements for the blueprint.
  • public Illuminate\Support\Fluent unique(string|array $columns, string|null $name=NULL, string|null $algorithm=NULL) - defined in Illuminate\Database\Schema\Blueprint. Specify a unique index for the table.
  • public Illuminate\Database\Schema\ColumnDefinition unsignedBigInteger(string $column, bool $autoIncrement=false) - defined in Illuminate\Database\Schema\Blueprint. Create a new unsigned big integer (8-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition unsignedDecimal(string $column, int $total=8, int $places=2) - defined in Illuminate\Database\Schema\Blueprint. Create a new unsigned decimal column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition unsignedInteger(string $column, bool $autoIncrement=false) - defined in Illuminate\Database\Schema\Blueprint. Create a new unsigned integer (4-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition unsignedMediumInteger(string $column, bool $autoIncrement=false) - defined in Illuminate\Database\Schema\Blueprint. Create a new unsigned medium integer (3-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition unsignedSmallInteger(string $column, bool $autoIncrement=false) - defined in Illuminate\Database\Schema\Blueprint. Create a new unsigned small integer (2-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition unsignedTinyInteger(string $column, bool $autoIncrement=false) - defined in Illuminate\Database\Schema\Blueprint. Create a new unsigned tiny integer (1-byte) column on the table.
  • public Illuminate\Database\Schema\ColumnDefinition uuid(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new uuid column on the table.
  • public void uuidMorphs(string $name, string|null $indexName=NULL) - defined in Illuminate\Database\Schema\Blueprint. Add the proper columns for a polymorphic table using UUIDs.
  • public Illuminate\Database\Schema\ColumnDefinition year(string $column) - defined in Illuminate\Database\Schema\Blueprint. Create a new year column on the table.

Protected methods

Show inherited protected methods

Inherited protected methods

  • protected Illuminate\Support\Fluent addCommand(string $name, array $parameters=array()) - defined in Illuminate\Database\Schema\Blueprint. Add a new command to the blueprint.
  • protected void addFluentIndexes() - defined in Illuminate\Database\Schema\Blueprint. Add the index commands fluently specified on columns.
  • protected void addImpliedCommands(Illuminate\Database\Schema\Grammars\Grammar $grammar) - defined in Illuminate\Database\Schema\Blueprint. Add the commands that are implied by the blueprint's state.
  • protected Illuminate\Support\Collection commandsNamed(array $names) - defined in Illuminate\Database\Schema\Blueprint. Get all of the commands matching the given names.
  • protected Illuminate\Support\Fluent createCommand(string $name, array $parameters=array()) - defined in Illuminate\Database\Schema\Blueprint. Create a new Fluent command.
  • protected string createIndexName(string $type, array $columns) - defined in Illuminate\Database\Schema\Blueprint. Create a default index name for the table.
  • protected bool creating() - defined in Illuminate\Database\Schema\Blueprint. Determine if the blueprint has a create command.
  • protected Illuminate\Support\Fluent dropIndexCommand(string $command, string $type, string|array $index) - defined in Illuminate\Database\Schema\Blueprint. Create a new drop index command on the blueprint.
  • protected void ensureCommandsAreValid(Illuminate\Database\Connection $connection) - defined in Illuminate\Database\Schema\Blueprint. Ensure the commands on the blueprint are valid for the connection type.
  • protected Illuminate\Support\Fluent indexCommand(string $type, string|array $columns, string $index, string|null $algorithm=NULL) - defined in Illuminate\Database\Schema\Blueprint. Add a new index command to the blueprint.