-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathserver.py
More file actions
1043 lines (868 loc) · 37.8 KB
/
Copy pathserver.py
File metadata and controls
1043 lines (868 loc) · 37.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
"""
HTTP server for interactive OLAP benchmark querying.
Starts one or more DBMS instances and exposes HTTP endpoints to execute
queries against them with optional query plan retrieval.
"""
from __future__ import annotations
import argparse
import atexit
import hashlib
import json
import os
import re
import sys
import threading
from typing import Any, Dict, Optional
from dotenv import load_dotenv
from flask import Flask, request, jsonify, send_from_directory, send_file
from flask_cors import CORS
from benchmarks.benchmark import benchmark_arguments, benchmarks, Benchmark
from dbms.dbms import Result, database_systems, DBMS
from queryplan.queryplan import encode_query_plan
from util import schemajson, sql
from util.log import log
from util.template import Template, unfold
workdir = os.getcwd()
load_dotenv()
FRONTEND_BUILD_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'frontend', 'build')
app = Flask(__name__, static_folder=FRONTEND_BUILD_DIR, static_url_path='')
CORS(app) # Enable CORS for all routes
# Global state
active_dbms: Dict[tuple[str, str], DBMS] = {} # (dataset_name, title) -> DBMS
dbms_locks: Dict[tuple[str, str], threading.Lock] = {} # (dataset_name, title) -> Lock
benchmark_instances: Dict[str, Benchmark] = {} # dataset_name -> Benchmark
optimizer_dbms_name: Dict[str, Optional[str]] = {} # dataset_name -> optimizer title
dbms_lock = threading.Lock() # Lock for modifying the above dicts
dbms_restart_configs: Dict[tuple[str, str], dict] = {} # (dataset_name, title) -> restart config
planner_only_systems: set[tuple[str, str]] = set() # (dataset_name, title)
planner_statistics_cache: Dict[tuple[str, str], dict] = {} # (dataset_name, target title) -> stats record
def cleanup_dbms():
"""Clean up all active DBMS instances on shutdown."""
with dbms_lock:
for (dataset_name, title), dbms in active_dbms.items():
try:
log.driver(f"Shutting down {dataset_name}/{title}...")
dbms.__exit__(None, None, None)
except Exception as e:
log.error(f"Error shutting down {dataset_name}/{title}: {e}")
active_dbms.clear()
dbms_locks.clear()
def restart_dbms(dataset_name: str, title: str) -> Optional[str]:
"""
Restart a DBMS instance. Returns an error message on failure, or None on success.
Acquires the per-DBMS query_lock to block concurrent queries during the restart.
"""
key = (dataset_name, title)
query_lock = dbms_locks.get(key, threading.Lock())
with query_lock:
with dbms_lock:
config = dbms_restart_configs.get(key)
if config is None:
return f'No restart config for {dataset_name}/{title}'
old_dbms = active_dbms.get(key)
# Shut down outside dbms_lock — can be slow
if old_dbms is not None:
try:
old_dbms.__exit__(None, None, None)
except Exception as e:
log.error(f"Error shutting down {dataset_name}/{title} during restart: {e}")
# Re-instantiate
dbms_descriptions = database_systems()
dbms_name = config['dbms_name']
try:
log.driver(f"Restarting {dataset_name}/{title}...")
benchmark = benchmark_instances[dataset_name]
dbms = dbms_descriptions[dbms_name].instantiate(
benchmark, config['db_dir'], config['data_dir'], config['params'], config['settings']
)
dbms.__enter__()
planner_only = config.get('planner_only', False)
log.driver(f"Loading {'schema' if planner_only else 'database'} for {title}...")
if planner_only:
dbms.load_schema()
else:
dbms.load_database()
with dbms_lock:
active_dbms[key] = dbms
if planner_only:
planner_only_systems.add(key)
log.driver(f"✓ {title} restarted successfully")
return None
except Exception as e:
log.error(f"Failed to restart {dataset_name}/{title}: {e}")
return str(e)
def error(message: str, status_code: int = 404):
"""Helper to return an error response."""
return jsonify({
'status': 'error',
'error': message
}), status_code
def resolve_dataset(dataset_name: Optional[str]):
"""
Resolve a dataset name to a benchmark instance.
If dataset_name is None and only one dataset is loaded, returns that dataset's name.
Returns (name, error_response) — error_response is None on success.
"""
if dataset_name:
if dataset_name not in benchmark_instances:
return None, error(
f'Dataset "{dataset_name}" not found. Available: {list(benchmark_instances.keys())}', 404
)
return dataset_name, None
if len(benchmark_instances) == 1:
return next(iter(benchmark_instances)), None
if len(benchmark_instances) == 0:
return None, error('No datasets loaded', 404)
return None, error(
f'Multiple datasets loaded, "dataset" field is required. Available: {list(benchmark_instances.keys())}', 400
)
def _safe_path_component(value: str) -> str:
component = re.sub(r'[^A-Za-z0-9_.-]+', '_', str(value)).strip('._')
return component or 'default'
def _stable_json(value: Any) -> str:
return json.dumps(value, sort_keys=True, default=str, separators=(',', ':'))
def _hash_text(value: str) -> str:
return hashlib.sha256(value.encode('utf-8')).hexdigest()
def _filtered_params(params: dict) -> dict:
return {key: value for key, value in params.items() if key != 'host_port'}
def _statistics_cache_dir(dataset_name: str, target_title: str) -> str:
bench = benchmark_instances[dataset_name]
config = dbms_restart_configs.get((dataset_name, target_title), {})
db_dir = config.get('db_dir', os.path.join(workdir, 'db'))
return os.path.join(
db_dir,
'planner_statistics',
_safe_path_component(bench.result_name),
_safe_path_component(target_title),
)
def _statistics_record(
metadata: dict,
statistics: str,
cache_dir: str,
cache_hit: bool,
) -> dict:
return {
'status': 'success',
'target_dbms': metadata.get('target_dbms'),
'target_dbms_name': metadata.get('target_dbms_name'),
'target_version': metadata.get('target_version'),
'optimizer': metadata.get('optimizer'),
'dialect': metadata.get('dialect'),
'collection_method': metadata.get('collection_method'),
'statistics': statistics,
'statsql_call': metadata.get('statsql_call'),
'statsql_query': metadata.get('statsql_query'),
'statsql_error': metadata.get('statsql_error'),
'statjson_call': metadata.get('statjson_call'),
'statjson_error': metadata.get('statjson_error'),
'cache': {
'hit': cache_hit,
'path': cache_dir,
'fingerprint': metadata.get('fingerprint'),
},
}
def _read_cached_statistics(cache_dir: str, fingerprint: str) -> Optional[dict]:
metadata_path = os.path.join(cache_dir, 'metadata.json')
statistics_path = os.path.join(cache_dir, 'statistics.json')
if not os.path.exists(metadata_path) or not os.path.exists(statistics_path):
return None
try:
with open(metadata_path, 'r') as metadata_file:
metadata = json.load(metadata_file)
if metadata.get('fingerprint') != fingerprint:
return None
with open(statistics_path, 'r') as statistics_file:
statistics = statistics_file.read()
return _statistics_record(metadata, statistics, cache_dir, cache_hit=True)
except Exception as e:
log.warn(f"Could not read planner statistics cache {cache_dir}: {e}")
return None
def _write_cached_statistics(cache_dir: str, metadata: dict, statistics: str) -> dict:
os.makedirs(cache_dir, exist_ok=True)
with open(os.path.join(cache_dir, 'metadata.json'), 'w') as metadata_file:
json.dump(metadata, metadata_file, indent=2, sort_keys=True, default=str)
metadata_file.write('\n')
with open(os.path.join(cache_dir, 'statistics.json'), 'w') as statistics_file:
statistics_file.write(statistics)
if metadata.get('statsql_query'):
with open(os.path.join(cache_dir, 'statsql.sql'), 'w') as statsql_file:
statsql_file.write(metadata['statsql_query'])
if not metadata['statsql_query'].endswith('\n'):
statsql_file.write('\n')
return _statistics_record(metadata, statistics, cache_dir, cache_hit=False)
def _is_umbra_dbms(dbms: DBMS) -> bool:
return getattr(dbms, 'name', None) == 'umbra'
def _stats_fingerprint(
dataset_name: str,
target_title: str,
metadata: dict,
target_config: dict,
optimizer_config: Optional[dict],
) -> tuple[str, dict]:
bench = benchmark_instances[dataset_name]
schema = bench.get_schema(primary_key=False, foreign_keys=False)
payload = {
'benchmark': bench.result_name,
'schema_hash': _hash_text(_stable_json(schema)),
'target': {
'title': target_title,
'dbms_name': metadata.get('target_dbms_name'),
'version': metadata.get('target_version'),
'params': _filtered_params(target_config.get('params', {})),
'settings': target_config.get('settings', {}),
},
'optimizer': {
'title': metadata.get('optimizer'),
'params': _filtered_params((optimizer_config or {}).get('params', {})),
'settings': (optimizer_config or {}).get('settings', {}),
},
'calls': {
'statsql_call': metadata.get('statsql_call'),
'statsql_query_hash': _hash_text(metadata.get('statsql_query') or ''),
'statjson_call': metadata.get('statjson_call'),
},
}
return _hash_text(_stable_json(payload)), payload
def get_or_collect_planner_statistics(dataset_name: str, target_title: str) -> dict:
with dbms_lock:
target_key = (dataset_name, target_title)
if target_key not in active_dbms:
available = [title for (d, title) in active_dbms if d == dataset_name]
raise Exception(f'DBMS "{target_title}" is not active for dataset "{dataset_name}". Available: {available}')
target = active_dbms[target_key]
target_lock = dbms_locks[target_key]
target_config = dbms_restart_configs.get(target_key, {})
target_name = target.name
target_version = target.version
optimizer_title = optimizer_dbms_name.get(dataset_name)
optimizer_key = (dataset_name, optimizer_title) if optimizer_title else None
optimizer = active_dbms.get(optimizer_key) if optimizer_key else None
optimizer_lock = dbms_locks.get(optimizer_key) if optimizer_key else None
optimizer_config = dbms_restart_configs.get(optimizer_key, {}) if optimizer_key else None
cache_dir = _statistics_cache_dir(dataset_name, target_title)
metadata = {
'target_dbms': target_title,
'target_dbms_name': target_name,
'target_version': target_version,
'optimizer': optimizer_title,
'dialect': None,
'collection_method': None,
'statsql_call': None,
'statsql_query': None,
'statsql_error': None,
'statjson_call': None,
'statjson_error': None,
}
if _is_umbra_dbms(target):
metadata['dialect'] = 'umbra'
metadata['collection_method'] = 'statjson'
metadata['statjson_call'] = target.statjson_call() if hasattr(target, 'statjson_call') else 'select umbra.statjson();'
metadata['statsql_call'] = target.statsql_call() if hasattr(target, 'statsql_call') else 'select umbra.statsql();'
with target_lock:
if hasattr(target, 'statsql_query'):
try:
metadata['statsql_query'] = target.statsql_query()
except Exception as e:
metadata['statsql_error'] = str(e)
else:
if optimizer is None:
raise Exception(f'No Umbra/UmbraDev optimizer configured for dataset "{dataset_name}"')
if not hasattr(optimizer, 'statsql_query'):
raise Exception(f'Optimizer "{optimizer_title}" does not support umbra.statsql')
metadata['dialect'] = getattr(optimizer, 'dialects', {}).get(target_name, 'umbra')
metadata['collection_method'] = 'statsql'
metadata['statsql_call'] = optimizer.statsql_call(target_name) if hasattr(optimizer, 'statsql_call') else f"select umbra.statsql('{metadata['dialect']}');"
with optimizer_lock:
metadata['statsql_query'] = optimizer.statsql_query(target_name)
fingerprint, fingerprint_payload = _stats_fingerprint(
dataset_name,
target_title,
metadata,
target_config,
optimizer_config,
)
metadata['fingerprint'] = fingerprint
metadata['fingerprint_payload'] = fingerprint_payload
cached = _read_cached_statistics(cache_dir, fingerprint)
if cached is not None:
planner_statistics_cache[(dataset_name, target_title)] = cached
return cached
if _is_umbra_dbms(target):
with target_lock:
try:
statistics = target.statjson() if hasattr(target, 'statjson') else str(target.execute_scalar(metadata['statjson_call']))
except Exception as e:
metadata['statjson_error'] = str(e)
if not metadata.get('statsql_query'):
raise
metadata['collection_method'] = 'statsql_fallback'
statistics = str(target.execute_scalar(metadata['statsql_query']))
else:
stats_timeout = target_config.get('params', {}).get('umbra_planner_statistics_timeout', 0) or 0
with target_lock:
statistics = str(target.execute_scalar(metadata['statsql_query'], timeout=stats_timeout))
record = _write_cached_statistics(cache_dir, metadata, statistics)
planner_statistics_cache[(dataset_name, target_title)] = record
return record
@app.route('/', defaults={'path': ''})
@app.route('/<path:path>')
def serve_frontend(path: str):
"""Serve the React frontend. Falls back to index.html for client-side routing."""
if path and os.path.exists(os.path.join(FRONTEND_BUILD_DIR, path)):
return send_from_directory(FRONTEND_BUILD_DIR, path)
index = os.path.join(FRONTEND_BUILD_DIR, 'index.html')
if os.path.exists(index):
return send_file(index)
return jsonify({'error': 'Frontend not built. Run: cd frontend && npm install && npm run build'}), 404
@app.route('/health', methods=['GET'])
def health():
"""Health check endpoint."""
with dbms_lock:
benchmarks = []
for dataset_name, bench in benchmark_instances.items():
systems = []
for (d, title), dbms in active_dbms.items():
if d != dataset_name:
continue
stats_record = planner_statistics_cache.get((dataset_name, title), {})
systems.append({
'title': title,
'name': dbms.name,
'planner_only': (dataset_name, title) in planner_only_systems,
'statistics_status': stats_record.get('status', 'unavailable'),
'statistics_available': stats_record.get('status') == 'success',
})
benchmarks.append({
'name': bench.name,
'fullname': bench.fullname,
'systems': systems,
'optimizer': optimizer_dbms_name.get(dataset_name),
})
return jsonify({
'status': 'ok',
'benchmarks': benchmarks,
'endpoints': {
'health': 'GET /health',
'dataset': 'POST /dataset',
'query': 'POST /query',
'plan': 'POST /plan',
'planner_statistics': 'POST /planner/statistics',
'optimize': 'POST /optimize'
}
})
@app.route('/query', methods=['POST'])
def execute_query():
"""
Execute a query on a specified DBMS.
Request JSON:
{
"dataset": "tpch", # Optional if only one dataset is loaded
"dbms": "duckdb", # Required: name of DBMS to execute on
"query": "SELECT ...", # Required: SQL query to execute
"timeout": 5, # Optional: query timeout in seconds (default: 5)
"fetch_result": true, # Optional: fetch result rows (default: true)
"fetch_result_limit": 1000 # Optional: limit result rows (default: 1000)
}
Response JSON:
{
"status": "success" | "error" | "timeout" | "fatal" | "oom",
"runtime_ms": 123.45, # Client-side total time in milliseconds
"server_time_ms": 120.5, # Server-side execution time (if available)
"rows": 42, # Number of rows (if fetch_result=true)
"columns": ["col1", "col2"], # Column names (if fetch_result=true)
"result": [[...], ...], # Result rows (if fetch_result=true)
"error": "error message" # Error message (if status != success)
}
"""
data = request.get_json()
if not data:
return error('Request body must be JSON', 400)
dbms_name = data.get('dbms')
query = data.get('query')
if not dbms_name:
return error('Missing required field: dbms', 400)
if not query:
return error('Missing required field: query', 400)
dataset_name, err = resolve_dataset(data.get('dataset'))
if err:
return err
timeout = data.get('timeout', 5)
fetch_result = data.get('fetch_result', True)
fetch_result_limit = data.get('fetch_result_limit', 1000)
# Get DBMS instance and its lock
with dbms_lock:
key = (dataset_name, dbms_name)
if key not in active_dbms:
available = [t for (d, t) in active_dbms if d == dataset_name]
return error(f'DBMS "{dbms_name}" is not active for dataset "{dataset_name}". Available: {available}', 404)
dbms = active_dbms[key]
query_lock = dbms_locks[key]
# Serialize queries to the same DBMS; fail fast if a restart is in progress
if not query_lock.acquire(blocking=False):
return error(f'DBMS "{dbms_name}" is restarting, please try again shortly', 503)
try:
result = dbms._execute(query, fetch_result=fetch_result, timeout=timeout, fetch_result_limit=fetch_result_limit)
response = {}
response['status'] = result.state
response['runtime_ms'] = result.client_total[0] if result.client_total else None
response['server_time_ms'] = result.total[0] if result.total else None
if result.state == Result.SUCCESS:
if fetch_result:
response['rows'] = result.rows
response['columns'] = result.columns
response['result'] = result.result
else:
response['error'] = result.message
return jsonify(response)
except Exception as e:
log.error(f"Unexpected error executing query on {dataset_name}/{dbms_name}: {e}")
threading.Thread(target=restart_dbms, args=(dataset_name, dbms_name), daemon=True).start()
return jsonify({'status': Result.FATAL, 'error': str(e), 'runtime_ms': None, 'server_time_ms': None})
finally:
query_lock.release()
@app.route('/plan', methods=['POST'])
def get_query_plan():
"""
Retrieve query plan for a query on a specified DBMS.
Request JSON:
{
"dataset": "tpch", # Optional if only one dataset is loaded
"dbms": "duckdb", # Required: name of DBMS to get plan from
"query": "SELECT ...", # Required: SQL query to analyze
"timeout": 5 # Optional: timeout in seconds (default: 5)
}
Response JSON:
{
"status": "success" | "error",
"query_plan": {...}, # Query plan object (if status=success and supported)
"error": "error message" # Error message (if status=error or not supported)
}
"""
data = request.get_json()
if not data:
return error('Request body must be JSON', 400)
dbms_name = data.get('dbms')
query = data.get('query')
timeout = data.get('timeout', 5)
if not dbms_name:
return error('Missing required field: dbms', 400)
if not query:
return error('Missing required field: query', 400)
dataset_name, err = resolve_dataset(data.get('dataset'))
if err:
return err
# Get DBMS instance and its lock
with dbms_lock:
key = (dataset_name, dbms_name)
if key not in active_dbms:
available = [t for (d, t) in active_dbms if d == dataset_name]
return error(f'DBMS "{dbms_name}" is not active for dataset "{dataset_name}". Available: {available}', 404)
dbms = active_dbms[key]
query_lock = dbms_locks[key]
# Serialize queries to the same DBMS; fail fast if a restart is in progress
if not query_lock.acquire(blocking=False):
return error(f'DBMS "{dbms_name}" is restarting, please try again shortly', 503)
try:
plan = dbms.retrieve_query_plan(query, include_system_representation=False, timeout=timeout)
if plan:
return jsonify({'status': 'success', 'query_plan': encode_query_plan(plan, format="json")})
return jsonify({'status': 'error', 'error': 'Query plan retrieval not supported for this DBMS'})
except Exception as e:
log.error(f"Error retrieving query plan on {dataset_name}/{dbms_name}: {e}")
return jsonify({'status': 'error', 'error': str(e)})
finally:
query_lock.release()
@app.route('/planner/statistics', methods=['POST'])
def planner_statistics():
"""
Return cached Umbra planner statistics for a target DBMS.
Request JSON:
{
"dataset": "tpch", # Optional if only one dataset is loaded
"target_dbms": "DuckDB" # Required: active system title from /health
}
"""
data = request.get_json() or {}
target_dbms = data.get('target_dbms') or data.get('dbms')
if not target_dbms:
return error('Missing required field: target_dbms', 400)
dataset_name, err = resolve_dataset(data.get('dataset'))
if err:
return err
try:
record = get_or_collect_planner_statistics(dataset_name, target_dbms)
return jsonify(record)
except Exception as e:
log.error(f"Error retrieving planner statistics for {dataset_name}/{target_dbms}: {e}")
return error(str(e), 500)
@app.route('/optimize', methods=['POST'])
def optimize():
"""
Optimize a query using Umbra's query planner.
Request JSON:
{
"dataset": "tpch", # Optional if only one dataset is loaded
"query": "SELECT ...", # Required: SQL query to optimize
"dbms": "duckdb" # Required: the dbms to optimize for
}
Response JSON:
{
"status": "success" | "error",
"optimized_query": "SELECT ...", # Optimized query (if status=success)
"error": "error message" # Error message (if status=error)
}
"""
data = request.get_json()
if not data:
return error('Request body must be JSON', 400)
query = data.get('query')
dbms = data.get('dbms')
if not query:
return error('Missing required field: query', 400)
if not dbms:
return error('Missing required field: dbms', 400)
dataset_name, err = resolve_dataset(data.get('dataset'))
if err:
return err
# Get optimizer DBMS instance
with dbms_lock:
opt_name = optimizer_dbms_name.get(dataset_name)
if opt_name is None:
return error(f'No Umbra/UmbraDev instance configured for query optimization on dataset "{dataset_name}"', 404)
opt_key = (dataset_name, opt_name)
if opt_key not in active_dbms:
return error(f'Optimizer DBMS "{opt_name}" is not active', 404)
optimizer = active_dbms[opt_key]
optimizer_lock = dbms_locks[opt_key]
# Check if optimizer supports plan_query
if not hasattr(optimizer, 'plan_query'):
return error(f'DBMS "{opt_name}" does not support query optimization', 400)
# Optimize the query
with optimizer_lock:
try:
optimized = optimizer.plan_query(query, dbms)
if optimized is None:
raise Exception('Query optimization failed')
return jsonify({
'status': 'success',
'optimized_query': optimized
})
except Exception as e:
log.error(f"Error optimizing query: {e}")
return error(str(e), 500)
@app.route('/dataset', methods=['POST'])
def get_dataset():
"""
Get information about a loaded dataset.
Request JSON:
{
"dataset": "tpch" # Optional if only one dataset is loaded
}
Response JSON:
{
"status": "success",
"benchmark": "tpch",
"schema": "CREATE TABLE ...",
"queries": [
{
"name": "1.sql",
"sql": "SELECT ...",
"clickhouse": "SELECT ...",
"duckdb": "SELECT ..."
},
...
]
}
"""
data = request.get_json() or {}
dataset_name, err = resolve_dataset(data.get('dataset'))
if err:
return err
bench = benchmark_instances[dataset_name]
try:
schema = bench.get_schema(primary_key=True, foreign_keys=False)
schema_sql = '\n\n'.join(sql.create_table_statements(schema, alter_table=False))
queries_list, query_overrides = bench.queries()
queries = []
for name, query_sql in queries_list:
entry = {'name': name, 'sql': query_sql}
for dbms_name, overrides in query_overrides.items():
if name in overrides:
entry[dbms_name] = overrides[name]
queries.append(entry)
return jsonify({
'status': 'success',
'benchmark': bench.nice_name,
'description': bench.description,
'schema': schema_sql,
'queries': queries
})
except Exception as e:
log.error(f"Error retrieving dataset info for {dataset_name}: {e}")
return error(str(e), 500)
def setup_dbms(
benchmark: Benchmark,
systems: list[dict],
db_dir: str,
data_dir: str,
base_port: int = 54320,
optimizer_name: Optional[str] = None,
optimizer_schema_only: bool = False,
):
"""
Initialize and load all specified DBMS instances for a single benchmark/dataset.
Args:
benchmark: The benchmark instance
systems: List of system configurations
db_dir: Database directory
data_dir: Data directory
base_port: Starting port for DBMS allocation
optimizer_name: Name of Umbra/UmbraDev instance for optimization (optional)
optimizer_schema_only: Load the configured optimizer with schema only
"""
dataset_name = benchmark.name
dbms_descriptions = database_systems()
log.driver(f"Preparing {benchmark.description}")
benchmark.dbgen()
port_offset = len(active_dbms)
if optimizer_schema_only and not optimizer_name:
log.warn("optimizer_schema_only is ignored unless an explicit optimizer is configured")
with dbms_lock:
for system_config in systems:
title = system_config['title']
dbms_name = system_config['dbms']
params = dict(system_config.get('params', {}))
settings = system_config.get('settings', {})
planner_only = bool(optimizer_schema_only and optimizer_name and title == optimizer_name)
if planner_only:
params['umbra_schema_only'] = True
host_port = base_port + port_offset
port_offset += 1
params['host_port'] = host_port
log.header(title)
log.driver(f"Starting {title} (dataset: {dataset_name}, dbms: {dbms_name}, params: {params}, settings: {settings})")
if dbms_name not in dbms_descriptions:
log.error(f"Unknown DBMS: {dbms_name}")
continue
try:
dbms = dbms_descriptions[dbms_name].instantiate(benchmark, db_dir, data_dir, params, settings)
dbms.__enter__()
log.driver(f"Loading {'schema' if planner_only else 'database'} for {title}...")
if planner_only:
dbms.load_schema()
else:
dbms.load_database()
key = (dataset_name, title)
active_dbms[key] = dbms
dbms_locks[key] = threading.Lock()
dbms_restart_configs[key] = {
'dbms_name': dbms_name,
'params': params,
'settings': settings,
'db_dir': db_dir,
'data_dir': data_dir,
'planner_only': planner_only,
}
if planner_only:
planner_only_systems.add(key)
log.driver(f"✓ {title} is ready (port: {host_port})")
conn_str = dbms.connection_string()
if conn_str:
log.driver(f" Connection: {conn_str}")
except Exception as e:
log.error(f"Failed to start {title}: {e}")
raise
# Determine optimizer DBMS for this dataset
if optimizer_name:
if (dataset_name, optimizer_name) not in active_dbms:
log.error(f"Specified optimizer '{optimizer_name}' not found in active DBMS for dataset '{dataset_name}'")
else:
optimizer_dbms_name[dataset_name] = optimizer_name
log.driver(f"Using {optimizer_name} for query optimization on dataset '{dataset_name}'")
else:
for (d, title), dbms in active_dbms.items():
if d == dataset_name and hasattr(dbms, 'plan_query'):
optimizer_dbms_name[dataset_name] = title
log.driver(f"Using {title} for query optimization on dataset '{dataset_name}' (auto-detected)")
break
if dataset_name not in optimizer_dbms_name:
optimizer_dbms_name[dataset_name] = None
log.driver(f"No Umbra/UmbraDev instance found for query optimization on dataset '{dataset_name}'")
def parse_args():
"""Parse command-line arguments."""
parser = argparse.ArgumentParser(
description='HTTP server for interactive OLAP benchmark querying',
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog="""
Example:
./server.py -j server_config.yaml --port 5000
server_config.yaml format (single dataset):
benchmark:
name: tpch
scale: 1
systems:
- title: DuckDB
dbms: duckdb
params:
version: latest
settings:
max_memory: 8GB
server_config.yaml format (multiple datasets, shared systems):
datasets:
- name: tpch
scale: 1
- name: job
systems:
- title: DuckDB
dbms: duckdb
- title: ClickHouse
dbms: clickhouse
Endpoints:
GET /health - Server health and status
POST /dataset - Schema and queries (add "dataset" field for multiple datasets)
POST /query - Execute query on specified DBMS (add "dataset" field for multiple datasets)
POST /plan - Get query plan for a query
POST /planner/statistics - Get cached Umbra planner statistics for a target DBMS
POST /optimize - Optimize query using Umbra (if configured)
"""
)
parser.add_argument('-j', '--json', required=True, help='YAML configuration file')
parser.add_argument('--db-dir', default=os.path.join(workdir, 'db'), help='Database directory (default: ./db)')
parser.add_argument('--data-dir', default=os.path.join(workdir, 'data'), help='Data directory (default: ./data)')
parser.add_argument('--base-port', type=int, default=55000, help='Starting port for DBMS allocation (default: 54320)')
parser.add_argument('--port', type=int, default=5000, help='HTTP server port (default: 5000)')
parser.add_argument('--host', default='0.0.0.0', help='HTTP server host (default: 0.0.0.0)')
parser.add_argument('-v', '--verbose', action='store_true', help='Enable verbose logging')
parser.add_argument('-vv', '--very-verbose', action='store_true', help='Enable very verbose logging')
benchmark_arguments(parser, required=False)
return parser.parse_args()
def load_config(config_path: str) -> dict:
"""Load and validate the YAML configuration file against the schema."""
return schemajson.load(config_path, "server.schema.json")
def _instantiate_benchmark(benchmark_config: dict) -> Benchmark:
"""Instantiate a Benchmark from a config dict."""
benchmark_name = benchmark_config.get('name')
if not benchmark_name:
raise ValueError("benchmark config must specify 'name'")
benchmark_map = benchmarks()
if benchmark_name not in benchmark_map:
raise ValueError(f"Unknown benchmark: {benchmark_name}. Available: {list(benchmark_map.keys())}")
return benchmark_map[benchmark_name].instantiate('./', benchmark_config)
def _parse_systems(systems_config: list) -> list[dict]:
"""Expand system configs (unfold parameter/settings templates)."""
systems = []
for system_config in systems_config:
if system_config.get('disabled', False):
continue
params = system_config.get('parameter', {})
settings = system_config.get('settings', {})
for params in unfold(params):
for settings in unfold(settings):
template = Template(system_config['title'])
title = template.substitute(**settings, **params)
systems.append({
'title': title,
'dbms': system_config['dbms'],
'params': params,
'settings': settings
})
return systems
def build_frontend():
"""Build the React frontend if source is present."""
import subprocess
frontend_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'frontend')
if not os.path.exists(os.path.join(frontend_dir, 'package.json')):
return
log.driver("Building frontend...")
subprocess.run(['npm', 'install', '--legacy-peer-deps'], cwd=frontend_dir, check=True)
subprocess.run(['npm', 'run', 'build'], cwd=frontend_dir, check=True)
log.driver("Frontend built.")
def main():
"""Main entry point."""
args = parse_args()
log.set_very_verbose(args.very_verbose)
log.set_verbose(args.verbose)
try:
build_frontend()
except Exception as e:
log.error(f"Failed to build frontend: {e}")
sys.exit(1)
try:
config = load_config(args.json)
except Exception as e:
log.error(f"Failed to load configuration: {e}")
sys.exit(1)
# Shared systems list — same for all datasets
systems_config = config.get('systems', [])
optimizer_name = config.get('optimizer', None)
optimizer_schema_only = bool(config.get('optimizer_schema_only', False))
systems = _parse_systems(systems_config)
if not systems:
log.error("No systems configured")
sys.exit(1)
# Collect benchmark configs. Priority:
# 1. CLI benchmark argument (if not "default" or None)
# 2. "datasets" list in config
# 3. "benchmark" dict in config (single-dataset legacy)
cli_benchmark = getattr(args, 'benchmark', None)
if cli_benchmark and cli_benchmark != 'default':
cli_args = vars(args)
benchmark_configs = [{**cli_args, 'name': cli_benchmark}]
elif 'datasets' in config:
benchmark_configs = config['datasets']
else:
benchmark_config = config.get('benchmark', {})
if not benchmark_config:
log.error("Configuration must specify 'benchmark', 'datasets', or a CLI benchmark argument")
sys.exit(1)
benchmark_configs = [benchmark_config]
atexit.register(cleanup_dbms)
for benchmark_config in benchmark_configs:
try:
bench = _instantiate_benchmark(benchmark_config)
except Exception as e:
log.error(f"Failed to instantiate benchmark: {e}")
cleanup_dbms()
sys.exit(1)
benchmark_instances[bench.name] = bench
try:
setup_dbms(
bench,