Skip to content
This repository was archived by the owner on May 9, 2023. It is now read-only.

v1.0.0

Compare
Choose a tag to compare
@cvauclair cvauclair released this 25 Jul 19:38
· 30 commits to main since this release

Description

This release overhauls how pagination is performed in Subgrounds.

New features

  • Subgrounds users can now define and use their own pagination strategy (see Custom pagination strategy for more details).
  • Users select the pagination strategies to use when calling toplevel querying functions:
    df = sg.query_df(field_paths, pagination_strategy=MyPaginationStrategy) 
  • Subgrounds provides two pagination strategies out of the box: LegacyStrategy (the strategy used prior to this update) and ShallowStrategy, which is much faster than LegacyStrategy in some cases, but does not support pagination on nested fields (see Available pagination strategies for more details).

BREAKING CHANGES

  • The auto_paginate argument of toplevel querying functions has been replaced by the pagination_strategy argument (setting the latter to None disables pagination).

Fixes

  • Fix bug that would cause a crash when calling one of the toplevel querying functions with only one FieldPath object (e.g.: sg.query_df(pairs.id).