.. Django Multi-tenant documentation master file, created by
    sphinx-quickstart on Mon Feb 13 13:32:28 2023.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.

Welcome to ActiveRecord Multi-tenant's documentation!
======================================================

|Build Status| |Coverage Status| |RubyGems Version| |Gem Downloads| |Latest Documentation Status|

.. |Build Status| image:: https://github.com/citusdata/activerecord-multi-tenant/actions/workflows/active-record-multi-tenant-tests.yml/badge.svg
   :target: https://github.com/citusdata/activerecord-multi-tenant/actions/workflows/active-record-multi-tenant-tests.yml
   :alt: Build Status

.. |Coverage Status| image:: https://codecov.io/gh/citusdata/activerecord-multi-tenant/branch/master/graph/badge.svg?token=rw0TsEk4Ld
   :target: https://codecov.io/gh/citusdata/activerecord-multi-tenant
   :alt: Coverage Status

.. |RubyGems Version| image:: https://img.shields.io/gem/v/activerecord-multi-tenant.svg
   :target: https://rubygems.org/gems/activerecord-multi-tenant

.. |Gem Downloads| image:: https://img.shields.io/gem/dt/activerecord-multi-tenant.svg
    :target: https://rubygems.org/gems/activerecord-multi-tenant
    :alt: Gem Downloads

.. |Latest Documentation Status| image:: https://readthedocs.org/projects/django-multitenant/badge/?version=latest
   :target: https://activerecord-multi-tenant.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status


activerecord-multi-tenant Documentation
========================================

Welcome to the official documentation for ``activerecord-multi-tenant``, a powerful and flexible gem for adding multi-tenancy support to your Rails applications using ActiveRecord.

.. toctree::
   :maxdepth: 2
   :caption: Table of Contents

   introduction
   getting-started
   usage-guide
   guides-and-tutorials
   api-reference
   troubleshooting
   contributing
   changelog
   community-and-support
   appendix
   license

This documentation provides a comprehensive guide to using ``activerecord-multi-tenant``, including installation and configuration instructions, usage examples, API reference, troubleshooting tips, and more.

Whether you're new to multi-tenancy or an experienced developer looking to integrate ``activerecord-multi-tenant`` into your existing Rails application, this documentation aims to provide the information you need.