-
Notifications
You must be signed in to change notification settings - Fork 239
/
db.py
1936 lines (1703 loc) · 70.2 KB
/
db.py
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
from copy import deepcopy
from datetime import datetime, timedelta, timezone
from typing import Any, List, Dict
import mergedeep
import pytz
from sqlalchemy import and_, func
from sqlalchemy.exc import SQLAlchemyError
from sqlalchemy.orm import Session
import mlrun.errors
import mlrun.api.utils.projects.remotes.member
from mlrun.api import schemas
from mlrun.api.db.base import DBError, DBInterface
from mlrun.api.db.sqldb.helpers import (
label_set,
run_start_time,
run_labels,
run_state,
update_labels,
)
from mlrun.api.db.sqldb.models import (
Artifact,
Function,
Log,
Run,
Schedule,
User,
Project,
FeatureSet,
Feature,
Entity,
FeatureVector,
_tagged,
_labeled,
)
from mlrun.api.utils.singletons.project_member import get_project_member
from mlrun.config import config
from mlrun.lists import ArtifactList, FunctionList, RunList
from mlrun.utils import (
get_in,
update_in,
logger,
fill_function_hash,
fill_object_hash,
generate_object_uri,
match_times,
)
NULL = None # Avoid flake8 issuing warnings when comparing in filter
run_time_fmt = "%Y-%m-%dT%H:%M:%S.%fZ"
unversioned_tagged_object_uid_prefix = "unversioned-"
class SQLDB(mlrun.api.utils.projects.remotes.member.Member, DBInterface):
def __init__(self, dsn):
self.dsn = dsn
def initialize(self, session):
return
def store_log(self, session, uid, project="", body=b"", append=False):
project = project or config.default_project
get_project_member().ensure_project(session, project)
log = self._query(session, Log, uid=uid, project=project).one_or_none()
if not log:
log = Log(uid=uid, project=project, body=body)
elif body:
if append:
log.body += body
else:
log.body = body
self._upsert(session, log)
def get_log(self, session, uid, project="", offset=0, size=0):
project = project or config.default_project
log = self._query(session, Log, uid=uid, project=project).one_or_none()
if not log:
return None, None
end = None if size == 0 else offset + size
return "", log.body[offset:end]
def delete_log(self, session: Session, project: str, uid: str):
project = project or config.default_project
self._delete(session, Log, project=project, uid=uid)
def _delete_logs(self, session: Session, project: str):
logger.debug("Removing logs from db", project=project)
for log in self._list_logs(session, project):
self.delete_log(session, project, log.uid)
def _list_logs(self, session: Session, project: str):
return self._query(session, Log, project=project).all()
def store_run(self, session, run_data, uid, project="", iter=0):
project = project or config.default_project
logger.debug(
"Storing run to db", project=project, uid=uid, iter=iter, run=run_data
)
get_project_member().ensure_project(session, project)
run = self._get_run(session, uid, project, iter)
if not run:
run = Run(
uid=uid,
project=project,
iteration=iter,
state=run_state(run_data),
start_time=run_start_time(run_data) or datetime.now(timezone.utc),
)
labels = run_labels(run_data)
new_state = run_state(run_data)
if new_state:
run.state = new_state
update_labels(run, labels)
run.struct = run_data
self._upsert(session, run, ignore=True)
def update_run(self, session, updates: dict, uid, project="", iter=0):
project = project or config.default_project
run = self._get_run(session, uid, project, iter)
if not run:
raise DBError(f"run {uid}:{project} not found")
struct = run.struct
for key, val in updates.items():
update_in(struct, key, val)
run.struct = struct
new_state = run_state(struct)
if new_state:
run.state = new_state
start_time = run_start_time(struct)
if start_time:
run.start_time = start_time
run.labels.clear()
for name, value in run_labels(struct).items():
lbl = Run.Label(name=name, value=value, parent=run.id)
run.labels.append(lbl)
session.merge(run)
session.commit()
self._delete_empty_labels(session, Run.Label)
def read_run(self, session, uid, project=None, iter=0):
project = project or config.default_project
run = self._get_run(session, uid, project, iter)
if not run:
raise mlrun.errors.MLRunNotFoundError(f"Run {uid}:{project} not found")
return run.struct
def list_runs(
self,
session,
name=None,
uid=None,
project=None,
labels=None,
state=None,
sort=True,
last=0,
iter=False,
start_time_from=None,
start_time_to=None,
last_update_time_from=None,
last_update_time_to=None,
):
project = project or config.default_project
query = self._find_runs(session, uid, project, labels)
if start_time_from:
query = query.filter(Run.start_time >= start_time_from)
if start_time_to:
query = query.filter(Run.start_time <= start_time_to)
if sort:
query = query.order_by(Run.start_time.desc())
if last:
query = query.limit(last)
if not iter:
query = query.filter(Run.iteration == 0)
filtered_runs = self._post_query_runs_filter(
query, name, state, last_update_time_from, last_update_time_to
)
runs = RunList()
for run in filtered_runs:
runs.append(run.struct)
return runs
def del_run(self, session, uid, project=None, iter=0):
project = project or config.default_project
# We currently delete *all* iterations
self._delete(session, Run, uid=uid, project=project)
def del_runs(
self, session, name=None, project=None, labels=None, state=None, days_ago=0
):
# FIXME: Run has no `name`
project = project or config.default_project
query = self._find_runs(session, None, project, labels)
if days_ago:
since = datetime.now(timezone.utc) - timedelta(days=days_ago)
query = query.filter(Run.start_time >= since)
filtered_runs = self._post_query_runs_filter(query, name, state)
for run in filtered_runs: # Can not use query.delete with join
session.delete(run)
session.commit()
def store_artifact(
self, session, key, artifact, uid, iter=None, tag="", project=""
):
project = project or config.default_project
get_project_member().ensure_project(session, project)
artifact = artifact.copy()
updated = artifact.get("updated")
if not updated:
updated = artifact["updated"] = datetime.now(timezone.utc)
if iter:
key = "{}-{}".format(iter, key)
art = self._get_artifact(session, uid, project, key)
labels = artifact.get("labels", {})
if not art:
art = Artifact(key=key, uid=uid, updated=updated, project=project)
update_labels(art, labels)
art.struct = artifact
self._upsert(session, art)
tag = tag or "latest"
self.tag_objects(session, [art], project, tag)
def read_artifact(self, session, key, tag="", iter=None, project=""):
project = project or config.default_project
uids = self._resolve_tag(session, Artifact, project, tag)
if iter:
key = "{}-{}".format(iter, key)
query = self._query(session, Artifact, key=key, project=project)
# TODO: refactor this
# tag has 2 meanings:
# 1. tag - in this case _resolve_tag will find the relevant uids and will return a list
# 2. uid - in this case _resolve_tag won't find anything and simply return what was given to it, which actually
# represents the uid
if isinstance(uids, list) and uids:
query = query.filter(Artifact.uid.in_(uids))
elif isinstance(uids, str) and uids:
query = query.filter(Artifact.uid == uids)
else:
# Select by last updated
max_updated = session.query(func.max(Artifact.updated)).filter(
Artifact.project == project, Artifact.key == key
)
query = query.filter(Artifact.updated.in_(max_updated))
art = query.one_or_none()
if not art:
raise DBError(f"Artifact {key}:{tag}:{project} not found")
return art.struct
def list_artifacts(
self,
session,
name=None,
project=None,
tag=None,
labels=None,
since=None,
until=None,
kind=None,
category: schemas.ArtifactCategories = None,
):
project = project or config.default_project
# TODO: Refactor this area
# in case where tag is not given uids will be "latest" to mark to _find_artifacts to find the latest using the
# old way - by the updated field
uids = "latest"
if tag:
uids = self._resolve_tag(session, Artifact, project, tag)
artifacts = ArtifactList(
artifact.struct
for artifact in self._find_artifacts(
session, project, uids, labels, since, until, name, kind, category
)
)
return artifacts
def del_artifact(self, session, key, tag="", project=""):
project = project or config.default_project
self._delete_artifact_tags(session, project, key, tag, commit=False)
self._delete_class_labels(
session, Artifact, project=project, key=key, commit=False
)
kw = {
"key": key,
"project": project,
}
if tag:
kw["tag"] = tag
self._delete(session, Artifact, **kw)
def _delete_artifact_tags(
self, session, project, artifact_key, tag_name="", commit=True
):
query = (
session.query(Artifact.Tag)
.join(Artifact)
.filter(Artifact.project == project, Artifact.key == artifact_key)
)
if tag_name:
query = query.filter(Artifact.Tag.name == tag_name)
for tag in query:
session.delete(tag)
if commit:
session.commit()
def del_artifacts(self, session, name="", project="", tag="*", labels=None):
project = project or config.default_project
for artifact in self._find_artifacts(session, project, tag, labels, name=name):
self.del_artifact(session, artifact.key, "", project)
def store_function(
self, session, function, name, project="", tag="", versioned=False
):
project = project or config.default_project
get_project_member().ensure_project(session, project)
tag = tag or get_in(function, "metadata.tag") or "latest"
hash_key = fill_function_hash(function, tag)
# clear tag from object in case another function will "take" that tag
update_in(function, "metadata.tag", "")
# versioned means whether we want to version this function object so that it will queryable by its hash key
# to enable that we set the uid to the hash key so it will have a unique record (Unique constraint of function
# is the set (project, name, uid))
# when it's not enabled it means we want to have one unique function object for the set (project, name, tag)
# that will be reused on every store function (cause we don't want to version each version e.g. create a new
# record) so we set the uid to be unversioned-{tag}
if versioned:
uid = hash_key
else:
uid = f"{unversioned_tagged_object_uid_prefix}{tag}"
updated = datetime.now(timezone.utc)
update_in(function, "metadata.updated", updated)
fn = self._get_class_instance_by_uid(session, Function, name, project, uid)
if not fn:
fn = Function(name=name, project=project, uid=uid,)
fn.updated = updated
labels = get_in(function, "metadata.labels", {})
update_labels(fn, labels)
fn.struct = function
self._upsert(session, fn)
self.tag_objects_v2(session, [fn], project, tag)
return hash_key
def get_function(self, session, name, project="", tag="", hash_key=""):
project = project or config.default_project
query = self._query(session, Function, name=name, project=project)
computed_tag = tag or "latest"
tag_function_uid = None
if not tag and hash_key:
uid = hash_key
else:
tag_function_uid = self._resolve_class_tag_uid(
session, Function, project, name, computed_tag
)
if tag_function_uid is None:
function_uri = generate_object_uri(project, name, tag)
raise mlrun.errors.MLRunNotFoundError(
f"Function tag not found {function_uri}"
)
uid = tag_function_uid
if uid:
query = query.filter(Function.uid == uid)
obj = query.one_or_none()
if obj:
function = obj.struct
# If queried by hash key remove status
if hash_key:
function["status"] = None
# If connected to a tag add it to metadata
if tag_function_uid:
function["metadata"]["tag"] = computed_tag
return function
else:
function_uri = generate_object_uri(project, name, tag, hash_key)
raise mlrun.errors.MLRunNotFoundError(f"Function not found {function_uri}")
def delete_function(self, session: Session, project: str, name: str):
logger.debug("Removing function from db", project=project, name=name)
self._delete_function_tags(session, project, name, commit=False)
self._delete_class_labels(
session, Function, project=project, name=name, commit=False
)
self._delete(session, Function, project=project, name=name)
def _delete_functions(self, session: Session, project: str):
for function in self._list_project_functions(session, project):
self.delete_function(session, project, function.name)
def _list_project_functions(self, session: Session, project: str):
return self._query(session, Function, project=project).all()
def _delete_resources_tags(self, session: Session, project: str):
for tagged_class in _tagged:
self._delete(session, tagged_class, project=project)
def _delete_resources_labels(self, session: Session, project: str):
for labeled_class in _labeled:
if hasattr(labeled_class, "project"):
self._delete(session, labeled_class, project=project)
def list_functions(self, session, name=None, project=None, tag=None, labels=None):
project = project or config.default_project
uids = None
if tag:
uids = self._resolve_class_tag_uids(session, Function, project, tag, name)
functions = FunctionList()
for function in self._find_functions(session, name, project, uids, labels):
function_dict = function.struct
if not tag:
function_tags = self._list_function_tags(session, project, function.id)
if len(function_tags) == 0:
# function status should be added only to tagged functions
function_dict["status"] = None
# the unversioned uid is only a place holder for tagged instance that are is versioned
# if another instance "took" the tag, we're left with an unversioned untagged instance
# don't list it
if function.uid.startswith(unversioned_tagged_object_uid_prefix):
continue
functions.append(function_dict)
elif len(function_tags) == 1:
function_dict["metadata"]["tag"] = function_tags[0]
functions.append(function_dict)
else:
for function_tag in function_tags:
function_dict_copy = deepcopy(function_dict)
function_dict_copy["metadata"]["tag"] = function_tag
functions.append(function_dict_copy)
else:
function_dict["metadata"]["tag"] = tag
functions.append(function_dict)
return functions
def _delete_function_tags(self, session, project, function_name, commit=True):
query = session.query(Function.Tag).filter(
Function.Tag.project == project, Function.Tag.obj_name == function_name
)
for obj in query:
session.delete(obj)
if commit:
session.commit()
def _list_function_tags(self, session, project, function_id):
query = (
session.query(Function.Tag.name)
.filter(Function.Tag.project == project, Function.Tag.obj_id == function_id)
.distinct()
)
return [row[0] for row in query]
def list_artifact_tags(self, session, project):
query = (
session.query(Artifact.Tag.name)
.filter(Artifact.Tag.project == project)
.distinct()
)
return [row[0] for row in query]
def create_schedule(
self,
session: Session,
project: str,
name: str,
kind: schemas.ScheduleKinds,
scheduled_object: Any,
cron_trigger: schemas.ScheduleCronTrigger,
labels: Dict = None,
):
schedule = Schedule(
project=project,
name=name,
kind=kind.value,
creation_time=datetime.now(timezone.utc),
# these are properties of the object that map manually (using getters and setters) to other column of the
# table and therefore Pycharm yells that they're unexpected
scheduled_object=scheduled_object,
cron_trigger=cron_trigger,
)
labels = labels or {}
update_labels(schedule, labels)
logger.debug(
"Saving schedule to db",
project=project,
name=name,
kind=kind,
cron_trigger=cron_trigger,
)
self._upsert(session, schedule)
def update_schedule(
self,
session: Session,
project: str,
name: str,
scheduled_object: Any = None,
cron_trigger: schemas.ScheduleCronTrigger = None,
labels: Dict = None,
last_run_uri: str = None,
):
get_project_member().ensure_project(session, project)
query = self._query(session, Schedule, project=project, name=name)
schedule = query.one_or_none()
# explicitly ensure the updated fields are not None, as they can be empty strings/dictionaries etc.
if scheduled_object is not None:
schedule.scheduled_object = scheduled_object
if cron_trigger is not None:
schedule.cron_trigger = cron_trigger
if labels is not None:
update_labels(schedule, labels)
if last_run_uri is not None:
schedule.last_run_uri = last_run_uri
logger.debug(
"Updating schedule in db",
project=project,
name=name,
cron_trigger=cron_trigger,
labels=labels,
)
session.merge(schedule)
session.commit()
def list_schedules(
self,
session: Session,
project: str = None,
name: str = None,
labels: str = None,
kind: schemas.ScheduleKinds = None,
) -> List[schemas.ScheduleRecord]:
logger.debug("Getting schedules from db", project=project, name=name, kind=kind)
query = self._query(session, Schedule, project=project, kind=kind)
if name is not None:
query = query.filter(Schedule.name.ilike(f"%{name}%"))
labels = label_set(labels)
query = self._add_labels_filter(session, query, Schedule, labels)
schedules = [
self._transform_schedule_model_to_scheme(db_schedule)
for db_schedule in query
]
return schedules
def get_schedule(
self, session: Session, project: str, name: str
) -> schemas.ScheduleRecord:
logger.debug("Getting schedule from db", project=project, name=name)
query = self._query(session, Schedule, project=project, name=name)
db_schedule = query.one_or_none()
schedule = self._transform_schedule_model_to_scheme(db_schedule)
return schedule
def delete_schedule(self, session: Session, project: str, name: str):
logger.debug("Removing schedule from db", project=project, name=name)
self._delete_class_labels(
session, Schedule, project=project, name=name, commit=False
)
self._delete(session, Schedule, project=project, name=name)
def _delete_schedules(self, session: Session, project: str):
logger.debug("Removing schedules from db", project=project)
for schedule in self.list_schedules(session, project=project):
self.delete_schedule(session, project, schedule.name)
def _delete_feature_sets(self, session: Session, project: str):
logger.debug("Removing feature-sets from db", project=project)
for feature_set in self.list_feature_sets(session, project).feature_sets:
self.delete_feature_set(session, project, feature_set.metadata.name)
def _delete_feature_vectors(self, session: Session, project: str):
logger.debug("Removing feature-vectors from db", project=project)
for feature_vector in self.list_feature_vectors(
session, project
).feature_vectors:
self.delete_feature_vector(session, project, feature_vector.metadata.name)
def tag_objects(self, session, objs, project: str, name: str):
"""Tag objects with (project, name) tag.
If force==True will update tag
"""
for obj in objs:
tag = obj.Tag(project=project, name=name, obj_id=obj.id)
self._upsert(session, tag, ignore=True)
def tag_objects_v2(self, session, objs, project: str, name: str):
"""Tag objects with (project, name) tag.
If force==True will update tag
"""
for obj in objs:
query = self._query(
session, obj.Tag, name=name, project=project, obj_name=obj.name
)
tag = query.one_or_none()
if not tag:
tag = obj.Tag(project=project, name=name, obj_name=obj.name)
tag.obj_id = obj.id
session.add(tag)
session.commit()
def del_tag(self, session, project: str, name: str):
"""Remove tag (project, name) from all objects"""
count = 0
for cls in _tagged:
for obj in self._query(session, cls.Tag, project=project, name=name):
session.delete(obj)
count += 1
session.commit()
return count
def find_tagged(self, session, project: str, name: str):
"""Return all objects tagged with (project, name)
If not tag found, will return an empty str.
"""
db_objects = []
for cls in _tagged:
for tag in self._query(session, cls.Tag, project=project, name=name):
db_objects.append(self._query(session, cls).get(tag.obj_id))
# TODO: this shouldn't return the db objects as is, sometimes they might be encoded with pickle, should
# something like:
# objects = [db_object.struct if hasattr(db_object, "struct") else db_object for db_object in db_objects]
return db_objects
def list_tags(self, session, project: str):
"""Return all tags for a project"""
tags = set()
for cls in _tagged:
for tag in self._query(session, cls.Tag, project=project):
tags.add(tag.name)
return tags
def create_project(self, session: Session, project: schemas.Project):
logger.debug("Creating project in DB", project=project)
created = datetime.utcnow()
project.metadata.created = created
# TODO: handle taking out the functions/workflows/artifacts out of the project and save them separately
project_record = Project(
name=project.metadata.name,
description=project.spec.description,
source=project.spec.source,
state=project.status.state,
created=created,
full_object=project.dict(),
)
labels = project.metadata.labels or {}
update_labels(project_record, labels)
self._upsert(session, project_record)
def store_project(self, session: Session, name: str, project: schemas.Project):
logger.debug("Storing project in DB", name=name, project=project)
project_record = self._get_project_record(
session, name, raise_on_not_found=False
)
if not project_record:
self.create_project(session, project)
else:
self._update_project_record_from_project(session, project_record, project)
def patch_project(
self,
session: Session,
name: str,
project: dict,
patch_mode: schemas.PatchMode = schemas.PatchMode.replace,
):
logger.debug(
"Patching project in DB", name=name, project=project, patch_mode=patch_mode
)
project_record = self._get_project_record(session, name)
self._patch_project_record_from_project(
session, name, project_record, project, patch_mode
)
def get_project(
self, session: Session, name: str = None, project_id: int = None
) -> schemas.Project:
project_record = self._get_project_record(session, name, project_id)
return self._transform_project_record_to_schema(session, project_record)
def delete_project(
self,
session: Session,
name: str,
deletion_strategy: schemas.DeletionStrategy = schemas.DeletionStrategy.default(),
):
logger.debug(
"Deleting project from DB", name=name, deletion_strategy=deletion_strategy
)
if deletion_strategy == schemas.DeletionStrategy.restrict:
project_record = self._get_project_record(
session, name, raise_on_not_found=False
)
if not project_record:
return
self._verify_project_has_no_related_resources(session, name)
elif deletion_strategy == schemas.DeletionStrategy.cascade:
self._delete_project_related_resources(session, name)
else:
raise mlrun.errors.MLRunInvalidArgumentError(
f"Unknown deletion strategy: {deletion_strategy}"
)
self._delete(session, Project, name=name)
def list_projects(
self,
session: Session,
owner: str = None,
format_: mlrun.api.schemas.Format = mlrun.api.schemas.Format.full,
labels: List[str] = None,
state: mlrun.api.schemas.ProjectState = None,
) -> schemas.ProjectsOutput:
query = self._query(session, Project, owner=owner, state=state)
if labels:
query = self._add_labels_filter(session, query, Project, labels)
projects = []
for project_record in query:
if format_ == mlrun.api.schemas.Format.name_only:
projects.append(project_record.name)
elif format_ == mlrun.api.schemas.Format.full:
projects.append(
self._transform_project_record_to_schema(session, project_record)
)
else:
raise NotImplementedError(
f"Provided format is not supported. format={format_}"
)
return schemas.ProjectsOutput(projects=projects)
def _update_project_record_from_project(
self, session: Session, project_record: Project, project: schemas.Project
):
project.metadata.created = project_record.created
project_dict = project.dict()
# TODO: handle taking out the functions/workflows/artifacts out of the project and save them separately
project_record.full_object = project_dict
project_record.description = project.spec.description
project_record.source = project.spec.source
project_record.state = project.status.state
labels = project.metadata.labels or {}
update_labels(project_record, labels)
self._upsert(session, project_record)
def _patch_project_record_from_project(
self,
session: Session,
name: str,
project_record: Project,
project: dict,
patch_mode: schemas.PatchMode,
):
project.setdefault("metadata", {})["created"] = project_record.created
strategy = patch_mode.to_mergedeep_strategy()
project_record_full_object = project_record.full_object
mergedeep.merge(project_record_full_object, project, strategy=strategy)
# If a bad kind value was passed, it will fail here (return 422 to caller)
project = schemas.Project(**project_record_full_object)
self.store_project(
session, name, project,
)
project_record.full_object = project_record_full_object
self._upsert(session, project_record)
def _get_project_record(
self,
session: Session,
name: str = None,
project_id: int = None,
raise_on_not_found: bool = True,
) -> Project:
if not any([project_id, name]):
raise mlrun.errors.MLRunInvalidArgumentError(
"One of 'name' or 'project_id' must be provided"
)
project_record = self._query(
session, Project, name=name, id=project_id
).one_or_none()
if not project_record:
if not raise_on_not_found:
return None
raise mlrun.errors.MLRunNotFoundError(
f"Project not found: name={name}, project_id={project_id}"
)
return project_record
def _verify_project_has_no_related_resources(self, session: Session, project: str):
artifacts = self._find_artifacts(session, project, "*")
self._verify_empty_list_of_project_related_resources(
project, artifacts, "artifacts"
)
logs = self._list_logs(session, project)
self._verify_empty_list_of_project_related_resources(project, logs, "logs")
runs = self._find_runs(session, None, project, []).all()
self._verify_empty_list_of_project_related_resources(project, runs, "runs")
schedules = self.list_schedules(session, project=project)
self._verify_empty_list_of_project_related_resources(
project, schedules, "schedules"
)
functions = self._list_project_functions(session, project)
self._verify_empty_list_of_project_related_resources(
project, functions, "functions"
)
feature_sets = self.list_feature_sets(session, project).feature_sets
self._verify_empty_list_of_project_related_resources(
project, feature_sets, "feature_sets"
)
feature_vectors = self.list_feature_vectors(session, project).feature_vectors
self._verify_empty_list_of_project_related_resources(
project, feature_vectors, "feature_vectors"
)
def _delete_project_related_resources(self, session: Session, name: str):
self.del_artifacts(session, project=name)
self._delete_logs(session, name)
self.del_runs(session, project=name)
self._delete_schedules(session, name)
self._delete_functions(session, name)
self._delete_feature_sets(session, name)
self._delete_feature_vectors(session, name)
# resources deletion should remove their tags and labels as well, but doing another try in case there are
# orphan resources
self._delete_resources_tags(session, name)
self._delete_resources_labels(session, name)
@staticmethod
def _verify_empty_list_of_project_related_resources(
project: str, resources: List, resource_name: str
):
if resources:
raise mlrun.errors.MLRunPreconditionFailedError(
f"Project {project} can not be deleted since related resources found: {resource_name}"
)
def _get_record_by_name_tag_and_uid(
self, session, cls, project: str, name: str, tag: str = None, uid: str = None,
):
query = self._query(session, cls, name=name, project=project)
computed_tag = tag or "latest"
object_tag_uid = None
if tag or not uid:
object_tag_uid = self._resolve_class_tag_uid(
session, cls, project, name, computed_tag
)
if object_tag_uid is None:
return None, None, None
uid = object_tag_uid
if uid:
query = query.filter(cls.uid == uid)
return computed_tag, object_tag_uid, query.one_or_none()
def _get_feature_set(
self, session, project: str, name: str, tag: str = None, uid: str = None,
):
(
computed_tag,
feature_set_tag_uid,
db_feature_set,
) = self._get_record_by_name_tag_and_uid(
session, FeatureSet, project, name, tag, uid
)
if db_feature_set:
feature_set = self._transform_feature_set_model_to_schema(db_feature_set)
# If connected to a tag add it to metadata
if feature_set_tag_uid:
feature_set.metadata.tag = computed_tag
return feature_set
else:
return None
def get_feature_set(
self, session, project: str, name: str, tag: str = None, uid: str = None,
) -> schemas.FeatureSet:
feature_set = self._get_feature_set(session, project, name, tag, uid)
if not feature_set:
feature_set_uri = generate_object_uri(project, name, tag)
raise mlrun.errors.MLRunNotFoundError(
f"Feature-set not found {feature_set_uri}"
)
return feature_set
def _get_records_to_tags_map(self, session, cls, project, tag, name=None):
# Find object IDs by tag, project and feature-set-name (which is a like query)
tag_query = self._query(session, cls.Tag, project=project, name=tag)
if name:
tag_query = tag_query.filter(cls.Tag.obj_name.ilike(f"%{name}%"))
# Generate a mapping from each object id (note: not uid, it's the DB ID) to its associated tags.
obj_id_tags = {}
for row in tag_query:
if row.obj_id in obj_id_tags:
obj_id_tags[row.obj_id].append(row.name)
else:
obj_id_tags[row.obj_id] = [row.name]
return obj_id_tags
def _generate_records_with_tags_assigned(
self, object_record, transform_fn, obj_id_tags, default_tag=None
):
# Using a similar mechanism here to assign tags to feature sets as is used in list_functions. Please refer
# there for some comments explaining the logic.
results = []
if default_tag:
results.append(transform_fn(object_record, default_tag))
else:
object_tags = obj_id_tags.get(object_record.id, [])
if len(object_tags) == 0 and not object_record.uid.startswith(
unversioned_tagged_object_uid_prefix
):
new_object = transform_fn(object_record)
results.append(new_object)
else:
for object_tag in object_tags:
results.append(transform_fn(object_record, object_tag))
return results
@staticmethod
def _generate_feature_set_digest(feature_set: schemas.FeatureSet):
return schemas.FeatureSetDigestOutput(
metadata=feature_set.metadata,
spec=schemas.FeatureSetDigestSpec(
entities=feature_set.spec.entities, features=feature_set.spec.features,
),
)
def _generate_feature_or_entity_list_query(
self,
session,
query_class,
project: str,
feature_set_keys,
name: str = None,
tag: str = None,
labels: List[str] = None,
):
# Query the actual objects to be returned
query = (
session.query(FeatureSet, query_class)
.filter_by(project=project)
.join(query_class)
)
if name:
query = query.filter(query_class.name.ilike(f"%{name}%"))
if labels:
query = self._add_labels_filter(session, query, query_class, labels)
if tag:
query = query.filter(FeatureSet.id.in_(feature_set_keys))
return query
def list_features(
self,
session,
project: str,
name: str = None,
tag: str = None,
entities: List[str] = None,
labels: List[str] = None,
) -> schemas.FeaturesOutput:
# We don't filter by feature-set name here, as the name parameter refers to features
feature_set_id_tags = self._get_records_to_tags_map(
session, FeatureSet, project, tag, name=None
)
query = self._generate_feature_or_entity_list_query(
session, Feature, project, feature_set_id_tags.keys(), name, tag, labels
)
if entities:
query = query.join(FeatureSet.entities).filter(Entity.name.in_(entities))