Package Exports

prisma-multi-tenant

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (prisma-multi-tenant) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Prisma-multi-tenant 🧭

🧭 Use Prisma as a multi-tenant provider for your application

Note: This package works with Prisma2, if you want the Prisma1 version, checkout prisma-multi-tenant@1.0.3

What's a multi-tenant application?

A multi-tenant 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, we 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.

Install

npm i -g prisma-multi-tenant@alpha

Usage

If this is your first time using prisma-multi-tenant, I strongly suggest that you follow the Getting Started tutorial.

$> prisma-multi-tenant help

  🧭  prisma-multi-tenant v2.0.0-alpha17

  USAGE

    prisma-multi-tenant [command] [args]

    Examples:
        prisma-multi-tenant new
        prisma-multi-tenant migrate my_tenant up
        prisma-multi-tenant env my_tenant -- prisma2 instrospect
        ...

  COMMANDS

    init                       Init multi-tenancy for your application
    list                       List all tenants
    new                        Create a new tenant
    studio <name>              Use Studio to access a tenant
    migrate <name?> <up|down>  Migrate up or down tenants
    delete <name>              Delete one tenant
    generate                   Generate Prisma Clients for the tenants and management
    env <name>                 Set env variables for a specific tenant
    help                       Display this help

  OPTIONS

    -h, --help                 Output usage information for a command
    -V, --version              Output the version number
    --verbose                  Print additional logs

const { MultiTenant } = require('prisma-multi-tenant')

const multiTenant = new MultiTenant()

// The name can come from anywhere (headers, token, ...)
const photon = await multiTenant.get('my_tenant_A')

// Use Photon the same way as before
const users = await photon.users.findMany()

console.log(users)

Documentation

Read more on how prisma-multi-tenant can help you achieve multi-tenancy for your apps:

Getting Started - For newcomers
Complete documentation - For curious people
Contributing guide - For great people
Examples - For everyone

Author

👤 Thibaud Courtoison

Twitter: @Errorname_
Github: @Errorname
Prisma's Slack: @Errorname

🤝 Contributors

🙌 Thanks to @antoinecarat for the reviews of this library

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

This README was generated with ❤️ by readme-md-generator