Refactoring code and supporting new partitioning

Author: monouno

README.rst

@@ -1,47 +1,56 @@
-django-pg-timepart
-==================
+django-pg-partitioning
+======================
 .. image:: https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square
- :target: https://raw.githubusercontent.com/chaitin/django-pg-timepart/master/LICENSE
+ :target: https://raw.githubusercontent.com/chaitin/django-pg-partitioning/master/LICENSE
 .. image:: https://img.shields.io/badge/Django-2.0_2.1-green.svg?style=flat-square&logo=django
  :target: https://www.djangoproject.com/
 .. image:: https://img.shields.io/badge/PostgreSQL-11-lightgrey.svg?style=flat-square&logo=postgresql
  :target: https://www.postgresql.org/
-.. image:: https://readthedocs.org/projects/django-pg-timepart/badge/?version=latest&style=flat-square
- :target: https://django-pg-timepart.readthedocs.io/en/latest/
-.. image:: https://img.shields.io/pypi/v/django-pg-timepart.svg?style=flat-square
- :target: https://pypi.org/project/django-pg-timepart/
-.. image:: https://api.travis-ci.org/chaitin/django-pg-timepart.svg?branch=master
- :target: https://travis-ci.org/chaitin/django-pg-timepart
+.. image:: https://readthedocs.org/projects/django-pg-partitioning/badge/?version=latest&style=flat-square
+ :target: https://django-pg-partitioning.readthedocs.io/en/latest/
+.. image:: https://img.shields.io/pypi/v/django-pg-partitioning.svg?style=flat-square
+ :target: https://pypi.org/project/django-pg-partitioning/
+.. image:: https://api.travis-ci.org/chaitin/django-pg-partitioning.svg?branch=master
+ :target: https://travis-ci.org/chaitin/django-pg-partitioning
 .. image:: https://api.codacy.com/project/badge/Grade/c872699c1b254e90b540b053343d1e81
- :target: https://www.codacy.com/app/xingji2163/django-pg-timepart?utm_source=github.com&utm_medium=referral&utm_content=chaitin/django-pg-timepart&utm_campaign=Badge_Grade
-.. image:: https://codecov.io/gh/chaitin/django-pg-timepart/branch/master/graph/badge.svg
- :target: https://codecov.io/gh/chaitin/django-pg-timepart
+ :target: https://www.codacy.com/app/xingji2163/django-pg-partitioning?utm_source=github.com&utm_medium=referral&utm_content=chaitin/django-pg-partitioning&utm_campaign=Badge_Grade
+.. image:: https://codecov.io/gh/chaitin/django-pg-partitioning/branch/master/graph/badge.svg
+ :target: https://codecov.io/gh/chaitin/django-pg-partitioning
 
-一个实现 PostgreSQL 表基于日期进行分区和管理的 Django 扩展。
-它适用于像记录日志、消息或文章等具有时间列的巨型表进行分区管理，定期创建新的分区并归档旧的分区。
+一个支持 PostgreSQL 11 原生表分区的 Django 扩展，使您可以在 Django 中创建分区表并管理它们。目前它支持两种分区类型：
+
+- 时间范围分区（Time Range Partitioning）:将时序数据分开存储到不同的时间范围分区表中，支持创建连续且不重叠的时间范围分区并进行归档管理。
+- 列表分区（List Partitioning）:根据分区字段的确定值将数据分开存储到不同的分区表中。
 
 ----
 
-A Django extension that implements PostgreSQL tables for partitioning and management based on dates.
-It is suitable for partition management of giant tables with time columns like logging, messages or articles,
-periodically creating new partitions and archiving old partitions.
+A Django extension that supports PostgreSQL 11 native table partitioning, allowing you to create partitioned tables in Django
+and manage them. Currently it supports the following two partition types:
+
+- Time Range Partitioning: Separate time series data into different time range partition tables,
+ support the creation of continuous and non-overlapping time range partitions and archival management.
+- List Partitioning: Store data separately into different partition tables based on the determined values of the partition key.
 
 Documentation
- https://django-pg-timepart.readthedocs.io/en/latest/
+ https://django-pg-partitioning.readthedocs.io/en/latest/
 
 TODO
 ----
-* Improve documentation and testing.
+- Improve documentation and testing.
+- Optimization implementation.
 
 maybe more...
 
 Contributing
 ------------
-
 If you want to contribute to a project and make it better, you help is very welcome!
-Please read through `Contributing Guidelines <https://raw.githubusercontent.com/chaitin/django-pg-timepart/master/CONTRIBUTING.rst>`__.
+Please read through `Contributing Guidelines <https://github.com/chaitin/django-pg-partitioning/blob/master/CONTRIBUTING.rst>`__.
 
 License
 -------
+This project is licensed under the MIT. Please see `LICENSE <https://raw.githubusercontent.com/chaitin/django-pg-partitioning/master/LICENSE>`_.
 
-django-pg-timepart is licensed under the MIT. Please see `LICENSE <https://raw.githubusercontent.com/chaitin/django-pg-timepart/master/LICENSE>`_.
+Project Practice
+----------------
+.. image:: https://raw.githubusercontent.com/chaitin/django-pg-partitioning/master/docs/source/_static/safeline.svg
+ :target: https://www.chaitin.cn/en/safeline

docs/source/_static/safeline.svg

@@ -1,13 +1,30 @@
 API Reference
 =============
 
-.. module:: pg_timepart.manager
+.. py:currentmodule:: pg_partitioning.manager
 
