DjanQuiltDB - Django Database Sharding

Easy horizontal database sharding that allows for scaling and faster queries.

Release 4.2.0.

Getting started

• Overview
  • Hierarchy
  • The Problem
  • The solution
  • Shards
  • Mapping table
  • Shared data and schema selection
  • The complication: relations and id collision
  • Another scaling problem?
  • Multi node, multi shard
  • What schema cloning carries - and what it does not
• Installation
  • Installing djanquiltdb
  • Optional extras
  • Creating models
  • Make migrations
  • Configuration

Guides

• Sharding modes
• Queries
  • Overriding a connection
  • The sharding context
  • Object context persistence
  • Sharding Options
  • Connections
  • .using()
• Requests and middleware
  • Handling unavailable shards
  • Selecting a shard per request
  • Storing the shard selector in the session
• Forms
• Migrations
  • Making migrations
  • Calling migrate
  • Options
  • Router considerations
• Fixtures
  • Introduction
  • The _schema Property
  • Supported Formats
  • Usage
  • Example Fixture Files
  • Special Schema Names
  • Schema Creation

Database objects

• Database views
  • Creating a view
  • Where a view belongs
  • What a new shard inherits
  • Materialized views
  • Triggers on views
  • Renaming a table during a rolling deploy
  • With the postgres-objects extra
• Database functions
  • Creating a function
  • Where a function belongs
  • What a new shard inherits
  • Where functions turn up
  • Calling a function from Django
  • With the postgres-objects extra
• Triggers
  • How triggers are cloned
  • Using django-pgtrigger
  • Why the management commands do not work
• Generated columns
  • Declaring a generated column
  • Which function the clone binds to
  • Moving data between shards
  • Public functions reaching sharded tables
  • With the postgres-objects extra

Shard operations

• Align Shards With Template
  • Introduction
  • Command usage
• Move Data To Shard
  • Introduction
  • Command usage
• Move Shard To Node
  • Introduction
• Purge Shard Data
  • Introduction
  • Command usage

Contrib packages are optional Django apps that ship inside djanquiltdb, under djanquiltdb.contrib. Each one is enabled by adding it to INSTALLED_APPS.

Contrib packages

• Authentication
• Admin shard switcher

Optional features are plugins: distributions that are installed separately, through an extra of djanquiltdb. DjanQuiltDB finds them through the djanquiltdb.plugins entry-point group.

Integrations

• Celery
  • Celery shard unavailable decorator
• postgres-objects
  • Things to know
• pghistory
  • Things to know

Reference

• Settings
  • QUILT_DB
  • DATABASE_ROUTERS
  • QUILT_SESSIONS
• System checks
• API reference
  • Sharding modes
  • Decorators
  • Models
  • Routing
  • Utilities
  • Transactions
  • Forms
  • Middleware
  • Test support
  • Plugins
• Changelog
  • v 4.2.0
  • v 4.1.0
  • v 4.0.1
  • v 4.0.0
  • v 3.1.2
  • v 3.1.1
  • v 3.1.0
  • v 3.0.0
  • v 2.0.0
  • v 1.0.0
  • v 0.6.3
  • v 0.6.2
  • v 0.6.1
  • v 0.6.0
  • v 0.5.4
  • v 0.5.3
  • v 0.5.2
  • v 0.5.1

Indices and tables

• Index

• Module Index

• Search Page