Skip to content

Commit 100c486

Browse files
committed
same as README text
1 parent ac520e1 commit 100c486

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,19 @@ ensure the lifetime of the updatable instance extends beyond the time needed for
453453

454454
See `irods/test/data_obj_test.py` for examples of these and other subtleties of progress bar usage.
455455

456+
Replica access and sorting
457+
--------------------------
458+
459+
The `replicas` member of an instance of `iRODSDataObject` allows a view into the various replicas that exist under a
460+
given logical path. For an example of this, jump forward to [working with data objects](#working-with-data-objects-files)
461+
#dwm
462+
463+
Note that a `replica_sort_function` option exists in the `iRODSDataObject` constructor and in
464+
`<session_object>.data_objects.get`. If `replica_sort_function` is not specified, the replicas
465+
list contained in the returned object will be sorted according to replica number
466+
(REPLICA_NUMBER_SORT_KEY_FN) in PRC < v4 or by general fitness to be considered as a
467+
current data copy (REPLICA_FITNESS_SORT_KEY_FN). in PRC >= v4. For those definitions, see `irods/data_object.py`.
468+
456469
Working with collections (directories)
457470
--------------------------------------
458471

0 commit comments

Comments
 (0)