Added temporal indexes

CHANGES.md

@@ -1,3 +1,7 @@
+# 2024-01-07 (5.25.0)
+
+* Added temporal indexes
+
 # 2024-01-06 (5.24.1)
 
 * Fix bug in exporter where a loop through dataset tables was prematurely

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = amsterdam-schema-tools
-version = 5.24.1
+version = 5.25.0
 url = https://github.com/amsterdam/schema-tools
 license = Mozilla Public 2.0
 author = Team Data Diensten, van het Dataplatform onder de Directie Digitale Voorzieningen (Gemeente Amsterdam)

src/schematools/factories.py

@@ -350,6 +350,7 @@ def index_factory(
             _build_identifier_index(table, dataset_table, db_table_name),
             *_build_fk_indexes(table, dataset_table, db_table_name),
             *_build_geo_indexes(table, dataset_table, db_table_name),
+            *_build_temporal_indexes(table, dataset_table, db_table_name),
         ]
 
     through_indexes = _build_m2m_indexes(
@@ -407,6 +408,36 @@ def _build_geo_indexes(
     ]
 
 
+def _build_temporal_indexes(
+    table_object: Table, dataset_table: DatasetTableSchema, db_table_name: str
+) -> list[Index]:
+    """Creates an index on temporal fields."""
+    if dataset_table._temporal_range_field_ids:
+        fields = []
+        if dataset_table._temporal_range_field_ids:
+            for field in dataset_table._temporal_range_field_ids:
+                try:
+                    fields.append(table_object.c[to_snake_case(field)])
+                except KeyError:
+                    logger.warning(
+                        "Field '%s' not found...skipping temporal index creation", field
+                    )
+                    return []
+
+            combined_index = Index(
+                _format_index_name(f"{db_table_name}_temporal{TABLE_INDEX_POSTFIX}"), *fields
+            )
+            fields_index = [
+                Index(
+                    _format_index_name(f"{db_table_name}_{field.db_name}{TABLE_INDEX_POSTFIX}"),
+                    table_object.c[field.db_name],
+                )
+                for field in dataset_table.temporal.temporal_fields
+            ]
+            return [combined_index, *fields_index]
+    return []
+
+
 def _build_m2m_indexes(
     metadata: MetaData,
     dataset_table: DatasetTableSchema,

src/schematools/types.py

@@ -2171,6 +2171,11 @@ class Temporal:
     identifier_field: DatasetFieldSchema
     dimensions: dict[str, TemporalDimensionFields] = dataclasses.field(default_factory=dict)
 
+    @cached_property
+    def temporal_fields(self) -> list[DatasetFieldSchema]:
+        """Return the fields that are required for this temporal property."""
+        return [field for fields in self.dimensions.values() for field in fields]
+
 
 def _normalize_scopes(auth: None | str | list | tuple) -> frozenset[str]:
     """Make sure the auth field has a consistent type."""