Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/errorname/prisma-multi-tenant
🧭 Use Prisma as a multi-tenant provider for your application
https://github.com/errorname/prisma-multi-tenant
multi-tenant prisma
Last synced: about 1 month ago
JSON representation
🧭 Use Prisma as a multi-tenant provider for your application
- Host: GitHub
- URL: https://github.com/errorname/prisma-multi-tenant
- Owner: Errorname
- License: mit
- Created: 2018-12-11T15:23:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-08T02:31:46.000Z (over 1 year ago)
- Last Synced: 2024-05-05T10:20:53.695Z (about 1 month ago)
- Topics: multi-tenant, prisma
- Language: TypeScript
- Homepage:
- Size: 4.18 MB
- Stars: 386
- Watchers: 16
- Forks: 45
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- Contributing: docs/Contributing_Guide.md
- License: LICENSE
Lists
- awesome-prisma - Multi-tenancy with Prisma
README
Prisma-multi-tenant 🧭
> 🧭 Use Prisma as a multi-tenant provider for your application
**What's a multi-tenant application?**
A [multi-tenant](https://en.wikipedia.org/wiki/Multitenancy) application is when a single instance of your application runs on a server and serves multiple tenants.
> With a multi-tenant architecture, a software application is designed to provide every tenant a dedicated share of the instance - including its data, configuration, user management, tenant individual functionality and non-functional properties.
For example, you could run a social-network for companies, where each company would have it's own data and users.
**Why is Prisma great for multi-tenancy?**
Prisma gives you all the tools necessary to handle your database: data modeling, database schema migrations, type safe database access, etc. Doing so, `prisma-multi-tenant` can then automate those processes and help you make a multi-tenant application.
**Why do I need `prisma-multi-tenant`?**
Because `prisma-multi-tenant` does not only allow you to access multiple databases seamlessly with only a couple of lines of code in your server, but it also let you use the CLI to create new tenants and assure consistancy between all your databases as easily as possible.
## Installation
```sh
npm i -g prisma-multi-tenant
prisma-multi-tenant init # Init multi-tenancy in your Prisma project
```
## Usage
> If this is your first time using `prisma-multi-tenant`, I **strongly suggest** that you follow the ✨ [**Getting Started**](/docs/Getting_Started.md) ✨ tutorial.
```
$> prisma-multi-tenant help
🧭 prisma-multi-tenant v2.4.1
USAGE
prisma-multi-tenant [command] [args]
Examples:
prisma-multi-tenant new
prisma-multi-tenant migrate my_tenant up
prisma-multi-tenant env my_tenant -- npx @prisma/cli instrospect
...
COMMANDS
init Init multi-tenancy for your application
list List all tenants
new Create a new tenant or management
studio Use Studio to access a tenant
migrate Migrate tenants (up, down, save)
delete Delete one tenant
generate Generate Prisma Clients for the tenants and management
env Set env variables for a specific tenant
eject Eject prisma-multi-tenant from your application
help Display this help
OPTIONS
-h, --help Output usage information for a command
-V, --version Output the version number
-e, --env Load env file given as parameter
--verbose Print additional logs
```
```js
const { MultiTenant } = require('@prisma-multi-tenant/client')
const multiTenant = new MultiTenant()
// The name can come from anywhere (headers, token, ...)
const prisma = await multiTenant.get('my_tenant_A')
// Use Prisma-Client the same way as before
const users = await prisma.user.findMany()
console.log(users)
```
## Documentation
Read more on how `prisma-multi-tenant` can help you achieve multi-tenancy for your apps:
- ✨ [**Getting Started**](/docs/Getting_Started.md) ✨
- [Complete documentation](/docs/Complete_Documentation.md)
- [How to integrate with:](/docs/integrations)
- [Express](/docs/integrations/Express.md)
- [Apollo](/docs/integrations/Apollo.md)
- [Blitz](/docs/integrations/Blitz.md)
- [Redwood](/docs/integrations/Redwood.md)
- Bison (TODO)
- [Examples](/docs/examples)
- [Basic (JS)](/docs/examples/basic-js)
- [Basic (TS)](/docs/examples/basic-ts)
- [Express](/docs/examples/express)
- [Apollo](/docs/examples/apollo)
- [Blitz](/docs/examples/blitz)
- [Redwood](/docs/examples/redwood)
- Bison (TODO)
- [Issues with Vercel](/docs/Vercel.md)
- [Contributing guide](/docs/Contributing_Guide.md)
## Author
👤 **Thibaud Courtoison**
- Twitter: [@Errorname\_](https://twitter.com/Errorname_)
- Github: [@Errorname](https://github.com/Errorname)
- Prisma's Slack: [@Errorname](https://slack.prisma.io/)
## 🤝 Contributors
Contributions, issues, and feature requests are welcome! 🙌
Feel free to check [issues page](https://github.com/Errorname/prisma-multi-tenant/issues).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2020 [Thibaud Courtoison](https://github.com/Errorname).
This project is [MIT](https://github.com/Errorname/prisma-multi-tenant/blob/master/LICENSE) licensed.