mirror of
https://github.com/apache/superset.git
synced 2026-05-11 19:05:24 +00:00
102 lines
3.3 KiB
Python
102 lines
3.3 KiB
Python
# 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
|
|
import pickle
|
|
from datetime import datetime
|
|
from typing import Any, Optional
|
|
|
|
from flask_appbuilder.security.sqla.models import User
|
|
from sqlalchemy.exc import SQLAlchemyError
|
|
|
|
from superset import db
|
|
from superset.commands.base import BaseCommand
|
|
from superset.key_value.exceptions import KeyValueUpdateFailedError
|
|
from superset.key_value.models import KeyValueEntry
|
|
from superset.key_value.types import KeyType
|
|
from superset.key_value.utils import extract_key, get_filter
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class UpdateKeyValueCommand(BaseCommand):
|
|
actor: Optional[User]
|
|
resource: str
|
|
value: Any
|
|
key: str
|
|
key_type: KeyType
|
|
expires_on: Optional[datetime]
|
|
|
|
def __init__(
|
|
self,
|
|
resource: str,
|
|
key: str,
|
|
value: Any,
|
|
actor: Optional[User] = None,
|
|
key_type: KeyType = "uuid",
|
|
expires_on: Optional[datetime] = None,
|
|
):
|
|
"""
|
|
Update a key value entry
|
|
|
|
:param resource: the resource (dashboard, chart etc)
|
|
:param key: the key to update
|
|
:param value: the value to persist in the key-value store
|
|
:param actor: the user performing the command
|
|
:param key_type: the type of the key to update
|
|
:param expires_on: entry expiration time
|
|
:return: the key associated with the updated value
|
|
"""
|
|
self.actor = actor
|
|
self.resource = resource
|
|
self.key = key
|
|
self.value = value
|
|
self.key_type = key_type
|
|
self.expires_on = expires_on
|
|
|
|
def run(self) -> Optional[str]:
|
|
try:
|
|
return self.update()
|
|
except SQLAlchemyError as ex:
|
|
db.session.rollback()
|
|
logger.exception("Error running update command")
|
|
raise KeyValueUpdateFailedError() from ex
|
|
|
|
def validate(self) -> None:
|
|
pass
|
|
|
|
def update(self) -> Optional[str]:
|
|
filter_ = get_filter(self.resource, self.key, self.key_type)
|
|
entry: KeyValueEntry = (
|
|
db.session.query(KeyValueEntry)
|
|
.filter_by(**filter_)
|
|
.autoflush(False)
|
|
.first()
|
|
)
|
|
if entry:
|
|
entry.value = pickle.dumps(self.value)
|
|
entry.expires_on = self.expires_on
|
|
entry.changed_on = datetime.now()
|
|
entry.changed_by_fk = (
|
|
None if self.actor is None or self.actor.is_anonymous else self.actor.id
|
|
)
|
|
db.session.merge(entry)
|
|
db.session.commit()
|
|
return extract_key(entry, self.key_type)
|
|
|
|
return None
|