Class KeyValuePairDB

st2common/st2common/models/db/keyvalue.py:27–53

Attribute: name: Name of the key. value: Arbitrary value to be stored.

class KeyValuePairDB(stormbase.StormBaseDB, stormbase.UIDFieldMixin):
    """
    Attribute:
        name: Name of the key.
        value: Arbitrary value to be stored.
    """

    RESOURCE_TYPE = ResourceType.KEY_VALUE_PAIR
    UID_FIELDS = ["scope", "name"]

    scope = me.StringField(default=FULL_SYSTEM_SCOPE, unique_with="name")
    name = me.StringField(required=True)
    value = me.StringField()
    secret = me.BooleanField(default=False)
    expire_timestamp = me.DateTimeField()

    meta = {
        "indexes": [
            {"fields": ["name"]},
            {"fields": ["expire_timestamp"], "expireAfterSeconds": 0},
        ]
        + stormbase.UIDFieldMixin.get_indexes()
    }

    def __init__(self, *args, **values):
        super(KeyValuePairDB, self).__init__(*args, **values)
        self.uid = self.get_uid()


# specialized access objects