README

Luminar数据库包是Luminar PHP框架的核心组件。它提供数据库连接管理、ORM功能、模式处理和查询构建，以创建一个简单但强大的接口，用于在PHP中处理数据库。

特性

• 数据库连接管理：轻松管理多个数据库连接。
• ORM（对象关系映射）：使用PHP模型与数据库交互。
• 查询构建器：使用流畅的面向对象接口构建复杂的SQL查询。
• 模式构建器：轻松创建、修改和管理您的数据库模式。
• 迁移管理器：轻松导出和导入数据库，以便在服务器之间迁移。

安装

要使用Luminar Database包，请通过Composer安装它

composer require luminar-organization/database

用法

数据库连接

要创建数据库连接，请使用Connection类。例如，连接到MySQL服务器数据库

use Luminar\Database\Connection\Connection;
$connection = new Connection("mysql:host=localhost;dbname=example-database", "example_user", "example_password")

查询构建器

查询构建器提供了一种流畅的接口，用于构建和执行SQL查询

use Luminar\Database\ORM\QueryBuilder;

$query = (new QueryBuilder())
    ->table("users")
    ->where("id", '=', 1)
    ->limit(1)
    ->get();

echo $query; // Output: SELECT * FROM users WHERE id = 1 LIMIT 1;

ORM（对象关系映射）

使用Entity,Column注解创建自己的实体

use Luminar\Database\ORM\Entity;
use Luminar\Database\ORM\Column;
use Luminar\Database\ORM\EntityManager;
use Luminar\Database\Connection\Connection;

#[Entity(name: "users")] // Table name
class User
{
    /**
    * @var int $id
    */
    #[Column(name: "id")]
    private int $id;
    
    /**
    * @var string $username
    */
    #[Column(name: "username")]
    private string $username;

    /**
    * @return string
    */
    public function getUsername(): string
    {
        return $this->username;
    }
    
    /**
     * @param string $username
    */
    public function setUsername(string $username):void 
    {
        $this->username = $username;
    }
        
    /**
    * @return int
    */
    public function getId(): int
    {
        return $this->id;
    }
    
    /**
     * @param int $id
    */
    public function setId(int $id):void 
    {
        $this->id = $id;
    }
}

$connection = new Connection("your dsn", "example_username", "example_password");
$entityManager = new EntityManager($connection);
$schema = $entityManager->schema($entityManager);
$connection->query($schema);

模式构建器

SchemaBuilder有助于您以编程方式管理数据库模式

use Luminar\Database\Schema\SchemaBuilder;
use Luminar\Database\Connection\Connection;

$connection = new Connection("your dsn", "example_username", "example_password");
$schemaBuilder = new SchemaBuilder($connection);

// Create a table
$sql = $schemaBuilder->create('users', function ($table) {
    $table->addColumn('int', 'id');
    $table->addColumn('varchar', 'name');
});
$connection->query($sql);

// Drop a table
$sql = $schemaBuilder->drop('users');
$connection->query($sql);

迁移管理器

MigrationManager有助于您迁移数据库

use Luminar\Database\Connection\Connection;
use Luminar\Database\Migration\MigrationManager;

$connection = new Connection("your dsn", "example_username", "example_password");
$migrationDir = "YOUR_PATH";
$migrationManager = new MigrationManager($migrationDir, $connection);

// Export Your Database
$export = $migrationDir->export(); // Returns migration name `migrate-XXXXX`

// Importing Database by migration name
$migrationDir->import($export);

测试

提供了单元测试，以确保luminar-organization/databse包的功能。要运行测试，请使用

composer run test

贡献

查看我们核心包中的CONTRIBUTION.md

许可证

Luminar数据库包是开源软件，受MIT许可证许可。