Awesome

gorm-multitenancy

GitHub issues

<img src="https://i.imgur.com/bOZB8St.png" title="GORM Multitenancy" alt="GORM Multitenancy"> Photo by <a href="https://github.com/ashleymcnamara">Ashley McNamara</a>, via <a href="https://github.com/ashleymcnamara/gophers">ashleymcnamara/gophers</a> (CC BY-NC-SA 4.0)

Overview

Gorm-multitenancy provides a framework for implementing multitenancy in Go applications. It simplifies the development and management of multi-tenant applications by offering functionalities for tenant-specific and shared model migrations, alongside thorough tenant management. Central to this package is its ability to abstract multitenancy complexities, presenting a unified, database-agnostic API that integrates seamlessly with GORM.

Multitenancy Approaches

There are three common approaches to multitenancy in a database:

Shared database, shared schema
Shared database, separate schemas
Separate databases

Depending on the database in use, this package utilizes either the "shared database, separate schemas" or "separate databases" strategy, ensuring a smooth integration with your existing database configuration through the provision of tailored drivers.

Features

GORM Integration: Simplifies GORM usage in multi-tenant environments, offering a unified API alongside direct access to driver-specific APIs for flexibility.
Custom Database Drivers: Enhances existing drivers for easy multitenancy setup without altering initialization.
HTTP Middleware: Provides middleware for easy tenant context management in web applications.

Supported Databases

Database	Approach
PostgreSQL	Shared database, separate schemas
MySQL	Separate databases

Router Integration

Echo - Guide
Gin - Guide
Net/HTTP - Guide

Installation

Install the core package:

go get -u github.com/bartventer/gorm-multitenancy/v8

Install the database-specific driver:

# PostgreSQL
go get -u github.com/bartventer/gorm-multitenancy/postgres/v8

# MySQL
go get -u github.com/bartventer/gorm-multitenancy/mysql/v8

Optionally, install the router-specific middleware:

# Echo
go get -u github.com/bartventer/gorm-multitenancy/middleware/echo/v8

# Gin
go get -u github.com/bartventer/gorm-multitenancy/middleware/gin/v8

# Net/HTTP
go get -u github.com/bartventer/gorm-multitenancy/middleware/nethttp/v8

Getting Started

Check out the pkg.go.dev documentation for comprehensive guides and API references.

Running the Example Application

For a practical demonstration, you can run the example application. It showcases various configurations and usage scenarios.

Contributing

All contributions are welcome! See the Contributing Guide for more details.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.