tenanti - GitLite

KO | EN

gitlite — search

#python #llm #go #golang #rust #linux #docker #awesome #cli #kubernetes #awesome-list #mcp #openai #open-source

tenanti

(★ 587)

[Package] Multi-tenant Database Schema Manager for Laravel

파일 탐색기

최종 버전 다운로드 (.zip)

- - 1_Bug_report.md
  - 2_Feature_request.md
- - analyse.yml
  - coveralls.yml
  - tests.yml
- FUNDING.yml
- config.php
- - BaseCommand.php
  - InstallCommand.php
  - MigrateCommand.php
  - MigrateMakeCommand.php
  - QueuedCommand.php
  - RefreshCommand.php
  - ResetCommand.php
  - RollbackCommand.php
  - TinkerCommand.php
- - Factory.php
  - Notice.php
  - TenantProvider.php
- - Builder.php
  - Model.php
  - Tenantee.php
- - CreateTenant.php
  - DeleteTenant.php
  - Job.php
- - Factory.php
  - MigrationWriter.php
  - Migrator.php
  - Notable.php
  - Operation.php
- - Command.php
- CommandServiceProvider.php
- Migration.php
- Observer.php
- TenantiManager.php
- TenantiServiceProvider.php
- Tenantor.php
- - ServiceProviderTest.php
- - ObserverTest.php
  - TenantiManagerTest.php
  - TenantiServiceProviderTest.php
  - TenantorTest.php
- Kernel.php
- TestCase.php
.coveralls.yml
.gitattributes
.gitignore
.php_cs
canvas.yaml
CHANGELOG-5.x.md
CHANGELOG-6.x.md
composer.json
LICENSE
phpstan-baseline.neon
phpstan.neon.dist
phpunit.xml
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/orchestral/tenanti

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd tenanti

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. PHP (Composer)

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
PHP PHP 실행 환경이 필요합니다.
Composer PHP 라이브러리 설치를 위한 패키지 매니저입니다.

composer require "orchestra/tenanti"

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ php -S localhost:8000 같은 내장 서버로 실행한 뒤 브라우저에서 http://localhost:8000 으로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Multi-tenant Database Schema Manager for Laravel
==============

Tenanti allow you to manage multi-tenant data schema and migration manager for your Laravel application.

