-
Notifications
You must be signed in to change notification settings - Fork 308
/
did.py
726 lines (570 loc) · 27.6 KB
/
did.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
# -*- coding: utf-8 -*-
# Copyright European Organization for Nuclear Research (CERN) since 2012
#
# 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
#
# http://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.
from copy import deepcopy
from typing import TYPE_CHECKING
import rucio.api.permission
from rucio.common.constants import RESERVED_KEYS
from rucio.common.exception import RucioException
from rucio.common.schema import validate_schema
from rucio.common.types import InternalAccount, InternalScope
from rucio.common.utils import api_update_return_dict
from rucio.core import did, naming_convention, meta as meta_core
from rucio.core.rse import get_rse_id
from rucio.db.sqla.constants import DIDType
from rucio.db.sqla.session import read_session, stream_session, transactional_session
if TYPE_CHECKING:
from typing import Any, Optional
from sqlalchemy.orm import Session
@stream_session
def list_dids(scope, filters, did_type='collection', ignore_case=False, limit=None, offset=None, long=False, recursive=False, vo='def', *, session: "Session"):
"""
List dids in a scope.
:param scope: The scope name.
:param filters: Filter arguments in form supported by the filter engine.
:param did_type: The type of the did: all(container, dataset, file), collection(dataset or container), dataset, container
:param ignore_case: Ignore case distinctions.
:param limit: The maximum number of DIDs returned.
:param offset: Offset number.
:param long: Long format option to display more information for each DID.
:param recursive: Recursively list DIDs content.
:param vo: The VO to act on.
:param session: The database session in use.
"""
scope = InternalScope(scope, vo=vo)
# replace account and scope in filters with internal representation
for or_group in filters:
if 'account' in or_group:
or_group['account'] = InternalAccount(or_group['account'], vo=vo)
if 'scope' in or_group:
or_group['account'] = InternalScope(or_group['scope'], vo=vo)
result = did.list_dids(scope=scope, filters=filters, did_type=did_type, ignore_case=ignore_case,
limit=limit, offset=offset, long=long, recursive=recursive, session=session)
for d in result:
yield api_update_return_dict(d, session=session)
@transactional_session
def add_did(scope, name, did_type, issuer, account=None, statuses={}, meta={}, rules=[], lifetime=None, dids=[], rse=None, vo='def', *, session: "Session"):
"""
Add data did.
:param scope: The scope name.
:param name: The data identifier name.
:param did_type: The data identifier type.
:param issuer: The issuer account.
:param account: The account owner. If None, then issuer is selected as owner.
:param statuses: Dictionary with statuses, e.g.g {'monotonic':True}.
:meta: Meta-data associated with the data identifier is represented using key/value pairs in a dictionary.
:rules: Replication rules associated with the data did. A list of dictionaries, e.g., [{'copies': 2, 'rse_expression': 'TIERS1'}, ].
:param lifetime: DID's lifetime (in seconds).
:param dids: The content.
:param rse: The RSE name when registering replicas.
:param vo: The VO to act on.
:param session: The database session in use.
"""
v_did = {'name': name, 'type': did_type.upper(), 'scope': scope}
validate_schema(name='did', obj=v_did, vo=vo)
validate_schema(name='dids', obj=dids, vo=vo)
validate_schema(name='rse', obj=rse, vo=vo)
kwargs = {'scope': scope, 'name': name, 'type': did_type, 'issuer': issuer, 'account': account, 'statuses': statuses, 'meta': meta, 'rules': rules, 'lifetime': lifetime}
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='add_did', kwargs=kwargs, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not add data identifier to scope %s' % (issuer, scope))
if account is not None:
account = InternalAccount(account, vo=vo)
issuer = InternalAccount(issuer, vo=vo)
scope = InternalScope(scope, vo=vo)
for d in dids:
d['scope'] = InternalScope(d['scope'], vo=vo)
for r in rules:
r['account'] = InternalAccount(r['account'], vo=vo)
rse_id = None
if rse is not None:
rse_id = get_rse_id(rse=rse, vo=vo, session=session)
if did_type == 'DATASET':
# naming_convention validation
extra_meta = naming_convention.validate_name(scope=scope, name=name, did_type='D', session=session)
# merge extra_meta with meta
for k in extra_meta or {}:
if k not in meta:
meta[k] = extra_meta[k]
elif meta[k] != extra_meta[k]:
print("Provided metadata %s doesn't match the naming convention: %s != %s" % (k, meta[k], extra_meta[k]))
raise rucio.common.exception.InvalidObject("Provided metadata %s doesn't match the naming convention: %s != %s" % (k, meta[k], extra_meta[k]))
# Validate metadata
meta_core.validate_meta(meta=meta, did_type=DIDType[did_type.upper()], session=session)
return did.add_did(scope=scope, name=name, did_type=DIDType[did_type.upper()], account=account or issuer,
statuses=statuses, meta=meta, rules=rules, lifetime=lifetime,
dids=dids, rse_id=rse_id, session=session)
@transactional_session
def add_dids(dids, issuer, vo='def', *, session: "Session"):
"""
Bulk Add did.
:param dids: A list of dids.
:param issuer: The issuer account.
:param vo: The VO to act on.
:param session: The database session in use.
"""
for d in dids:
if 'rse' in d:
rse_id = None
if d['rse'] is not None:
rse_id = get_rse_id(rse=d['rse'], vo=vo, session=session)
d['rse_id'] = rse_id
kwargs = {'issuer': issuer, 'dids': dids}
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='add_dids', kwargs=kwargs, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not bulk add data identifier' % (issuer))
issuer = InternalAccount(issuer, vo=vo)
for d in dids:
d['scope'] = InternalScope(d['scope'], vo=vo)
if 'account' in d.keys():
d['account'] = InternalAccount(d['account'], vo=vo)
if 'dids' in d.keys():
for child in d['dids']:
child['scope'] = InternalScope(child['scope'], vo=vo)
return did.add_dids(dids, account=issuer, session=session)
@transactional_session
def attach_dids(scope, name, attachment, issuer, vo='def', *, session: "Session"):
"""
Append content to data did.
:param attachment: The attachment.
:param issuer: The issuer account.
:param vo: The VO to act on.
:param session: The database session in use.
"""
validate_schema(name='attachment', obj=attachment, vo=vo)
rse_id = None
if 'rse' in attachment:
if attachment['rse'] is not None:
rse_id = get_rse_id(rse=attachment['rse'], vo=vo, session=session)
attachment['rse_id'] = rse_id
kwargs = {'scope': scope, 'name': name, 'attachment': attachment}
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='attach_dids', kwargs=kwargs, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not add data identifiers to %s:%s' % (issuer, scope, name))
scope = InternalScope(scope, vo=vo)
issuer = InternalAccount(issuer, vo=vo)
if 'account' in attachment.keys():
attachment['account'] = InternalAccount(attachment['account'], vo=vo)
for d in attachment['dids']:
d['scope'] = InternalScope(d['scope'], vo=vo)
if 'account' in d.keys():
d['account'] = InternalAccount(d['account'], vo=vo)
if rse_id is not None:
dids = did.attach_dids(scope=scope, name=name, dids=attachment['dids'],
account=attachment.get('account', issuer), rse_id=rse_id, session=session)
else:
dids = did.attach_dids(scope=scope, name=name, dids=attachment['dids'],
account=attachment.get('account', issuer), session=session)
return dids
@transactional_session
def attach_dids_to_dids(attachments, issuer, ignore_duplicate=False, vo='def', *, session: "Session"):
"""
Append content to dids.
:param attachments: The contents.
:param issuer: The issuer account.
:param ignore_duplicate: If True, ignore duplicate entries.
:param vo: The VO to act on.
:param session: The database session in use.
"""
validate_schema(name='attachments', obj=attachments, vo=vo)
for a in attachments:
if 'rse' in a:
rse_id = None
if a['rse'] is not None:
rse_id = get_rse_id(rse=a['rse'], vo=vo, session=session)
a['rse_id'] = rse_id
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='attach_dids_to_dids', kwargs={'attachments': attachments}, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not add data identifiers' % (issuer))
issuer = InternalAccount(issuer, vo=vo)
for attachment in attachments:
attachment['scope'] = InternalScope(attachment['scope'], vo=vo)
for d in attachment['dids']:
d['scope'] = InternalScope(d['scope'], vo=vo)
if 'account' in d.keys():
d['account'] = InternalAccount(d['account'], vo=vo)
return did.attach_dids_to_dids(attachments=attachments, account=issuer,
ignore_duplicate=ignore_duplicate, session=session)
@transactional_session
def detach_dids(scope, name, dids, issuer, vo='def', *, session: "Session"):
"""
Detach data identifier
:param scope: The scope name.
:param name: The data identifier name.
:param dids: The content.
:param issuer: The issuer account.
:param vo: The VO to act on.
:param session: The database session in use.
"""
kwargs = {'scope': scope, 'name': name, 'dids': dids, 'issuer': issuer}
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='detach_dids', kwargs=kwargs, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not detach data identifiers from %s:%s' % (issuer, scope, name))
scope = InternalScope(scope, vo=vo)
for d in dids:
d['scope'] = InternalScope(d['scope'], vo=vo)
return did.detach_dids(scope=scope, name=name, dids=dids, session=session)
@stream_session
def list_new_dids(did_type=None, thread=None, total_threads=None, chunk_size=1000, vo='def', *, session: "Session"):
"""
List recent identifiers.
:param did_type : The DID type.
:param thread: The assigned thread for this necromancer.
:param total_threads: The total number of threads of all necromancers.
:param chunk_size: Number of requests to return per yield.
:param vo: The VO to act on.
:param session: The database session in use.
"""
dids = did.list_new_dids(did_type=did_type and DIDType[did_type.upper()], thread=thread, total_threads=total_threads, chunk_size=chunk_size, session=session)
for d in dids:
if d['scope'].vo == vo:
yield api_update_return_dict(d, session=session)
@transactional_session
def set_new_dids(dids, new_flag=True, vo='def', *, session: "Session"):
"""
Set/reset the flag new
:param scope: The scope name.
:param name: The data identifier name.
:param new_flag: A boolean to flag new DIDs.
:param vo: The VO to act on.
:param session: The database session in use.
"""
for d in dids:
d['scope'] = InternalScope(d['scope'], vo=vo)
return did.set_new_dids(dids, new_flag, session=session)
@stream_session
def list_content(scope, name, vo='def', *, session: "Session"):
"""
List data identifier contents.
:param scope: The scope name.
:param name: The data identifier name.
:param vo: The VO to act on.
:param session: The database session in use.
"""
scope = InternalScope(scope, vo=vo)
dids = did.list_content(scope=scope, name=name, session=session)
for d in dids:
yield api_update_return_dict(d, session=session)
@stream_session
def list_content_history(scope, name, vo='def', *, session: "Session"):
"""
List data identifier contents history.
:param scope: The scope name.
:param name: The data identifier name.
:param vo: The VO to act on.
:param session: The database session in use.
"""
scope = InternalScope(scope, vo=vo)
dids = did.list_content_history(scope=scope, name=name, session=session)
for d in dids:
yield api_update_return_dict(d, session=session)
@stream_session
def list_files(scope, name, long, vo='def', *, session: "Session"):
"""
List data identifier file contents.
:param scope: The scope name.
:param name: The data identifier name.
:param long: A boolean to choose if GUID is returned or not.
:param vo: The VO to act on.
:param session: The database session in use.
"""
scope = InternalScope(scope, vo=vo)
dids = did.list_files(scope=scope, name=name, long=long, session=session)
for d in dids:
yield api_update_return_dict(d, session=session)
@stream_session
def scope_list(scope, name=None, recursive=False, vo='def', *, session: "Session"):
"""
List data identifiers in a scope.
:param scope: The scope name.
:param name: The data identifier name.
:param recursive: boolean, True or False.
:param vo: The VO to act on.
:param session: The database session in use.
"""
scope = InternalScope(scope, vo=vo)
dids = did.scope_list(scope, name=name, recursive=recursive, session=session)
for d in dids:
ret_did = deepcopy(d)
ret_did['scope'] = ret_did['scope'].external
if ret_did['parent'] is not None:
ret_did['parent']['scope'] = ret_did['parent']['scope'].external
yield ret_did
@read_session
def get_did(scope: str, name: str, dynamic_depth: "Optional[DIDType]" = None, vo: str = 'def', *, session: "Session") -> "dict[str, Any]":
"""
Retrieve a single data did.
:param scope: The scope name.
:param name: The data identifier name.
:param dynamic_depth: the DID type to use as source for estimation of this DIDs length/bytes.
If set to None, or to a value which doesn't make sense (ex: requesting depth = CONTAINER for a did of type DATASET)
will not compute the size dynamically.
:param vo: The VO to act on.
:return did: Dictionary containing {'name', 'scope', 'type'}, Exception otherwise
:param session: The database session in use.
"""
scope = InternalScope(scope, vo=vo)
d = did.get_did(scope=scope, name=name, dynamic_depth=dynamic_depth, session=session)
return api_update_return_dict(d, session=session)
@transactional_session
def set_metadata(scope, name, key, value, issuer, recursive=False, vo='def', *, session: "Session"):
"""
Add metadata to data did.
:param scope: The scope name.
:param name: The data identifier name.
:param key: the key.
:param value: the value.
:param issuer: The issuer account.
:param recursive: Option to propagate the metadata update to content.
:param vo: The VO to act on.
:param session: The database session in use.
"""
kwargs = {'scope': scope, 'name': name, 'key': key, 'value': value, 'issuer': issuer}
if key in RESERVED_KEYS:
raise rucio.common.exception.AccessDenied('Account %s can not change this metadata value to data identifier %s:%s' % (issuer, scope, name))
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='set_metadata', kwargs=kwargs, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not add metadata to data identifier %s:%s' % (issuer, scope, name))
scope = InternalScope(scope, vo=vo)
return did.set_metadata(scope=scope, name=name, key=key, value=value, recursive=recursive, session=session)
@transactional_session
def set_metadata_bulk(scope, name, meta, issuer, recursive=False, vo='def', *, session: "Session"):
"""
Add metadata to data did.
:param scope: The scope name.
:param name: The data identifier name.
:param meta: the key-values.
:param issuer: The issuer account.
:param recursive: Option to propagate the metadata update to content.
:param vo: The VO to act on.
:param session: The database session in use.
"""
kwargs = {'scope': scope, 'name': name, 'meta': meta, 'issuer': issuer}
for key in meta:
if key in RESERVED_KEYS:
raise rucio.common.exception.AccessDenied('Account %s can not change the value of the metadata key %s to data identifier %s:%s' % (issuer, key, scope, name))
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='set_metadata_bulk', kwargs=kwargs, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not add metadata to data identifier %s:%s' % (issuer, scope, name))
scope = InternalScope(scope, vo=vo)
return did.set_metadata_bulk(scope=scope, name=name, meta=meta, recursive=recursive, session=session)
@transactional_session
def set_dids_metadata_bulk(dids, issuer, recursive=False, vo='def', *, session: "Session"):
"""
Add metadata to a list of data identifiers.
:param issuer: The issuer account.
:param dids: A list of dids including metadata.
:param recursive: Option to propagate the metadata update to content.
:param vo: The VO to act on.
:param session: The database session in use.
"""
for entry in dids:
kwargs = {'scope': entry['scope'], 'name': entry['name'], 'meta': entry['meta'], 'issuer': issuer}
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='set_metadata_bulk', kwargs=kwargs, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not add metadata to data identifier %s:%s' % (issuer, entry['scope'], entry['name']))
entry['scope'] = InternalScope(entry['scope'], vo=vo)
meta = entry['meta']
for key in meta:
if key in RESERVED_KEYS:
raise rucio.common.exception.AccessDenied('Account %s can not change the value of the metadata key %s to data identifier %s:%s' % (issuer, key, entry['scope'], entry['name']))
return did.set_dids_metadata_bulk(dids=dids, recursive=recursive, session=session)
@read_session
def get_metadata(scope, name, plugin='DID_COLUMN', vo='def', *, session: "Session"):
"""
Get data identifier metadata
:param scope: The scope name.
:param name: The data identifier name.
:param vo: The VO to act on.
:param session: The database session in use.
"""
scope = InternalScope(scope, vo=vo)
d = did.get_metadata(scope=scope, name=name, plugin=plugin, session=session)
return api_update_return_dict(d, session=session)
@stream_session
def get_metadata_bulk(dids, inherit=False, vo='def', *, session: "Session"):
"""
Get metadata for a list of dids
:param dids: A list of dids.
:param inherit: A boolean. If set to true, the metadata of the parent are concatenated.
:param vo: The VO to act on.
:param session: The database session in use.
"""
validate_schema(name='dids', obj=dids, vo=vo)
for entry in dids:
entry['scope'] = InternalScope(entry['scope'], vo=vo)
meta = did.get_metadata_bulk(dids, inherit=inherit, session=session)
for met in meta:
yield api_update_return_dict(met, session=session)
@transactional_session
def delete_metadata(scope, name, key, vo='def', *, session: "Session"):
"""
Delete a key from the metadata column
:param scope: the scope of did
:param name: the name of the did
:param key: the key to be deleted
:param vo: The VO to act on.
:param session: The database session in use.
"""
scope = InternalScope(scope, vo=vo)
return did.delete_metadata(scope=scope, name=name, key=key, session=session)
@transactional_session
def set_status(scope, name, issuer, vo='def', *, session: "Session", **kwargs):
"""
Set data identifier status
:param scope: The scope name.
:param name: The data identifier name.
:param issuer: The issuer account.
:param kwargs: Keyword arguments of the form status_name=value.
:param vo: The VO to act on.
:param session: The database session in use.
"""
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='set_status', kwargs={'scope': scope, 'name': name, 'issuer': issuer}, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not set status on data identifier %s:%s' % (issuer, scope, name))
scope = InternalScope(scope, vo=vo)
return did.set_status(scope=scope, name=name, session=session, **kwargs)
@stream_session
def get_dataset_by_guid(guid, vo='def', *, session: "Session"):
"""
Get the parent datasets for a given GUID.
:param guid: The GUID.
:param vo: The VO to act on.
:param session: The database session in use.
:returns: A did
"""
dids = did.get_dataset_by_guid(guid=guid, session=session)
for d in dids:
if d['scope'].vo != vo:
raise RucioException('GUID unavailable on VO {}'.format(vo))
yield api_update_return_dict(d, session=session)
@stream_session
def list_parent_dids(scope, name, vo='def', *, session: "Session"):
"""
List parent datasets and containers of a did.
:param scope: The scope.
:param name: The name.
:param vo: The VO to act on.
:param session: The database session in use.
"""
scope = InternalScope(scope, vo=vo)
dids = did.list_parent_dids(scope=scope, name=name, session=session)
for d in dids:
yield api_update_return_dict(d, session=session)
@transactional_session
def create_did_sample(input_scope, input_name, output_scope, output_name, issuer, nbfiles, vo='def', *, session: "Session"):
"""
Create a sample from an input collection.
:param input_scope: The scope of the input DID.
:param input_name: The name of the input DID.
:param output_scope: The scope of the output dataset.
:param output_name: The name of the output dataset.
:param account: The account.
:param nbfiles: The number of files to register in the output dataset.
:param issuer: The issuer account.
:param vo: The VO to act on.
:param session: The database session in use.
"""
kwargs = {'issuer': issuer, 'scope': output_scope}
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='create_did_sample', kwargs=kwargs, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not bulk add data identifier' % (issuer))
input_scope = InternalScope(input_scope, vo=vo)
output_scope = InternalScope(output_scope, vo=vo)
issuer = InternalAccount(issuer, vo=vo)
return did.create_did_sample(input_scope=input_scope, input_name=input_name, output_scope=output_scope, output_name=output_name,
account=issuer, nbfiles=nbfiles, session=session)
@transactional_session
def resurrect(dids, issuer, vo='def', *, session: "Session"):
"""
Resurrect DIDs.
:param dids: A list of dids.
:param issuer: The issuer account.
:param vo: The VO to act on.
:param session: The database session in use.
"""
kwargs = {'issuer': issuer}
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='resurrect', kwargs=kwargs, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not resurrect data identifiers' % (issuer))
validate_schema(name='dids', obj=dids, vo=vo)
for d in dids:
d['scope'] = InternalScope(d['scope'], vo=vo)
return did.resurrect(dids=dids, session=session)
@stream_session
def list_archive_content(scope, name, vo='def', *, session: "Session"):
"""
List archive contents.
:param scope: The archive scope name.
:param name: The archive data identifier name.
:param vo: The VO to act on.
:param session: The database session in use.
"""
scope = InternalScope(scope, vo=vo)
dids = did.list_archive_content(scope=scope, name=name, session=session)
for d in dids:
yield api_update_return_dict(d, session=session)
@transactional_session
def add_did_to_followed(scope, name, account, *, session: "Session", vo='def'):
"""
Mark a did as followed by the given account
:param scope: The scope name.
:param name: The data identifier name.
:param account: The account owner.
:param session: The database session in use.
"""
scope = InternalScope(scope, vo=vo)
account = InternalAccount(account, vo=vo)
return did.add_did_to_followed(scope=scope, name=name, account=account, session=session)
@transactional_session
def add_dids_to_followed(dids, account, *, session: "Session", vo='def'):
"""
Bulk mark datasets as followed
:param dids: A list of dids.
:param account: The account owner.
:param session: The database session in use.
"""
account = InternalAccount(account, vo=vo)
return did.add_dids_to_followed(dids=dids, account=account, session=session)
@stream_session
def get_users_following_did(name, scope, *, session: "Session", vo='def'):
"""
Return list of users following a did
:param scope: The scope name.
:param name: The data identifier name.
:param session: The database session in use.
"""
scope = InternalScope(scope, vo=vo)
users = did.get_users_following_did(name=name, scope=scope, session=session)
for user in users:
user['user'] = user['user'].external
yield user
@transactional_session
def remove_did_from_followed(scope, name, account, issuer, *, session: "Session", vo='def'):
"""
Mark a did as not followed
:param scope: The scope name.
:param name: The data identifier name.
:param account: The account owner.
:param session: The database session in use.
:param issuer: The issuer account
"""
kwargs = {'scope': scope, 'issuer': issuer}
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='remove_did_from_followed', kwargs=kwargs, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not remove data identifiers from followed table' % (issuer))
scope = InternalScope(scope, vo=vo)
account = InternalAccount(account, vo=vo)
return did.remove_did_from_followed(scope=scope, name=name, account=account, session=session)
@transactional_session
def remove_dids_from_followed(dids, account, issuer, *, session: "Session", vo='def'):
"""
Bulk mark datasets as not followed
:param dids: A list of dids.
:param account: The account owner.
:param session: The database session in use.
"""
kwargs = {'dids': dids, 'issuer': issuer}
if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='remove_dids_from_followed', kwargs=kwargs, session=session):
raise rucio.common.exception.AccessDenied('Account %s can not bulk remove data identifiers from followed table' % (issuer))
account = InternalAccount(account, vo=vo)
return did.remove_dids_from_followed(dids=dids, account=account, session=session)