Laravel-MongoDB 中的 Schema Builder 使用指南

Laravel-MongoDB 中的 Schema Builder 使用指南

概述

在 Laravel 生态系统中，Schema Builder 是一个强大的工具，它允许开发者通过代码来定义和操作数据库结构。对于使用 MongoDB 的 Laravel 开发者来说，jenssegers/laravel-mongodb 项目提供了对 Schema Builder 的支持，让我们能够以类似关系型数据库的方式管理 MongoDB 的集合和索引。

Schema Builder 基础

Schema Builder 通过 Laravel 的 Facade 模式提供简洁的语法来操作数据库结构。在 MongoDB 上下文中，它主要支持以下功能：

1. 集合管理（创建、删除、检查存在性）
2. 索引管理（创建、删除各种类型的索引）

迁移操作

创建迁移类

在 Laravel-MongoDB 中创建迁移与标准 Laravel 迁移类似，但需要注意以下几点：

use Illuminate\Database\Migrations\Migration;
use MongoDB\Laravel\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateAstronautsCollection extends Migration
{
    public function up()
    {
        Schema::create('astronauts', function (Blueprint $collection) {
            $collection->index('name'); // 创建索引
        });
    }

    public function down()
    {
        Schema::drop('astronauts'); // 删除集合
    }
}

关键点：

• 使用 MongoDB\Laravel\Schema\Blueprint 替代 Laravel 默认的 Blueprint
• 确保数据库配置中正确设置了 MongoDB 连接

执行迁移

运行迁移：

php artisan migrate --path=/database/migrations/your_migration.php

回滚迁移：

php artisan migrate:rollback --path=/database/migrations/your_migration.php

集合操作

检查集合是否存在

if (Schema::hasCollection('stars')) {
    Schema::create('telescopes', function (Blueprint $collection) {
        // 集合创建逻辑
    });
}

索引管理

基本索引操作

创建不同类型的索引：

Schema::create('flights', function (Blueprint $collection) {
    // 单字段索引
    $collection->index('mission_type');
    
    // 复合索引
    $collection->index([
        'launch_location' => 1,
        'launch_date' => -1 // 降序
    ]);
    
    // 唯一索引
    $collection->unique('mission_id', 'unique_mission_id_idx');
});

特殊类型索引

1. 稀疏索引：只索引包含该字段的文档
2. TTL索引：自动过期文档
3. 唯一索引：确保字段值唯一

Schema::create('planets', function (Blueprint $collection) {
    // 稀疏索引
    $collection->index('rings', null, [], ['sparse' => true]);
    
    // TTL索引（1天后过期）
    $collection->expire('last_visible_dt', 86400);
    
    // 组合特性的索引
    $collection->index('last_visible_dt', null, [], [
        'unique' => true,
        'sparse' => true,
        'expireAfterSeconds' => 3600
    ]);
});

地理空间索引

MongoDB 强大的地理空间查询能力依赖于地理空间索引：

Schema::create('spaceports', function (Blueprint $collection) {
    // 2dsphere 索引（支持球面几何计算）
    $collection->geospatial('launchpad_location', '2dsphere');
    
    // 2d 索引（平面几何计算）
    $collection->geospatial('runway_location', '2d');
});

删除索引

Schema::table('flights', function (Blueprint $collection) {
    $collection->dropIndex('unique_mission_id_idx');
});

最佳实践

1. 索引策略：只为常用查询字段创建索引，避免过度索引
2. 迁移顺序：考虑依赖关系合理安排迁移执行顺序
3. 回滚安全：确保 down 方法能正确撤销 up 方法的操作
4. 测试环境：在测试环境验证迁移后再应用到生产环境

注意事项

1. Laravel-MongoDB 的 Schema Builder 不支持 MongoDB 的 JSON Schema 验证功能
2. 集合删除时会自动删除所有关联索引
3. 索引操作在生产环境应谨慎执行，大数据量集合的索引创建可能耗时较长

通过合理使用 Schema Builder，开发者可以以代码化的方式管理 MongoDB 数据结构，实现版本控制和团队协作，这对于项目维护和部署流程都有重要意义。