multi-tenancy-bundle

KO | EN

gitlite — search

#javascript #python #ai #typescript #go #rust #windows #awesome #kubernetes #awesome-list #security #pytorch #openai #open-source

multi-tenancy-bundle

(★ 11)

WARNING: this repo is not maintained anymore.

multi-tenancy-bundle 최신버젼 다운로드

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

multi-tenancy-bundle
====================

**WARNING: this repo is not maintained anymore**

Symfony bundle for multiple tenancy.

Multi-tenancy, is a package for symfony and doctrine to manage tenants in a simple way. The package has 2 main entities:

* Tenant
* Hostname

Basically a **tenant** is the way to reuse your default code and a **hostname** is the FQDN (Fully Qualified Domain Name) for example: tenant.example.com, the bundle set the tenancy connection based on this FQDN.

Installation
------------

Via composer

```console
    composer require mapeveri/multi-tenancy-bundle
```

Configuration
-------------

1. Configuration .env file

Mysql

```txt
DATABASE_URL="mysql://user:password8@127.0.0.1:3306/databaseName?serverVersion=5.7&charset=utf8"
DATABASE_TENANT_URL=${DATABASE_URL}
```

PostgreSql

```txt
DATABASE_URL="postgresql://user:password@localhost:5432/databaseName?charset=utf8"
DATABASE_TENANT_URL=${DATABASE_URL}
```

2. doctrine.yaml configuration

Mysql:

```yaml
doctrine:
    dbal:
        default_connection: default
        connections:
            default:
                url: '%env(resolve:DATABASE_URL)%'
                driver: 'pdo_mysql'
                server_version: '5.7'
                charset: utf8mb4

tenant:
                driver: 'pdo_mysql'
                server_version: '5.7'
                charset: utf8mb4
                url: '%env(resolve:DATABASE_TENANT_URL)%'
                wrapper_class: MultiTenancyBundle\Doctrine\DBAL\TenantConnectionWrapper

orm:
        default_entity_manager: default
        entity_managers:
            default:
                connection: default
                mappings:
                    Main:
                        is_bundle: false
                        type: annotation
                        dir: '%kernel.project_dir%/src/Entity/Main'
                        prefix: 'App\Entity\Main'
                        alias: Main
                    MultiTenancyBundle:
                        is_bundle: true
                        type: annotation
                        dir: 'Entity'
                        prefix: 'MultiTenancyBundle\Entity'
                        alias: MultiTenant
            tenant:
                connection: tenant
                mappings:
                    Tenant:
                        is_bundle: false
                        type: annotation
                        dir: '%kernel.project_dir%/src/Entity/Tenant'
                        prefix: 'App\Entity\Tenant'
                        alias: Tenant
```

PostgreSql:

```yaml
doctrine:
    dbal:
        default_connection: default
        connections:
            default:
                url: '%env(resolve:DATABASE_URL)%'
                driver: 'pdo_psql'
                server_version: '12.8'
                charset: utf8mb4

tenant:
                driver: 'pdo_psql'
                server_version: '12.8'
                charset: utf8mb4
                schema_filter: ~^(?!public)~
                url: '%env(resolve:DATABASE_TENANT_URL)%'
                wrapper_class: MultiTenancyBundle\Doctrine\DBAL\TenantConnectionWrapper

orm:
        default_entity_manager: default
        entity_managers:
            default:
                connection: default
                mappings:
                    Main:
                        is_bundle: false
                        type: annotation
                        dir: '%kernel.project_dir%/src/Entity/Main'
                        prefix: 'App\Entity\Main'
                        alias: Main
                    MultiTenancyBundle:
                        is_bundle: true
                        type: annotation
                        dir: 'Entity'
                        prefix: 'MultiTenancyBundle\Entity'
                        alias: MultiTenant
            tenant:
                connection: tenant
                mappings:
                    Tenant:
                        is_bundle: false
                        type: annotation
                        dir: '%kernel.project_dir%/src/Entity/Tenant'
                        prefix: 'App\Entity\Tenant'
                        alias: Tenant
```

3. Configuration to doctrine_migrations.yaml

```yaml
doctrine_migrations:
  migrations_paths:
    'DoctrineMigrations': 'migrations/Main'
    'DoctrineMigrationsTenant': 'migrations/Tenant'
```

**It's important to keep** DoctrineMigrations and DoctrineMigrationsTenant namespaces.

4. Add the bundle to bundles.php

```php
return [
    ...
    MultiTenancyBundle\MultiTenancyBundle::class => ['all' => true],
    ...
];
```

Commands for main database
--------------------------

In this case we can use doctrine commands:

```console
    php bin/console doctrine:migrations:status
```

```console
    php bin/console doctrine:migrations:diff
```

```console
    php bin/console doctrine:migrations:migrate
```

Commands for tenants
--------------------

Genarate migrations

```console
    php bin/console tenancy:diff tenant
```

Status migrations

```console
    php bin/console tenancy:status tenant --tenant=tenant1
```

Migrate single tenant

```console
    php bin/console tenancy:migrate tenant --tenant=tenant1
```

Migrate all tenants

```console
    php bin/console tenancy:migrate tenant
```

In all cases the first parameter is the entity manager name and the option --tenant is the tenant name.

Supported databases
-------------------

Right now it works with MySql and PostgreSql.

Usage
-----

Create a new tenant:

```php

$entityManager = $this->getDoctrine()->getManager();

$tenant = new Tenant();
        $uuid = Uuid::v4();
        $tenant->setUuid($uuid->toRfc4122());
        $entityManager->persist($tenant);
        $entityManager->flush();

$hostname = new Hostname();
        $hostname->setTenant($tenant);
        $hostname->setFqdn("tenant1");

$entityManager->persist($hostname);
        $entityManager->flush();
```

Remove a tenant:

```php

$doctrine = $this->getDoctrine();
        $entityManager = $doctrine->getManager();

$hostname = $doctrine
            ->getRepository(Hostname::class)
            ->find($hostId);
        $entityManager->remove($hostname);

$tenant = $doctrine
            ->getRepository(Tenant::class)
            ->find($tenantId);

$entityManager->remove($tenant);
        $entityManager->flush();
```

Events
------

The bundle use the event dispatcher component to dispatch events, which are: MultiTenancyEvents::TENANT_CREATED and MultiTenancyEvents::TENANT_REMOVED.

multi-tenancy-bundle

multi-tenancy-bundle 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

multi-tenancy-bundle

multi-tenancy-bundle 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README