michael-s-molina commented on code in PR #39171: URL: https://github.com/apache/superset/pull/39171#discussion_r3560995205
########## superset/extensions/storage/persistent_model.py: ########## @@ -0,0 +1,129 @@ +# 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 uuid as uuid_module + +from flask_appbuilder import Model +from sqlalchemy import ( + Boolean, + Column, + ForeignKey, + Index, + Integer, + LargeBinary, + String, + Text, + UniqueConstraint, +) +from sqlalchemy.orm import backref, relationship +from sqlalchemy_utils import UUIDType +from superset_core.extensions.storage.models import ( + ExtensionStorageEntry as CoreExtensionStorageEntry, +) + +from superset.models.helpers import AuditMixinNullable + +# 16 MB — matches the KeyValue store limit. +EXTENSION_STORAGE_MAX_SIZE = 2**24 - 1 + + +class ExtensionStorage(CoreExtensionStorageEntry, AuditMixinNullable, Model): + """Generic persistent key-value storage for extensions (Tier 3). + + Each row is identified by (extension_id, user_fk, resource_type, + resource_uuid, key): + + * Global scope — user_fk IS NULL, resource_type IS NULL + * User scope — user_fk set, resource_type IS NULL + * Resource scope — resource_type + resource_uuid set (user_fk optional) + + The payload is stored as raw bytes (value) with a MIME-type hint + (value_type). When is_encrypted is True the value has been encrypted + at the DAO layer using Fernet and must be decrypted before use. + """ + + __tablename__ = "extension_storage" + + id = Column(Integer, primary_key=True, autoincrement=True) + uuid = Column( + UUIDType(binary=True), + default=uuid_module.uuid4, + unique=True, + nullable=False, + ) + + # Extension identity + extension_id = Column(String(255), nullable=False) + + # Scope discriminators — all nullable; NULLs define the scope (see docstring) + user_fk = Column( + Integer, + ForeignKey( + "ab_user.id", + ondelete="SET NULL", + name="fk_extension_storage_user_fk_ab_user", + ), + nullable=True, + ) + resource_type = Column(String(64), nullable=True) + resource_uuid = Column(String(36), nullable=True) + + # Storage key within the scope + key = Column(String(255), nullable=False) + + # Optional metadata + category = Column(String(64), nullable=True) + description = Column(Text, nullable=True) + + # Payload + value = Column(LargeBinary(EXTENSION_STORAGE_MAX_SIZE), nullable=False) + value_type = Column(String(255), nullable=False, default="application/json") + is_encrypted = Column(Boolean, nullable=False, default=False) + + user = relationship( + "User", + backref=backref("extension_storage_entries", cascade="all, delete-orphan"), Review Comment: Removed the `backref` as it was not needed. -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
