Giter VIP home page Giter VIP logo

django_table_sharding_example's Introduction

Django分表示例

Django中横向分表的一个简单实现,支持基于固定分片数量的分表和基于年、月、日的日期分表

源由

无意中看了知乎的一个问答【Django分表如何实现】,之前也遇到过横向分表的需求,当时采用的是数据库的表分区来实现的,这种方式对业务代码透明,无需任何改动。看到有人提出了代码实现这个问题,总结了知友们的回答和做了些简单包装,写了这个demo,增加按日期分表和自动数据库migration迁移功能,和分表的分页功能,欢迎大神们查漏补缺。

实现

定义了一个ShardingMixin(详见apps.base.model_sharding.py)混入类,继承了该混入类的抽象模型类可调用类方法shard,根据传入的值来获取对应分表的模型类实例来进行ORM操作,如:models.User.shard(0).objects.create(name='iTraceur', age=18)models.Log.shard(202001).objects.create(content='test log')。 django启动前,需手动执行一次migration创建初始数库表,django启动后,当分表模型不存在时会自动创建和自动做数据库migration迁移,无需手动执行迁移和创建数据库表。

通用settings

  • SHARDING_COUNT_DEFAULT固定数量分表的通用数量,默认为10
  • SHARDING_DATE_START_DEFAULT日期分表的通用开始日期,默认为2020-01-01
  • SHARDING_DATE_FORMAT_DEFAULT日期分表的通用表名日期后缀格式,如:%Y%Y%m%Y%m%d,默认为%Y%m按月分表

基于固定分片数量的分表(适用于用户表这种数据量大且可估量的场景)

  • 定义模型时需设置类属性SHARDING_TYPE='precise'
  • 如需单独对某个模型设置分表数量,可在定义模型时设置SHARDING_COUNT类属性为对应的值。
class User(models.Model, model_sharding.ShardingMixin):
    name = models.CharField(max_length=20)
    age = models.IntegerField(default=0)
    active = models.BooleanField(default=True)

    # Constant-based sharding
    SHARDING_TYPE = 'precise'
    SHARDING_COUNT = 10

    class Meta:
        abstract = True
        db_table = "user_"
        
# 分表模型类初始化
def init_user_models():
    admin_opts = {
        'list_display': ('id', 'name', 'age', 'active')
    }
    model_sharding.register_admin_opts(User._meta.label_lower, admin_opts)

    for sharding in User.get_sharding_list():
        model_sharding.create_model(User, sharding)

init_user_models()

基于日期的分表(适用于日志记录这种随时间增长的场景)

  • 定义模型时需设置类属性SHARDING_TYPE='date'
  • 如需单独对某个模型设置分表开始日期,可在定义模型时设置SHARDING_DATE_START类属性为对应的日期
  • 如需单独对某个模型设置分表的表名后缀格式,可在定义模型时设置SHARDING_DATE_FORMAT类属性来控制按年、按月、按日进行分表,分别为:%Y%Y%m%Y%m%d
class Log(models.Model, model_sharding.ShardingMixin):
    level = models.PositiveSmallIntegerField(default=0)
    content = models.TextField()
    time = models.DateTimeField(auto_now_add=True)

    # Date-based sharding
    SHARDING_TYPE = 'date'
    SHARDING_DATE_START = '2020-03-01'
    SHARDING_DATE_FORMAT = '%Y%m'

    class Meta:
        abstract = True
        db_table = "log_"

# 分表模型类初始化
def init_log_models():
    admin_opts = {
        'list_display': ('id', 'time', 'level', 'content')
    }
    model_sharding.register_admin_opts(Log._meta.label_lower, admin_opts)

    for sharding in Log.get_sharding_list():
        model_sharding.create_model(Log, sharding)

init_log_models()

Links

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.