Skip to content

[12.x] Improve Blueprint docblocks with concrete value ranges for integer and text columns #58019

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

Merged
taylorotwell merged 1 commit into from
Dec 5, 2025
Merged

[12.x] Improve Blueprint docblocks with concrete value ranges for integer and text columns #58019

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
39 changes: 22 additions & 17 deletions src/Illuminate/Database/Schema/Blueprint.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -725,7 +725,7 @@ public function foreign($columns, $name = null)
}

/**
* Create a new auto-incrementing big integer (8-byte) column on the table.
* Create a new auto-incrementing big integer column on the table (8-byte, 0 to 18,446,744,073,709,551,615).
*
* @param string $column
* @return \Illuminate\Database\Schema\ColumnDefinition
Expand All @@ -736,7 +736,7 @@ public function id($column = 'id')
}

/**
* Create a new auto-incrementing integer (4-byte) column on the table.
* Create a new auto-incrementing integer column on the table (4-byte, 0 to 4,294,967,295).
*
* @param string $column
* @return \Illuminate\Database\Schema\ColumnDefinition
Expand All @@ -747,7 +747,7 @@ public function increments($column)
}

/**
* Create a new auto-incrementing integer (4-byte) column on the table.
* Create a new auto-incrementing integer column on the table (4-byte, 0 to 4,294,967,295).
*
* @param string $column
* @return \Illuminate\Database\Schema\ColumnDefinition
Expand All @@ -758,7 +758,7 @@ public function integerIncrements($column)
}

/**
* Create a new auto-incrementing tiny integer (1-byte) column on the table.
* Create a new auto-incrementing tiny integer column on the table (1-byte, 0 to 255).
*
* @param string $column
* @return \Illuminate\Database\Schema\ColumnDefinition
Expand All @@ -769,7 +769,7 @@ public function tinyIncrements($column)
}

/**
* Create a new auto-incrementing small integer (2-byte) column on the table.
* Create a new auto-incrementing small integer column on the table (2-byte, 0 to 65,535).
*
* @param string $column
* @return \Illuminate\Database\Schema\ColumnDefinition
Expand All @@ -780,7 +780,7 @@ public function smallIncrements($column)
}

/**
* Create a new auto-incrementing medium integer (3-byte) column on the table.
* Create a new auto-incrementing medium integer column on the table (3-byte, 0 to 16,777,215).
*
* @param string $column
* @return \Illuminate\Database\Schema\ColumnDefinition
Expand All @@ -791,7 +791,7 @@ public function mediumIncrements($column)
}

/**
* Create a new auto-incrementing big integer (8-byte) column on the table.
* Create a new auto-incrementing big integer column on the table (8-byte, 0 to 18,446,744,073,709,551,615).
*
* @param string $column
* @return \Illuminate\Database\Schema\ColumnDefinition
Expand Down Expand Up @@ -830,7 +830,7 @@ public function string($column, $length = null)
}

/**
* Create a new tiny text column on the table.
* Create a new tiny text column on the table (up to 255 characters).
*
* @param string $column
* @return \Illuminate\Database\Schema\ColumnDefinition
Expand All @@ -841,7 +841,7 @@ public function tinyText($column)
}

/**
* Create a new text column on the table.
* Create a new text column on the table (up to 65,535 characters / ~64 KB).
*
* @param string $column
* @return \Illuminate\Database\Schema\ColumnDefinition
Expand All @@ -852,7 +852,7 @@ public function text($column)
}

/**
* Create a new medium text column on the table.
* Create a new medium text column on the table (up to 16,777,215 characters / ~16 MB).
*
* @param string $column
* @return \Illuminate\Database\Schema\ColumnDefinition
Expand All @@ -863,7 +863,7 @@ public function mediumText($column)
}

/**
* Create a new long text column on the table.
* Create a new long text column on the table (up to 4,294,967,295 characters / ~4 GB).
*
* @param string $column
* @return \Illuminate\Database\Schema\ColumnDefinition
Expand All @@ -875,6 +875,7 @@ public function longText($column)

/**
* 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).
*
* @param string $column
* @param bool $autoIncrement
Expand All @@ -888,6 +889,7 @@ public function integer($column, $autoIncrement = false, $unsigned = false)

/**
* Create a new tiny integer (1-byte) column on the table.
* Range: -128 to 127 (signed) or 0 to 255 (unsigned).
*
* @param string $column
* @param bool $autoIncrement
Expand All @@ -901,6 +903,7 @@ public function tinyInteger($column, $autoIncrement = false, $unsigned = false)

/**
* Create a new small integer (2-byte) column on the table.
* Range: -32,768 to 32,767 (signed) or 0 to 65,535 (unsigned).
*
* @param string $column
* @param bool $autoIncrement
Expand All @@ -914,6 +917,7 @@ public function smallInteger($column, $autoIncrement = false, $unsigned = false)

/**
* 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).
*
* @param string $column
* @param bool $autoIncrement
Expand All @@ -927,6 +931,7 @@ public function mediumInteger($column, $autoIncrement = false, $unsigned = false

/**
* 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).
*
* @param string $column
* @param bool $autoIncrement
Expand All @@ -939,7 +944,7 @@ public function bigInteger($column, $autoIncrement = false, $unsigned = false)
}

/**
* Create a new unsigned integer (4-byte) column on the table.
* Create a new unsigned integer column on the table (4-byte, 0 to 4,294,967,295).
*
* @param string $column
* @param bool $autoIncrement
Expand All @@ -951,7 +956,7 @@ public function unsignedInteger($column, $autoIncrement = false)
}

/**
* Create a new unsigned tiny integer (1-byte) column on the table.
* Create a new unsigned tiny integer column on the table (1-byte, 0 to 255).
*
* @param string $column
* @param bool $autoIncrement
Expand All @@ -963,7 +968,7 @@ public function unsignedTinyInteger($column, $autoIncrement = false)
}

/**
* Create a new unsigned small integer (2-byte) column on the table.
* Create a new unsigned small integer column on the table (2-byte, 0 to 65,535).
*
* @param string $column
* @param bool $autoIncrement
Expand All @@ -975,7 +980,7 @@ public function unsignedSmallInteger($column, $autoIncrement = false)
}

/**
* Create a new unsigned medium integer (3-byte) column on the table.
* Create a new unsigned medium integer column on the table (3-byte, 0 to 16,777,215).
*
* @param string $column
* @param bool $autoIncrement
Expand All @@ -987,7 +992,7 @@ public function unsignedMediumInteger($column, $autoIncrement = false)
}

/**
* Create a new unsigned big integer (8-byte) column on the table.
* Create a new unsigned big integer column on the table (8-byte, 0 to 18,446,744,073,709,551,615).
*
* @param string $column
* @param bool $autoIncrement
Expand All @@ -999,7 +1004,7 @@ public function unsignedBigInteger($column, $autoIncrement = false)
}

/**
* Create a new unsigned big integer (8-byte) column on the table.
* Create a new unsigned big integer column on the table (8-byte, 0 to 18,446,744,073,709,551,615).
*
* @param string $column
* @return \Illuminate\Database\Schema\ForeignIdColumnDefinition
Expand Down