 |
VOOZH | about |
|
VOOZH | about |
This page documents the cache system table migration generators: CacheTableCommand and CacheLocksTableCommand. These commands generate database migrations for the database cache driver, creating tables to store cached key-value pairs and atomic cache locks.
Related documentation: Queue System Table Migrations #6.3 Session Table Migration #6.2 Database Migration Generators #6
The cache system provides two migration generators for database-backed caching:
| Command | Class | Table Purpose | Default Name | Config Key |
|---|---|---|---|---|
make:cache-table | CacheTableCommand | Cache key-value storage | cache | cache.stores.database.table |
make:cache-locks-table | CacheLocksTableCommand | Atomic lock management | cache_locks | cache.stores.database.lock_table |
Both classes extend Hyperf\Devtool\Generator\GeneratorCommand and implement identical patterns: retrieve table name from ConfigInterface, generate timestamped migration filename, process stub template with %TABLE% replacement, write to database/migrations/.
Sources: src/Generator/CacheTableCommand.php15-106 src/Generator/CacheLocksTableCommand.php15-106
Sources: src/Generator/CacheTableCommand.php29-59 src/Generator/CacheTableCommand.php100-105 src/Generator/CacheTableCommand.php61-64 src/Generator/CacheTableCommand.php66-69
The CacheTableCommand class generates a migration for the primary cache storage table.
The CacheTableCommand::__construct() registers the command name as make:cache-table, and configure() sets the description:
Command: make:cache-table
Description: Create a migration for the cache database table
Parent: Hyperf\Devtool\Generator\GeneratorCommand
Sources: src/Generator/CacheTableCommand.php17-27
The execute(InputInterface $input, OutputInterface $output): int method at src/Generator/CacheTableCommand.php29-59 implements these steps:
migrationTableName() to retrieve table name from ConfigInterface::get('cache.stores.database.table', 'cache')Carbon::now()->format('Y_m_d_000000') . "_create_{$tableName}_table.php"$input->getOption('path') ?: "database/migrations/{$filename}"alreadyExists($path) and $input->getOption('force'), abort if file exists without force flagmakeDirectory($path) to ensure parent directories existfile_get_contents($this->getStub())buildMigration($stub, $tableName) which performs str_replace('%TABLE%', $name, $stub)file_put_contents($path, $processedStub)openWithIde($path)0Sources: src/Generator/CacheTableCommand.php29-59 src/Generator/CacheTableCommand.php100-105 src/Generator/CacheTableCommand.php61-64
The migrationTableName() method at src/Generator/CacheTableCommand.php100-105 retrieves the table name:
The method uses ApplicationContext::getContainer() to resolve ConfigInterface, then reads the configuration key cache.stores.database.table with fallback default 'cache'.
Sources: src/Generator/CacheTableCommand.php100-105
The getOptions() method at src/Generator/CacheTableCommand.php81-90 defines:
| Option | Short | Type | Description |
|---|---|---|---|
--path | -p | InputOption::VALUE_OPTIONAL | Custom migration path (overrides database/migrations/{filename}) |
--force | -f | Boolean (inherited) | Overwrite existing migration without check |
The method filters parent options to remove the default path option, then adds a custom path option specific to migration table commands.
Sources: src/Generator/CacheTableCommand.php81-90
The getStub() method at src/Generator/CacheTableCommand.php66-69 returns the stub file path:
Default stub: src/Generator/stubs/cache-table.stub. The configuration array $this->getConfig()['stub'] allows overriding the stub path for custom table schemas.
Sources: src/Generator/CacheTableCommand.php66-69
The CacheLocksTableCommand class generates a migration for atomic cache lock management.
The CacheLocksTableCommand::__construct() registers the command as make:cache-locks-table:
Command: make:cache-locks-table
Description: Create a migration for the cache locks database table
Parent: Hyperf\Devtool\Generator\GeneratorCommand
Sources: src/Generator/CacheLocksTableCommand.php17-27
CacheLocksTableCommand implements the same execute() flow as CacheTableCommand with two differences:
cache.stores.database.lock_table (default: 'cache_locks')stubs/cache-locks-table.stubAll other methods (execute(), buildMigration(), alreadyExists(), getOptions(), getDefaultNamespace()) are identical implementations.
Sources: src/Generator/CacheLocksTableCommand.php100-105 src/Generator/CacheLocksTableCommand.php66-69 src/Generator/CacheLocksTableCommand.php29-95
Cache locks enable atomic operations on cached data, preventing race conditions when multiple processes attempt to access or modify the same cache key simultaneously.
The cache-table.stub at src/Generator/stubs/cache-table.stub15-19 defines this schema:
| Column | Method Call | Type | Constraints | Purpose |
|---|---|---|---|---|
key | $table->string('key')->primary() | VARCHAR | Primary key | Cache identifier |
value | $table->mediumText('value') | MEDIUMTEXT | None | Serialized cached value |
expiration | $table->integer('expiration') | INTEGER | None | TTL unix timestamp |
Sources: src/Generator/stubs/cache-table.stub15-19
The cache-locks-table.stub at src/Generator/stubs/cache-locks-table.stub15-19 defines:
| Column | Method Call | Type | Constraints | Purpose |
|---|---|---|---|---|
key | $table->string('key')->primary() | VARCHAR | Primary key | Lock identifier |
owner | $table->string('owner') | VARCHAR | None | Process/owner identifier |
expiration | $table->integer('expiration') | INTEGER | None | Lock expiration timestamp |
Sources: src/Generator/stubs/cache-locks-table.stub15-19
Both stub templates follow this structure:
The up() method calls Schema::create('%TABLE%', function (Blueprint $table) { ... }) to define columns. The down() method calls Schema::dropIfExists('%TABLE%'). The %TABLE% placeholder is replaced by buildMigration().
Sources: src/Generator/stubs/cache-table.stub1-29 src/Generator/stubs/cache-locks-table.stub1-29
The buildMigration(string $stub, string $name): string method performs stub processing:
This method replaces all occurrences of %TABLE% in the stub with the table name. Both CacheTableCommand and CacheLocksTableCommand implement identical versions.
Sources: src/Generator/CacheTableCommand.php61-64 src/Generator/CacheLocksTableCommand.php61-64
Sources: src/Generator/CacheTableCommand.php29-59 src/Generator/CacheTableCommand.php100-105 src/Generator/CacheTableCommand.php61-64
Both commands generate filenames at src/Generator/CacheTableCommand.php35 and src/Generator/CacheLocksTableCommand.php35:
Example: 2024_01_15_000000_create_cache_table.php
The format Y_m_d_000000 uses zero time component, allowing multiple migrations created on the same day to be ordered by their specific table name suffix.
Sources: src/Generator/CacheTableCommand.php35 src/Generator/CacheLocksTableCommand.php35
Path resolution at src/Generator/CacheTableCommand.php36:
Default: database/migrations/{filename}. The --path option overrides this default. Paths are relative to BASE_PATH.
Sources: src/Generator/CacheTableCommand.php36 src/Generator/CacheLocksTableCommand.php36
The makeDirectory($path) call at src/Generator/CacheTableCommand.php49 ensures parent directories exist. This method is inherited from GeneratorCommand and creates directories recursively.
Sources: src/Generator/CacheTableCommand.php49 src/Generator/CacheLocksTableCommand.php49
The alreadyExists(string $rawName): bool method at src/Generator/CacheTableCommand.php71-74:
Returns true if the file exists at BASE_PATH/{$rawName}. The execute() method checks this result combined with $input->getOption('force') to prevent overwrites.
Sources: src/Generator/CacheTableCommand.php71-74 src/Generator/CacheLocksTableCommand.php71-74 src/Generator/CacheTableCommand.php41-44
Generate cache table migration:
Output at src/Generator/CacheTableCommand.php54:
Migration 2024_01_15_000000_create_cache_table.php created successfully.
Generate cache locks table migration:
Output at src/Generator/CacheLocksTableCommand.php54:
Migration 2024_01_15_000000_create_cache_locks_table.php created successfully.
Sources: src/Generator/CacheTableCommand.php54 src/Generator/CacheLocksTableCommand.php54
Specify custom migration location:
Regenerate existing migration file:
When config/autoload/cache.php defines custom table names:
The migrationTableName() method reads these values via ConfigInterface::get(), generating migrations with app_cache and app_cache_locks table names.
Sources: src/Generator/CacheTableCommand.php100-105 src/Generator/CacheLocksTableCommand.php100-105
Both commands import Hyperf\Context\ApplicationContext and Hyperf\Contract\ConfigInterface at src/Generator/CacheTableCommand.php8-9 The migrationTableName() method resolves ConfigInterface from the container to read table names.
Sources: src/Generator/CacheTableCommand.php8-9 src/Generator/CacheTableCommand.php100-105 src/Generator/CacheLocksTableCommand.php8-9 src/Generator/CacheLocksTableCommand.php100-105
Generated migrations extend Hypervel\Database\Migrations\Migration:
The stub imports this at src/Generator/stubs/cache-table.stub6 and creates an anonymous class at line 9 that extends it. This provides access to Hypervel's migration runner features.
Sources: src/Generator/stubs/cache-table.stub6 src/Generator/stubs/cache-table.stub9 src/Generator/stubs/cache-locks-table.stub6 src/Generator/stubs/cache-locks-table.stub9
The stub templates use Hypervel\Support\Facades\Schema for fluent table definitions:
This provides a consistent API across all Hypervel migrations.
Refresh this wiki