related object pagination

It is not very clear how to server large numbers of related objects as is obvious they cannot be loaded explicitely in relation json-api/json-api#1120

One way I thouht was to just set emtpy data=[] and serve just link to the relation so user can access different relation view as usual collection view.

"relationships": {
  ...
  "comments": {
    "links": {
      "self": "http://example.com/articles/1/relationships/comments",
      "related": "http://example.com/articles/1/comments"
    },
    "data": [ ]
  }
}

The only way to do it is:

myobj = s.get('myobj', '1234').resource
for ch in myobj.children:
    for r in s.iterate("myobjs/%s/children" % (ch.id)):
        print(".  ", r.id, r.some_field)

is there an plan to support relation iterator?

[tuomas2]

Pull requests are welcome :) Up to this day we don't have had this kind of use case but it is possible that we also need something like that in the future.

BTW note also that jsonapi-client Sessions are made with short-lived data access in mind, not millions of items. If you would like to iterate over millions of items, you should take care of cache cleaning (with Session.invalidate) as well, otherwise memory usage will build up.

@tuomas2 sure, woudl it work if instead of https://github.com/qvantel/jsonapi-client/blob/master/src/jsonapi_client/relationships.py#L379:L380

just return self._document.iterator() ?

see #10