oarepo_oaipmh_harvester.writers.oai_service
oarepo_oaipmh_harvester.writers.oai_service
oai-service writer - synchronizes local records with harvested ones.
Datastream configuration: oai-service{model:"<model>", ...}, see
OAIServiceWriter for the
options.
The writer expects entries {"record": <data for the service or None>, "oai_record":
<OAI record>}. How to produce them, what is stored on the harvest record and how
failures are reported is described in
Readers, transformers and writers.
For each harvested entry the writer
- loads the harvest record
(OAIHarvestedRecord) of
the OAI identifier; the local pid is taken from it, or - for a record harvested for the
first time - from the transformed data via the pid provider's
get_pid_value_from_record(records deposited locally with the same pid are taken over); - classifies the local record - LocalRecord.resolve returns a LocalState (absent, live, draft only, tombstoned, hard deleted) together with the record and a local draft, if any;
- picks the Operation that brings
the local record to the harvested state -
LocalRecord.operation.
The harvest always wins: locally deleted records are restored (rdm tombstones,
restore_record) or revived (hard deleted records are reverted to their last revision, keeping the pid), locally restored records are deleted again, local edit drafts are overwritten or removed; - skips the entry if the OAI datestamp and deleted flag are unchanged, the last write had no errors and the local record is already in the harvested state;
- executes the operation inside a unit of work (multi-step operations such as restore + update roll back together) and publishes drafts where needed;
- stores the harvest record with the datestamp, transformed data, local pid and errors.
Draft services do not allow updating published records, so updates go through edit -
update draft - publish unless direct_update is set. Records of rdm services are deleted
with delete_record (tombstone with a note about the deletion at the source), other
services with delete.
Records whose data have no files / media_files section are written with
{"enabled": False} there (for the sections the model supports) - harvested metadata
do not bring files.
Written records are added to the community writer option (slug or id) and to the
communities listed by the transformer in parent.communities.ids of the transformed data.
They are added directly (rdm bulk_add), without a community inclusion request; communities
the record is already in are skipped, and the record is never removed from a community.
LocalState
Bases: StrEnum
State of the local record that corresponds to a harvested OAI record.
Source code in oarepo_oaipmh_harvester/writers/oai_service.py
ABSENT = 'absent'
class-attribute
instance-attribute
No local record nor draft.
LIVE = 'live'
class-attribute
instance-attribute
Published, not deleted record (or a plain record for models without drafts).
DRAFT_ONLY = 'draft_only'
class-attribute
instance-attribute
No published record (or a hard deleted one), but a draft exists.
TOMBSTONED = 'tombstoned'
class-attribute
instance-attribute
RDM record soft-deleted via delete_record (deletion status D or X).
HARD_DELETED = 'hard_deleted'
class-attribute
instance-attribute
Record deleted via service.delete - model.is_deleted set, pid status D.
Operation
Bases: StrEnum
Operation that brings the local record to the state reported by the OAI-PMH source.
Source code in oarepo_oaipmh_harvester/writers/oai_service.py
UPDATE = 'update'
class-attribute
instance-attribute
Update a live record (for draft services: edit, update draft, publish - unless direct_update).
RESTORE = 'restore'
class-attribute
instance-attribute
Restore a tombstoned rdm record (unmarking it from purge if needed), then update it.
REVIVE = 'revive'
class-attribute
instance-attribute
Revert a hard deleted record to its last revision, re-register its pid, then update it.
DELETE = 'delete'
class-attribute
instance-attribute
Delete via service.delete - for services without rdm deletion workflow.
DELETE_RECORD = 'delete_record'
class-attribute
instance-attribute
Tombstone via rdm delete_record.
LocalRecord
dataclass
Local record state together with the resolved record and draft (if any).
Source code in oarepo_oaipmh_harvester/writers/oai_service.py
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 | |
is_rdm: bool = False
class-attribute
instance-attribute
Service supports rdm deletion workflow (tombstones via delete_record).
deleted_pid: PersistentIdentifier | None = None
class-attribute
instance-attribute
Pid of a hard deleted record (status D).
resolve(service: RecordService, pid_value: str | None, *, with_drafts: bool) -> LocalRecord
classmethod
Find the local record (and draft) for the pid value and classify its state.
Source code in oarepo_oaipmh_harvester/writers/oai_service.py
operation(oai_deleted: bool) -> Operation
Determine the operation that brings the local record to the harvested state.
The harvest always wins - whatever happened to the record locally, the state reported by the OAI-PMH source becomes the local state.
Source code in oarepo_oaipmh_harvester/writers/oai_service.py
OAIServiceWriter
Bases: BaseWriter
Writer for OAI-PMH harvested records.
This writer uses a service to write records harvested via OAI-PMH. It also stores an OAIRecord model instance to keep track of the harvesting status.
Source code in oarepo_oaipmh_harvester/writers/oai_service.py
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 | |
service: RecordService
property
Get the service for the specified model.
__init__(model: str, *args: Any, identity: Identity | None = None, update_all: bool = False, harvester_id: str | None = None, pid_field: str = 'id', publish: bool = True, direct_update: bool = False, community: str | None = None, **kwargs: Any)
Initialize the OAI service writer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model
|
str
|
Name of the target model ( |
required |
identity
|
Identity | None
|
Identity used for the service calls, defaults to the system identity. |
None
|
update_all
|
bool
|
Write every record, even if it is up to date. |
False
|
harvester_id
|
str | None
|
Harvester the harvest records belong to (set by the harvest task). |
None
|
pid_field
|
str
|
Path of the pid value in the service result. |
'id'
|
publish
|
bool
|
Publish created / updated drafts. Required ( |
True
|
direct_update
|
bool
|
Update published records via |
False
|
community
|
str | None
|
Slug (or id) of a community every written record is added to. Only for rdm models. |
None
|
Source code in oarepo_oaipmh_harvester/writers/oai_service.py
write(stream_entry: StreamEntry, *args: Any, **kwargs: Any) -> StreamEntry
Write the input entry using a given service.
Source code in oarepo_oaipmh_harvester/writers/oai_service.py
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 | |
write_many(stream_entries: list[StreamEntry], *args: Any, **kwargs: Any) -> list[StreamEntry]
Write the input entries using a given service.