mistercrunch commented on a change in pull request #11550: URL: https://github.com/apache/incubator-superset/pull/11550#discussion_r517673475
########## File path: superset/models/reports.py ########## @@ -0,0 +1,172 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# pylint: disable=line-too-long,unused-argument,ungrouped-imports +"""A collection of ORM sqlalchemy models for Superset""" +import enum + +from flask_appbuilder import Model +from sqlalchemy import ( + Boolean, + Column, + DateTime, + Float, + ForeignKey, + Integer, + String, + Table, + Text, +) +from sqlalchemy.orm import relationship +from sqlalchemy.schema import UniqueConstraint + +from superset.extensions import security_manager +from superset.models.core import Database +from superset.models.dashboard import Dashboard +from superset.models.helpers import AuditMixinNullable +from superset.models.slice import Slice + +metadata = Model.metadata # pylint: disable=no-member + + +class ReportScheduleType(str, enum.Enum): + ALERT = "Alert" + REPORT = "Report" + + +class ReportRecipientType(str, enum.Enum): + EMAIL = "Email" + SLACK = "Slack" + + +class ReportLogState(str, enum.Enum): + SUCCESS = "Success" + ERROR = "Error" + + +class ReportEmailFormat(str, enum.Enum): + VISUALIZATION = "Visualization" + DATA = "Raw data" + + +report_schedule_user = Table( + "report_schedule_user", + metadata, + Column("id", Integer, primary_key=True), + Column("user_id", Integer, ForeignKey("ab_user.id"), nullable=False), + Column( + "report_schedule_id", Integer, ForeignKey("report_schedule.id"), nullable=False + ), + UniqueConstraint("user_id", "report_schedule_id"), +) + + +class ReportSchedule(Model, AuditMixinNullable): + + """ + Report Schedules, supports alerts and reports + """ + + __tablename__ = "report_schedule" + id = Column(Integer, primary_key=True) + type = Column(String(50), nullable=False) + label = Column(String(150), nullable=False, unique=True) + active = Column(Boolean, default=True, index=True) + crontab = Column(String(50), nullable=False) + sql = Column(Text()) + # (Reports) M-O to chart + chart_id = Column(Integer, ForeignKey("slice.id"), nullable=True) + chart = relationship(Slice, backref="report_schedules", foreign_keys=[chart_id]) + # (Reports) M-O to dashboard + dashboard_id = Column(Integer, ForeignKey("dashboards.id"), nullable=True) + dashboard = relationship( + Dashboard, backref="report_schedules", foreign_keys=[dashboard_id] + ) + # (Alerts) M-O to database + database_id = Column(Integer, ForeignKey("dbs.id"), nullable=True) + database = relationship(Database, foreign_keys=[dashboard_id]) + owners = relationship(security_manager.user_model, secondary=report_schedule_user) + + # (Reports) email format + email_format = Column(String(50)) + + # (Alerts) Stamped last observations + last_eval_dttm = Column(DateTime) + last_state = Column(String(50)) + last_value = Column(Float) + last_value_row_json = Column(Text) + + # (Alerts) Observed value validation related columns + validator_type = Column(String(100)) + validator_config_json = Column(Text, default="{}") + + # Log retention + log_retention = Column(Integer, default=90) + grace_period = Column(Integer, default=60 * 60 * 4) + + def __repr__(self) -> str: + return str(self.label) + + +class ReportRecipients( + Model, AuditMixinNullable +): # pylint: disable=too-few-public-methods + + """ + Report Recipients, meant to support multiple notification types, eg: Slack, email + """ + + __tablename__ = "report_recipient" + id = Column(Integer, primary_key=True) + type = Column(String(50), nullable=False) + recipient_config_json = Column(Text, default="{}") + report_schedule_id = Column( + Integer, ForeignKey("report_schedule.id"), nullable=False + ) + report_schedule = relationship( + ReportSchedule, backref="recipients", foreign_keys=[report_schedule_id] + ) + + +class ReportExecutionLog(Model): # pylint: disable=too-few-public-methods + + """ + Report Execution Log, hold the result of the report execution with timestamps, + last observation and possible error messages + """ + + __tablename__ = "report_execution_log" + id = Column(Integer, primary_key=True) + + # Timestamps + scheduled_dttm = Column(DateTime, nullable=False) + start_dttm = Column(DateTime) + end_dttm = Column(DateTime) + + # (Alerts) Observed values + observation_dttm = Column(DateTime) Review comment: isn't this effectively same as `end_dttm`? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
