# Copyright 2018 Google LLC
#
# Licensed 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
#
# https://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.
"""Models for accessing datastore usage statistics.
These entities cannot be created by users, but are populated in the
application's datastore by offline processes run by the Google Cloud team.
"""
from google.cloud.ndb import model
__all__ = [
"BaseKindStatistic",
"BaseStatistic",
"GlobalStat",
"KindCompositeIndexStat",
"KindNonRootEntityStat",
"KindPropertyNamePropertyTypeStat",
"KindPropertyNameStat",
"KindPropertyTypeStat",
"KindRootEntityStat",
"KindStat",
"NamespaceGlobalStat",
"NamespaceKindCompositeIndexStat",
"NamespaceKindNonRootEntityStat",
"NamespaceKindPropertyNamePropertyTypeStat",
"NamespaceKindPropertyNameStat",
"NamespaceKindPropertyTypeStat",
"NamespaceKindRootEntityStat",
"NamespaceKindStat",
"NamespacePropertyTypeStat",
"NamespaceStat",
"PropertyTypeStat",
]
[docs]class BaseStatistic(model.Model):
"""Base Statistic Model class.
Attributes:
bytes (int): the total number of bytes taken up in Cloud Datastore for
the statistic instance.
count (int): attribute is the total number of occurrences of the
statistic in Cloud Datastore.
timestamp (datetime.datetime): the time the statistic instance was
written to Cloud Datastore.
"""
# This is necessary for the _get_kind() classmethod override.
STORED_KIND_NAME = "__BaseStatistic__"
bytes = model.IntegerProperty()
count = model.IntegerProperty()
timestamp = model.DateTimeProperty()
@classmethod
def _get_kind(cls):
"""Kind name override."""
return cls.STORED_KIND_NAME
[docs]class BaseKindStatistic(BaseStatistic):
"""Base Statistic Model class for stats associated with kinds.
Attributes:
kind_name (str): the name of the kind associated with the statistic
instance.
entity_bytes (int): the number of bytes taken up to store the statistic
in Cloud Datastore minus the cost of storing indices.
"""
STORED_KIND_NAME = "__BaseKindStatistic__"
kind_name = model.StringProperty()
entity_bytes = model.IntegerProperty(default=0)
[docs]class GlobalStat(BaseStatistic):
"""An aggregate of all entities across the entire application.
This statistic only has a single instance in Cloud Datastore that contains
the total number of entities stored and the total number of bytes they take
up.
Attributes:
entity_bytes (int): the number of bytes taken up to store the statistic
in Cloud Datastore minus the cost of storing indices.
builtin_index_bytes (int): the number of bytes taken up to store
built-in index entries.
builtin_index_count (int): the number of built-in index entries.
composite_index_bytes (int): the number of bytes taken up to store
composite index entries.
composite_index_count (int): the number of composite index entries.
"""
STORED_KIND_NAME = "__Stat_Total__"
entity_bytes = model.IntegerProperty(default=0)
builtin_index_bytes = model.IntegerProperty(default=0)
builtin_index_count = model.IntegerProperty(default=0)
composite_index_bytes = model.IntegerProperty(default=0)
composite_index_count = model.IntegerProperty(default=0)
[docs]class NamespaceStat(BaseStatistic):
"""An aggregate of all entities across an entire namespace.
This statistic has one instance per namespace. The key_name is the
represented namespace. NamespaceStat entities will only be found
in the namespace "" (empty string). It contains the total
number of entities stored and the total number of bytes they take up.
Attributes:
subject_namespace (str): the namespace associated with the statistic
instance.
entity_bytes (int): the number of bytes taken up to store the statistic
in Cloud Datastore minus the cost of storing indices.
builtin_index_bytes (int): the number of bytes taken up to store
builtin-in index entries.
builtin_index_count (int): the number of built-in index entries.
composite_index_bytes (int): the number of bytes taken up to store
composite index entries.
composite_index_count (int): the number of composite index entries.
"""
STORED_KIND_NAME = "__Stat_Namespace__"
subject_namespace = model.StringProperty()
entity_bytes = model.IntegerProperty(default=0)
builtin_index_bytes = model.IntegerProperty(default=0)
builtin_index_count = model.IntegerProperty(default=0)
composite_index_bytes = model.IntegerProperty(default=0)
composite_index_count = model.IntegerProperty(default=0)
[docs]class KindStat(BaseKindStatistic):
"""An aggregate of all entities at the granularity of their Kind.
There is an instance of the KindStat for every Kind that is in the
application's datastore. This stat contains per-Kind statistics.
Attributes:
builtin_index_bytes (int): the number of bytes taken up to store
built-in index entries.
builtin_index_count (int): the number of built-in index entries.
composite_index_bytes (int): the number of bytes taken up to store
composite index entries.
composite_index_count (int): the number of composite index entries.
"""
STORED_KIND_NAME = "__Stat_Kind__"
builtin_index_bytes = model.IntegerProperty(default=0)
builtin_index_count = model.IntegerProperty(default=0)
composite_index_bytes = model.IntegerProperty(default=0)
composite_index_count = model.IntegerProperty(default=0)
[docs]class KindRootEntityStat(BaseKindStatistic):
"""Statistics of the number of root entities in Cloud Datastore by Kind.
There is an instance of the KindRootEntityState for every Kind that is in
the application's datastore and has an instance that is a root entity. This
stat contains statistics regarding these root entity instances.
"""
STORED_KIND_NAME = "__Stat_Kind_IsRootEntity__"
[docs]class KindNonRootEntityStat(BaseKindStatistic):
"""Statistics of the number of non root entities in Cloud Datastore by Kind.
There is an instance of the KindNonRootEntityStat for every Kind that is in
the application's datastore that is a not a root entity. This stat
contains statistics regarding these non root entity instances.
"""
STORED_KIND_NAME = "__Stat_Kind_NotRootEntity__"
[docs]class PropertyTypeStat(BaseStatistic):
"""An aggregate of all properties across the entire application by type.
There is an instance of the PropertyTypeStat for every property type
(google.appengine.api.datastore_types._PROPERTY_TYPES) in use by the
application in its datastore.
Attributes:
property_type (str): the property type associated with the statistic
instance.
entity_bytes (int): the number of bytes taken up to store the statistic
in Cloud Datastore minus the cost of storing indices.
builtin_index_bytes (int): the number of bytes taken up to store
built-in index entries.
builtin_index_count (int): the number of built-in index entries.
"""
STORED_KIND_NAME = "__Stat_PropertyType__"
property_type = model.StringProperty()
entity_bytes = model.IntegerProperty(default=0)
builtin_index_bytes = model.IntegerProperty(default=0)
builtin_index_count = model.IntegerProperty(default=0)
[docs]class KindPropertyTypeStat(BaseKindStatistic):
"""Statistics on (kind, property_type) tuples in the app's datastore.
There is an instance of the KindPropertyTypeStat for every
(kind, property_type) tuple in the application's datastore.
Attributes:
property_type (str): the property type associated with the statistic
instance.
builtin_index_bytes (int): the number of bytes taken up to store\
built-in index entries.
builtin_index_count (int): the number of built-in index entries.
"""
STORED_KIND_NAME = "__Stat_PropertyType_Kind__"
property_type = model.StringProperty()
builtin_index_bytes = model.IntegerProperty(default=0)
builtin_index_count = model.IntegerProperty(default=0)
[docs]class KindPropertyNameStat(BaseKindStatistic):
"""Statistics on (kind, property_name) tuples in the app's datastore.
There is an instance of the KindPropertyNameStat for every
(kind, property_name) tuple in the application's datastore.
Attributes:
property_name (str): the name of the property associated with the
statistic instance.
builtin_index_bytes (int): the number of bytes taken up to store
built-in index entries.
builtin_index_count (int): the number of built-in index entries.
"""
STORED_KIND_NAME = "__Stat_PropertyName_Kind__"
property_name = model.StringProperty()
builtin_index_bytes = model.IntegerProperty(default=0)
builtin_index_count = model.IntegerProperty(default=0)
[docs]class KindPropertyNamePropertyTypeStat(BaseKindStatistic):
"""Statistic on (kind, property_name, property_type) tuples in Cloud
Datastore.
There is an instance of the KindPropertyNamePropertyTypeStat for every
(kind, property_name, property_type) tuple in the application's datastore.
Attributes:
property_type (str): the property type associated with the statistic
instance.
property_name (str): the name of the property associated with the
statistic instance.
builtin_index_bytes (int): the number of bytes taken up to store
built-in index entries
builtin_index_count (int): the number of built-in index entries.
"""
STORED_KIND_NAME = "__Stat_PropertyType_PropertyName_Kind__"
property_type = model.StringProperty()
property_name = model.StringProperty()
builtin_index_bytes = model.IntegerProperty(default=0)
builtin_index_count = model.IntegerProperty(default=0)
[docs]class KindCompositeIndexStat(BaseStatistic):
"""Statistic on (kind, composite_index_id) tuples in Cloud Datastore.
There is an instance of the KindCompositeIndexStat for every unique
(kind, composite_index_id) tuple in the application's datastore indexes.
Attributes:
index_id (int): the id of the composite index associated with the
statistic instance.
kind_name (str): the name of the kind associated with the statistic
instance.
"""
STORED_KIND_NAME = "__Stat_Kind_CompositeIndex__"
index_id = model.IntegerProperty()
kind_name = model.StringProperty()
# The following specify namespace-specific stats.
# These types are specific to Cloud Datastore namespace they are located
# within. These will only be produced if datastore entities exist
# in a namespace other than the empty namespace (i.e. namespace="").
[docs]class NamespaceGlobalStat(GlobalStat):
"""GlobalStat equivalent for a specific namespace.
These may be found in each specific namespace and represent stats for that
particular namespace.
"""
STORED_KIND_NAME = "__Stat_Ns_Total__"
[docs]class NamespaceKindStat(KindStat):
"""KindStat equivalent for a specific namespace.
These may be found in each specific namespace and represent stats for that
particular namespace.
"""
STORED_KIND_NAME = "__Stat_Ns_Kind__"
[docs]class NamespaceKindRootEntityStat(KindRootEntityStat):
"""KindRootEntityStat equivalent for a specific namespace.
These may be found in each specific namespace and represent stats for that
particular namespace.
"""
STORED_KIND_NAME = "__Stat_Ns_Kind_IsRootEntity__"
[docs]class NamespaceKindNonRootEntityStat(KindNonRootEntityStat):
"""KindNonRootEntityStat equivalent for a specific namespace.
These may be found in each specific namespace and represent stats for that
particular namespace.
"""
STORED_KIND_NAME = "__Stat_Ns_Kind_NotRootEntity__"
[docs]class NamespacePropertyTypeStat(PropertyTypeStat):
"""PropertyTypeStat equivalent for a specific namespace.
These may be found in each specific namespace and represent stats for that
particular namespace.
"""
STORED_KIND_NAME = "__Stat_Ns_PropertyType__"
[docs]class NamespaceKindPropertyTypeStat(KindPropertyTypeStat):
"""KindPropertyTypeStat equivalent for a specific namespace.
These may be found in each specific namespace and represent stats for that
particular namespace.
"""
STORED_KIND_NAME = "__Stat_Ns_PropertyType_Kind__"
[docs]class NamespaceKindPropertyNameStat(KindPropertyNameStat):
"""KindPropertyNameStat equivalent for a specific namespace.
These may be found in each specific namespace and represent stats for that
particular namespace.
"""
STORED_KIND_NAME = "__Stat_Ns_PropertyName_Kind__"
[docs]class NamespaceKindPropertyNamePropertyTypeStat(KindPropertyNamePropertyTypeStat):
"""KindPropertyNamePropertyTypeStat equivalent for a specific namespace.
These may be found in each specific namespace and represent stats for that
particular namespace.
"""
STORED_KIND_NAME = "__Stat_Ns_PropertyType_PropertyName_Kind__"
[docs]class NamespaceKindCompositeIndexStat(KindCompositeIndexStat):
"""KindCompositeIndexStat equivalent for a specific namespace.
These may be found in each specific namespace and represent stats for that
particular namespace.
"""
STORED_KIND_NAME = "__Stat_Ns_Kind_CompositeIndex__"
# Maps a datastore stat entity kind name to its respective model class.
# NOTE: Any new stats added to this module should also be added here.
_DATASTORE_STATS_CLASSES_BY_KIND = {
GlobalStat.STORED_KIND_NAME: GlobalStat,
NamespaceStat.STORED_KIND_NAME: NamespaceStat,
KindStat.STORED_KIND_NAME: KindStat,
KindRootEntityStat.STORED_KIND_NAME: KindRootEntityStat,
KindNonRootEntityStat.STORED_KIND_NAME: KindNonRootEntityStat,
PropertyTypeStat.STORED_KIND_NAME: PropertyTypeStat,
KindPropertyTypeStat.STORED_KIND_NAME: KindPropertyTypeStat,
KindPropertyNameStat.STORED_KIND_NAME: KindPropertyNameStat,
KindPropertyNamePropertyTypeStat.STORED_KIND_NAME: KindPropertyNamePropertyTypeStat, # noqa: E501
KindCompositeIndexStat.STORED_KIND_NAME: KindCompositeIndexStat,
NamespaceGlobalStat.STORED_KIND_NAME: NamespaceGlobalStat,
NamespaceKindStat.STORED_KIND_NAME: NamespaceKindStat,
NamespaceKindRootEntityStat.STORED_KIND_NAME: NamespaceKindRootEntityStat,
NamespaceKindNonRootEntityStat.STORED_KIND_NAME: NamespaceKindNonRootEntityStat, # noqa: E501
NamespacePropertyTypeStat.STORED_KIND_NAME: NamespacePropertyTypeStat,
NamespaceKindPropertyTypeStat.STORED_KIND_NAME: NamespaceKindPropertyTypeStat, # noqa: E501
NamespaceKindPropertyNameStat.STORED_KIND_NAME: NamespaceKindPropertyNameStat, # noqa: E501
NamespaceKindPropertyNamePropertyTypeStat.STORED_KIND_NAME: NamespaceKindPropertyNamePropertyTypeStat, # noqa: E501
NamespaceKindCompositeIndexStat.STORED_KIND_NAME: NamespaceKindCompositeIndexStat, # noqa: E501
}