You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by GitBox <gi...@apache.org> on 2020/10/21 18:42:18 UTC

[GitHub] [incubator-superset] willbarrett commented on a change in pull request #11344: feat: annotations REST API

willbarrett commented on a change in pull request #11344:
URL: https://github.com/apache/incubator-superset/pull/11344#discussion_r509509503



##########
File path: superset/annotation_layers/annotations/dao.py
##########
@@ -0,0 +1,63 @@
+# 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.
+import logging
+from typing import List, Optional
+
+from sqlalchemy.exc import SQLAlchemyError
+
+from superset.dao.base import BaseDAO
+from superset.dao.exceptions import DAODeleteFailedError
+from superset.extensions import db
+from superset.models.annotations import Annotation
+
+logger = logging.getLogger(__name__)
+
+
+class AnnotationDAO(BaseDAO):
+    model_cls = Annotation
+
+    @staticmethod
+    def bulk_delete(models: Optional[List[Annotation]], commit: bool = True) -> None:
+        item_ids = [model.id for model in models] if models else []
+        try:
+            db.session.query(Annotation).filter(Annotation.id.in_(item_ids)).delete(
+                synchronize_session="fetch"
+            )
+            if commit:
+                db.session.commit()
+        except SQLAlchemyError:
+            if commit:
+                db.session.rollback()
+            raise DAODeleteFailedError()
+
+    @staticmethod
+    def validate_uniqueness(layer_id: int, short_descr: str) -> bool:
+        query = db.session.query(Annotation).filter(
+            Annotation.short_descr == short_descr, Annotation.layer_id == layer_id
+        )
+        return not db.session.query(query.exists()).scalar()
+
+    @staticmethod
+    def validate_update_uniqueness(

Review comment:
       I think `validate_uniqueness` and `validate_update_uniqueness` could be combined to a single method with the signature of `validate_update_uniqueness`. `annotation_id` could be null when validating uniqueness on create.

##########
File path: superset/annotation_layers/dao.py
##########
@@ -0,0 +1,75 @@
+# 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.
+import logging
+from typing import List, Optional, Union
+
+from sqlalchemy.exc import SQLAlchemyError
+
+from superset.dao.base import BaseDAO
+from superset.dao.exceptions import DAODeleteFailedError
+from superset.extensions import db
+from superset.models.annotations import Annotation, AnnotationLayer
+
+logger = logging.getLogger(__name__)
+
+
+class AnnotationLayerDAO(BaseDAO):
+    model_cls = AnnotationLayer
+
+    @staticmethod
+    def bulk_delete(
+        models: Optional[List[AnnotationLayer]], commit: bool = True
+    ) -> None:
+        item_ids = [model.id for model in models] if models else []
+        try:
+            db.session.query(AnnotationLayer).filter(
+                AnnotationLayer.id.in_(item_ids)
+            ).delete(synchronize_session="fetch")
+            if commit:
+                db.session.commit()
+        except SQLAlchemyError:
+            if commit:
+                db.session.rollback()
+            raise DAODeleteFailedError()
+
+    @staticmethod
+    def has_annotations(model_id: Union[int, List[int]]) -> bool:
+        if isinstance(model_id, list):
+            return (
+                db.session.query(AnnotationLayer)
+                .filter(AnnotationLayer.id.in_(model_id))
+                .join(Annotation)
+                .first()
+            ) is not None
+        return (
+            db.session.query(AnnotationLayer)
+            .filter(AnnotationLayer.id == model_id)
+            .join(Annotation)
+            .first()
+        ) is not None
+
+    @staticmethod
+    def validate_name_uniqueness(name: str) -> bool:
+        query = db.session.query(AnnotationLayer).filter(AnnotationLayer.name == name)
+        return not db.session.query(query.exists()).scalar()
+
+    @staticmethod
+    def validate_update_name_uniqueness(layer_id: int, name: str) -> bool:

Review comment:
       Same comment here: `validate_name_uniqueness` and `validate_update_name_uniqueness` could be a single method.




----------------------------------------------------------------
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:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org