[![tests](https://github.com/orchestral/tenanti/workflows/tests/badge.svg?branch=6.x)](https://github.com/orchestral/tenanti/actions?query=workflow%3Atests+branch%3A6.x)
[![Latest Stable Version](https://poser.pugx.org/orchestra/tenanti/v/stable)](https://packagist.org/packages/orchestra/tenanti)
[![Total Downloads](https://poser.pugx.org/orchestra/tenanti/downloads)](https://packagist.org/packages/orchestra/tenanti)
[![Latest Unstable Version](https://poser.pugx.org/orchestra/tenanti/v/unstable)](https://packagist.org/packages/orchestra/tenanti)
[![License](https://poser.pugx.org/orchestra/tenanti/license)](https://packagist.org/packages/orchestra/tenanti)
[![Coverage Status](https://coveralls.io/repos/github/orchestral/tenanti/badge.svg?branch=6.x)](https://coveralls.io/github/orchestral/tenanti?branch=6.x)

## Version Compatibility

Laravel  | Tenanti
:--------|:---------
 5.5.x   | 3.5.x
 5.6.x   | 3.6.x
 5.7.x   | 3.7.x
 5.8.x   | 3.8.x
 6.x     | 4.x
 7.x     | 5.x
 8.x     | 6.x

## Installation

To install through composer, run the following command from terminal:

```bash
composer require "orchestra/tenanti"
```

## Configuration

Next add the following service provider in `config/app.php`.

```php
'providers' => [

// ...
    Orchestra\Tenanti\TenantiServiceProvider::class,
    Orchestra\Tenanti\CommandServiceProvider::class,
],
```

> The command utility is enabled via `Orchestra\Tenanti\CommandServiceProvider`.

### Aliases

To make development easier, you could add `Orchestra\Support\Facades\Tenanti` alias for easier reference:

```php
'aliases' => [

'Tenanti' => Orchestra\Support\Facades\Tenanti::class,

],
```

### Publish Configuration

To make it easier to configuration your tenant setup, publish the configuration:

```bash
php artisan vendor:publish
```

## Usage

### Configuration Tenant Driver for Single Database

Open `config/orchestra/tenanti.php` and customize the drivers.

```php
<?php

return [
    'drivers' => [
        'user' => [
            'model' => App\User::class,
            'paths' => [
                database_path('tenanti/user'),
            ],
            'shared' => true,
        ],
    ],
];
```

You can customize, or add new driver in the configuration. It is important to note that `model` configuration only work with `Eloquent` instance.

#### Setup migration autoload

For each driver, you should also consider adding the migration path into autoload (if it not already defined). To do this you can edit your `composer.json`.

##### composer.json

```json
{
    "autoload": {
        "classmap": [
            "database/tenant/users"
        ]
    }
}
```

### Setup Tenantor Model

Now that we have setup the configuration, let add an observer to our `User` class:

```php
<?php

namespace App;

use App\Observers\UserObserver;
use Orchestra\Tenanti\Tenantor;
use Illuminate\Notifications\Notifiable;
use Orchestra\Tenanti\Contracts\TenantProvider;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable implements TenantProvider
{
    use Notifiable;

/**
     * Convert to tenantor.
     * 
     * @return \Orchestra\Tenanti\Tenantor
     */
    public function asTenantor(): Tenantor
    {
        return Tenantor::fromEloquent('user', $this);
    }

/**
     * Make a tenantor.
     *
     * @return \Orchestra\Tenanti\Tenantor
     */
    public static function makeTenantor($key, $connection = null): Tenantor
    {
        return Tenantor::make(
            'user', $key, $connection ?: (new static())->getConnectionName()
        );
    }

/**
     * The "booting" method of the model.
     */
    protected static function boot()
    {
        parent::boot();

static::observe(new UserObserver);
    }
}
```

and your `App\Observers\UserObserver` class should consist of the following:

```php
<?php

namespace App\Observers;

use Orchestra\Tenanti\Observer;

class UserObserver extends Observer
{
    public function getDriverName()
    {
        return 'user';
    }
}
```

## Console Support

Tenanti include additional command to help you run bulk migration when a new schema is created, the available command resemble the usage available from `php artisan migrate` namespace.

Command                                      | Description
:--------------------------------------------|:--------------------------------------------
 php artisan tenanti:install {driver}        | Setup migration table on each entry for a given driver.
 php artisan tenanti:make {driver} {name}    | Make a new Schema generator for a given driver.
 php artisan tenanti:migrate {driver}        | Run migration on each entry for a given driver.
 php artisan tenanti:rollback {driver}       | Rollback migration on each entry for a given driver.
 php artisan tenanti:reset {driver}          | Reset migration on each entry for a given driver.
 php artisan tenanti:refresh {driver}        | Refresh migration (reset and migrate) on each entry for a given driver.
 php artisan tenanti:queue {driver} {action} | Execute any of above action using separate queue to minimize impact on current process.
 php artisan tenanti:tinker {driver} {id}    | Run tinker using a given driver and ID.

## Multi Database Connection Setup

Instead of using Tenanti with a single database connection, you could also setup a database connection for each tenant.

### Configuration Tenant Driver for Multiple Database

Open `config/orchestra/tenanti.php` and customize the drivers.

```php
<?php

return [
    'drivers' => [
        'user' => [
            'model' => App\User::class,
            'paths' => [
                database_path('tenanti/user'),
            ],
            'shared' => false,
        ],
    ],
];
```

By introducing a `migration` config, you can now setup the migration table name to be `tenant_migrations` instead of `user_{id}_migrations`.

### Database Connection Resolver

For tenanti to automatically resolve your multiple database connection, we need to setup the resolver. You can do this via:

```php
<?php namespace App\Providers;

use Orchestra\Support\Facades\Tenanti;

class AppServiceProvider extends ServiceProvider
{
    public function boot()
    {
        Tenanti::connection('tenants', function (User $entity, array $config) {
            $config['database'] = "acme_{$entity->getKey()}"; 
            // refer to config under `database.connections.tenants.*`.

return $config;
        });
    }
}
```

Behind the scene, `$config` will contain the template database configuration fetch from `"database.connections.tenants"` (based on the first parameter `tenants`). We can dynamically modify the connection configuration and return the updated configuration for the tenant.

### Setting Default Database Connection

Alternatively you can also use Tenanti to set the default database connection for your application:

```php

use App\User;
use Orchestra\Support\Facades\Tenanti;

// ...

$user = User::find(5);

Tenanti::driver('user')->asDefaultConnection($user, 'tenants_{id}');
```

> Most of the time, this would be use in a Middleware Class when you resolve the tenant ID based on `Illuminate\Http\Request` object.