-.. autoclass:: TimeRangePartitioning
+Time Range Partitioning
+-----------------------
+
+.. autoclass:: TimeRangePartitioningManager
  :members:
 
 .. autoclass:: PartitionConfig
  :members: period, interval, attach_tablespace, detach_tablespace, save
 
 .. autoclass:: PartitionLog
- :members: is_attached, detach_time, save, delete, truncate, set_tablespace
+ :members: is_attached, detach_time, save, delete
+
+List Partitioning
+-----------------
+
+.. autoclass:: ListRangePartitioningManager
+ :members:
+
+.. py:currentmodule:: pg_partitioning.shortcuts
+
+Shortcuts
+---------
+
+.. automodule:: pg_partitioning.shortcuts
+ :members: truncate, set_tablespace

docs/source/api.rst

@@ -12,7 +12,7 @@
 
 settings.configure(
  INSTALLED_APPS=(
- "pg_timepart",
+ "pg_partitioning",
  ),
 )
 django.setup()
@@ -31,7 +31,7 @@
 
 master_doc = 'index'
 
-project = 'django-pg-timepart'
+project = 'django-pg-partitioning'
 copyright = '2019, Chaitin Tech'
 author = 'Boyce Li'
 
@@ -45,7 +45,7 @@
 
 html_theme_options = {
  'github_user': 'chaitin',
- 'github_repo': 'django-pg-timepart',
+ 'github_repo': 'django-pg-partitioning',
  'github_type': 'star',
  'github_banner': 'true',
  'show_powered_by': 'false',
@@ -62,16 +62,16 @@
  ]
 }
 
-htmlhelp_basename = 'django-pg-timepart-doc'
+htmlhelp_basename = 'django-pg-partitioning-doc'
 
 man_pages = [
- (master_doc, 'django-pg-timepart', 'django-pg-timepart Documentation',
+ (master_doc, 'django-pg-partitioning', 'django-pg-partitioning Documentation',
  [author], 1)
 ]
 
 texinfo_documents = [
- (master_doc, 'django-pg-timepart', 'django-pg-timepart Documentation',
- author, 'django-pg-timepart', 'A Django extension that provides database table partition management.',
+ (master_doc, 'django-pg-partitioning', 'django-pg-partitioning Documentation',
+ author, 'django-pg-partitioning', 'A Django extension that supports PostgreSQL 11 time ranges and list partitioning.',
  'Miscellaneous'),
 ]
 

docs/source/conf.py

@@ -6,9 +6,12 @@ If you must use the decorator on a model class that has previously performed a m
 to back up the model's data, then drop the table, and then import the data after you have created a
 partitioned table.
 
-.. py:currentmodule:: pg_timepart.manager
+.. py:currentmodule:: pg_partitioning.manager
 
-.. autodata:: TimeRangePartitioningSupport
+.. autodata:: TimeRangePartitioning
+ :annotation:
+
+.. autodata:: ListPartitioning
  :annotation:
 
 Post-Decoration

docs/source/decorators.rst

@@ -1,7 +1,7 @@
 Design
 ======
 
-A brief description of the architecture of django-pg-timepart.
+A brief description of the architecture of django-pg-partitioning.
 
 Partitioned Table Support
 -------------------------
@@ -13,38 +13,29 @@ Some of the operations that Django applies to regular database tables may not be
 table, eventually throwing a database exception. Therefore, it is recommended that you read the section on the partition table
 in the official database documentation and refer to the relevant implementation inside Django.
 
-Conflict Avoidance
-------------------
+Constraint Limitations
+----------------------
+
+It is important to note that PostgreSQL table partitioning has some restrictions on field constraints.
+In order for the extension to work, we turned off Django's automatically generated primary key constraint, but did not do other legality checks.
+For example, if you mistakenly used a unique or foreign key constraint, it will throw an exception directly, which is what you are coding and
+it needs to be manually circumvented during use.
 
 It is important to note that if the field has the ``primary_key`` or ``unique`` attribute set, but it is not a partitioned field, we will ignore the
 ``PRIMARY KEY`` or ``UNIQUE`` declarations for that field in the SQL statement generated by Django. Django itself ignores the ``db_index``
 attribute of such fields, so you cannot use this method to create field indexes.
 
-A workaround is to add a ``indexes`` declaration in your model, for example
-
-.. code-block:: python
-
- @TimeRangePartitioningSupport("timestamp")
- class DataTable(models.Model):
- id = models.BigIntegerField(primary_key=True, serialize=False)
- timestamp = models.DateTimeField()
- data = models.TextField()
-
- class Meta:
- # If you do not add this line, id field will not have a index
- indexes = (models.Index(fields=("id", )), )
-
 Tablespace
 ----------
 
-``pg_timepart`` will silently set the tablespace of all local partitioned indexes under one partition to be consistent with
+``pg_partitioning`` will silently set the tablespace of all local partitioned indexes under one partition to be consistent with
 the partition.
 
 Partition Information
 ---------------------
 
-``pg_timepart`` saves partition configuration and state information in ``PartitionConfig`` and ``PartitionLog``.
-The problem with this is that once this information is inconsistent with the actual situation, ``pg_timepart``
+``pg_partitioning`` saves partition configuration and state information in ``PartitionConfig`` and ``PartitionLog``.
+The problem with this is that once this information is inconsistent with the actual situation, ``pg_partitioning``
 will not work properly, so you can only fix it manually.
 
 Management

docs/source/design.rst

@@ -9,3 +9,5 @@
  decorators
  api
  signals
+ Contributing <https://github.com/chaitin/django-pg-partitioning/blob/master/CONTRIBUTING.rst>
+ Project License <https://raw.githubusercontent.com/chaitin/django-pg-partitioning/master/LICENSE>