Databases and multitenancy

Multitenancy in MicroPowerManager

Multitenancy in MicroPowerManager is implemented using a database-per-tenant approach, where each tenant has a dedicated database. This ensures data isolation, enhances security, and allows for more flexible scaling. By storing each tenant's data in a separate database, MicroPowerManager enables efficient management of Software as a Service (SaaS) functionality while maintaining performance and customization per tenant.

Tenant Representation

Each tenant in MicroPowerManager represents an individual company leveraging the platform for their Customer Relationship Management (CRM) needs.

INFO

In the context of Multitenancy we are sometimes using the words Company and Tenant interchangeably.

Central Database - "micro_power_manager"

To facilitate this, a central database named micro_power_manager is established. This central database houses company-specific information and common data such as installable plugins.

New Company Registration Process

When a new company registers an account, a dedicated database is dynamically created for that specific company. This new database incorporates MicroPowerManager's central migration files located at src/backend/database/migrations/tenant

User Session Interaction

Upon successful registration, when a user associated with a particular company logs into MicroPowerManager, the database connection for their session is dynamically altered. This ensures that the user gains access to and interacts with data exclusive to their company, providing a personalized and secure experience within the application.

Tenant Specific Migration Commands

• Creating Migration File (central): To create a migration file for the central database use the following command:

  docker exec -it backend-dev bash
  php artisan make:migration {migration-name}

  This command creates a migration file in MicroPowerManager's central migration files location: src/backend/database/migrations/

• Creating Migration File (tenant): To create a migration file for tenant database(s) use the following command:

  docker exec -it backend-dev bash
  php artisan make:migration-tenant {migration-name}

  This command creates a migration file in MicroPowerManager's tenant migration files location: src/backend/database/migrations/tenant

• Running Migrations (central): To migrate the central database, use the following command:

  docker exec -it backend-dev bash
  php artisan migrate

• Running Migrations (tenant): To igrate the database for a specific company using the following command:

  docker exec -it backend-dev bash
  php artisan migrate-tenant {company_id} {--force}