Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

--wip-- architect and migration #30190

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions corehq/motech/migrations/0009_partition.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
from django.db import migrations
from django.db.migrations.operations.models import ModelOperation

from architect.commands import partition


def get_sql():
next_month = '2021-09-01 00:00:00 Z' # TODO: Calculate this
return f"""
CREATE TABLE motech_requestlog (
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if this table has exactly the same schema as the existing one you could say CREATE TABLE motech_requestlog LIKE dhis2_jsonapilog INCLUDING ALL

https://www.postgresql.org/docs/9.6/sql-createtable.html

id integer NOT NULL,
domain character varying(126) NOT NULL,
"timestamp" timestamp with time zone NOT NULL,
request_method character varying(12) NOT NULL,
request_url character varying(255) NOT NULL,
request_headers text NOT NULL,
request_params text NOT NULL,
request_body text,
request_error text,
response_status integer,
response_body text,
log_level integer,
payload_id character varying(126),
response_headers text
);

CREATE SEQUENCE motech_requestlog_id_seq
START WITH 1
INCREMENT BY 1
NO MINVALUE
NO MAXVALUE
CACHE 1;

ALTER SEQUENCE motech_requestlog_id_seq
OWNED BY motech_requestlog.id;

ALTER TABLE dhis2_jsonapilog
ADD CONSTRAINT before_next_month
CHECK ("timestamp" < TIMESTAMP '{next_month}');

ALTER TABLE dhis2_jsonapilog
INHERIT motech_requestlog;
"""


reverse_sql = """
ALTER TABLE dhis2_jsonapilog
NO INHERIT motech_requestlog;

ALTER TABLE dhis2_jsonapilog
DROP CONSTRAINT before_next_month;

DROP SEQUENCE motech_requestlog_id_seq;

DROP TABLE motech_requestlog;

"""


class PointModelAtTable(ModelOperation):
"""
Point a model to a different table.

The new table must already be set up as an exact replica of the
current table. This class is therefore a state operation, and
intentionally does not implement ``database_forwards()`` and
``database_backwards()``.
"""

def __init__(self, name, table):
self.table = table
super().__init__(name)

def deconstruct(self):
kwargs = {
'name': self.name,
'table': self.table,
}
return self.__class__.__qualname__, [], kwargs

def state_forwards(self, app_label, state):
state.models[app_label, self.name_lower].options["db_table"] = self.table
state.reload_model(app_label, self.name_lower, delay=True)

def describe(self):
return f"Point model {self.name} at table {self.table}"


def add_partitions(apps, schema_editor):
partition.run({'module': 'corehq.motech.models'})


class Migration(migrations.Migration):

dependencies = [
('motech', '0008_requestlog_response_headers'),
]

operations = [
migrations.RunSQL(
get_sql(),
reverse_sql=reverse_sql,
state_operations=[PointModelAtTable(
name='requestlog',
table='motech_requestlog',
)],
),
migrations.RunPython(add_partitions),
]
10 changes: 9 additions & 1 deletion corehq/motech/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from django.utils.functional import cached_property
from django.utils.translation import gettext as _

import architect
import attr
import jsonfield

Expand Down Expand Up @@ -224,6 +225,13 @@ def used_by(self):
return kinds


@architect.install(
'partition',
type='range',
subtype='date',
constraint='month',
column='timestamp',
)
class RequestLog(models.Model):
"""
Store API requests and responses to analyse errors and keep an audit trail
Expand All @@ -248,7 +256,7 @@ class RequestLog(models.Model):
response_body = models.TextField(blank=True, null=True)

class Meta:
db_table = 'dhis2_jsonapilog'
db_table = 'motech_requestlog'

@staticmethod
def log(level: int, log_entry: RequestLogEntry):
Expand Down