Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bartventer/gorm-multitenancy
🚀📦 Multi-tenancy support for GORM managed databases
https://github.com/bartventer/gorm-multitenancy
echo gin go gorm iris middleware multitenancy mysql nethttp postgres
Last synced: 22 days ago
JSON representation
🚀📦 Multi-tenancy support for GORM managed databases
- Host: GitHub
- URL: https://github.com/bartventer/gorm-multitenancy
- Owner: bartventer
- License: apache-2.0
- Created: 2023-12-25T08:22:53.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-09-30T12:03:59.000Z (about 1 month ago)
- Last Synced: 2024-10-01T09:06:03.041Z (about 1 month ago)
- Topics: echo, gin, go, gorm, iris, middleware, multitenancy, mysql, nethttp, postgres
- Language: Go
- Homepage:
- Size: 783 KB
- Stars: 39
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-go - gorm-multitenancy - Multi-tenancy support for GORM managed databases. (Database / Database Tools)
README
# gorm-multitenancy
[](https://github.com/avelino/awesome-go)
[](https://pkg.go.dev/github.com/bartventer/gorm-multitenancy/v8)
[](https://github.com/bartventer/gorm-multitenancy/releases/latest)
[](https://goreportcard.com/report/github.com/bartventer/gorm-multitenancy/v8)
[](https://codecov.io/gh/bartventer/gorm-multitenancy)
[](https://github.com/bartventer/gorm-multitenancy/actions/workflows/default.yml)
[](LICENSE)
Photo by Ashley McNamara, via ashleymcnamara/gophers (CC BY-NC-SA 4.0)
## Overview
Gorm-multitenancy provides a Go framework for building multi-tenant applications, streamlining
tenant management and model migrations. It abstracts multitenancy complexities through a unified,
database-agnostic API compatible 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](https://gorm.io/) 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](https://pkg.go.dev/github.com/bartventer/gorm-multitenancy/middleware/echo/v8)
- Gin - [Guide](https://pkg.go.dev/github.com/bartventer/gorm-multitenancy/middleware/gin/v8)
- Iris - [Guide](https://pkg.go.dev/github.com/bartventer/gorm-multitenancy/middleware/iris/v8)
- Net/HTTP - [Guide](https://pkg.go.dev/github.com/bartventer/gorm-multitenancy/middleware/nethttp/v8)
## Installation
Install the core package:
```bash
go get -u github.com/bartventer/gorm-multitenancy/v8
```
Install the database-specific driver:
```bash
# 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:
```bash
# Echo
go get -u github.com/bartventer/gorm-multitenancy/middleware/echo/v8
# Gin
go get -u github.com/bartventer/gorm-multitenancy/middleware/gin/v8
# Iris
go get -u github.com/bartventer/gorm-multitenancy/middleware/iris/v8
# Net/HTTP
go get -u github.com/bartventer/gorm-multitenancy/middleware/nethttp/v8
```
## Getting Started
Check out the [pkg.go.dev](https://pkg.go.dev/github.com/bartventer/gorm-multitenancy/v8) documentation for comprehensive guides and API references.
### Running the Example Application
For a practical demonstration, you can run [the example application](./examples/README.md). It showcases various configurations and usage scenarios.
## Contributing
All contributions are welcome! See the [Contributing Guide](CONTRIBUTING.md) for more details.
## License
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.