@tmlmobilidade/databases 20260511.1606.49 → 20260513.1432.15

package/dist/interfaces/vehicle-events/raw-vehicle-events.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Raw Vehicle Events represent the raw vehicle events as they are received from the data sources.
+ * These are stored in MongoDB for persistence and later processing.
+ * These documents are also different depending on the data source and version of the vehicle event.
+**/
 import { MongoInterfaceTemplate } from '../../templates/mongodb.js';
 import { type SimplifiedMongoIndex } from '../../types/mongo/index-description.js';
 import { type RawVehicleEvent } from '@tmlmobilidade/types';

package/dist/interfaces/vehicle-events/raw-vehicle-events.js

@@ -1,4 +1,8 @@
-/* * */
+/**
+ * Raw Vehicle Events represent the raw vehicle events as they are received from the data sources.
+ * These are stored in MongoDB for persistence and later processing.
+ * These documents are also different depending on the data source and version of the vehicle event.
+**/
 import { PCGIRawClient } from '../../clients/pcgi-raw.js';
 import { MongoInterfaceTemplate } from '../../templates/mongodb.js';
 import { RawVehicleEventSchema } from '@tmlmobilidade/types';

package/dist/interfaces/vehicle-events/simplified-vehicle-events.d.ts

@@ -1,11 +1,17 @@
+/**
+ * Simplified Vehicle Events represent a simplified version of the raw vehicle events.
+ * These are stored in ClickHouse for performance and scalability reasons.
+**/
 import { ClickHouseInterfaceTemplate } from '../../templates/clickhouse.js';
-import { type ClickHouseSchema } from '../../types/index.js';
+import { type ClickHouseSchema, ClickHouseTableEngine } from '../../types/index.js';
 import { type SimplifiedVehicleEvent } from '@tmlmobilidade/types';
 declare class SimplifiedVehicleEventsNewClass extends ClickHouseInterfaceTemplate<SimplifiedVehicleEvent> {
     private static _instance;
     readonly databaseName = "operation";
-    readonly orderBy = "(created_at, trip_id)";
-    readonly partitionBy = "toYYYYMMDD(fromUnixTimestamp64Milli(created_at))";
+    readonly engine: ClickHouseTableEngine;
+    readonly orderBy = "(trip_id, vehicle_id, agency_id, created_at)";
+    readonly partitionBy = "toYYYYMM(fromUnixTimestamp64Milli(created_at))";
+    readonly primaryKey = "(trip_id, vehicle_id)";
     readonly schema: ClickHouseSchema<{
         _id: string;
         created_at: number & {

package/dist/interfaces/vehicle-events/simplified-vehicle-events.js

@@ -1,4 +1,7 @@
-/* * */
+/**
+ * Simplified Vehicle Events represent a simplified version of the raw vehicle events.
+ * These are stored in ClickHouse for performance and scalability reasons.
+**/
 import { GOClickHouseClient } from '../../clients/go-clickhouse.js';
 import { ClickHouseInterfaceTemplate } from '../../templates/clickhouse.js';
 import { asyncSingletonProxy } from '@tmlmobilidade/utils';
@@ -28,8 +31,10 @@ class SimplifiedVehicleEventsNewClass extends ClickHouseInterfaceTemplate {
     //
     static _instance = null;
     databaseName = 'operation';
-    orderBy = '(created_at, trip_id)';
-    partitionBy = 'toYYYYMMDD(fromUnixTimestamp64Milli(created_at))';
+    engine = 'ReplacingMergeTree';
+    orderBy = '(trip_id, vehicle_id, agency_id, created_at)';
+    partitionBy = 'toYYYYMM(fromUnixTimestamp64Milli(created_at))';
+    primaryKey = '(trip_id, vehicle_id)';
     schema = tableSchema;
     tableName = 'simplified_vehicle_events';
     /**

package/dist/templates/clickhouse.d.ts

@@ -16,6 +16,7 @@ export declare abstract class ClickHouseInterfaceTemplate<T extends object> {
     protected readonly manageSchema: boolean;
     protected readonly orderBy: string;
     protected readonly partitionBy: null | string;
+    protected readonly primaryKey: null | string;
     private client;
     /**
      * Disallow direct instantiation of the service.

package/dist/templates/clickhouse.js

@@ -17,6 +17,7 @@ export class ClickHouseInterfaceTemplate {
     manageSchema = true;
     orderBy = '_id';
     partitionBy = null;
+    primaryKey = null;
     client;
     /**
      * Disallow direct instantiation of the service.
@@ -209,6 +210,7 @@ export class ClickHouseInterfaceTemplate {
 			CREATE TABLE IF NOT EXISTS "${this.databaseName}"."${this.tableName}" (
 				${Object.entries(this.schema).map(([key, column]) => `${key} ${column.type}`).join(', ')}
 			) ENGINE = ${this.getEngineString()}
+			${this.primaryKey ? `PRIMARY KEY (${this.primaryKey})` : ''}
 			${this.orderBy ? `ORDER BY (${this.orderBy})` : ''}
 			${this.partitionBy ? `PARTITION BY (${this.partitionBy})` : ''}
 		`;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/databases",
-	"version": "20260511.1606.49",
+	"version": "20260513.1432.15",
 	"author": {
 		"email": "iso@tmlmobilidade.pt",
 		"name": "TML-ISO"