Skip to content

RDBC-811, RDBC-809, RDBC-807, RDBC-750 - Breaking changes - new version 5.2.6 #210

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 11 commits into from
Mar 7, 2024

Conversation

poissoncorp
Copy link
Contributor

@poissoncorp poissoncorp commented Mar 4, 2024

Bundled all currently planned breaking changes - needed for documentation

https://issues.hibernatingrhinos.com/issue/RDBC-811/Make-loadstartingwithintostream-work-properly
https://issues.hibernatingrhinos.com/issue/RDBC-750/Inconsistent-API-design-issues-within-lazy-loads-and-includes
https://issues.hibernatingrhinos.com/issue/RDBC-809/Method-getcompareexchangevalues-cant-require-objecttype-set-as-optional

+ https://issues.hibernatingrhinos.com/issue/RDBC-807/Handle-None-in-RequestExecutor.httpsession

  1. RDBC-809 Get compare exchange values - Set object_type as optional, no need to provide it
 def get_compare_exchange_values(
        self, keys: List[str], object_type: Type[_T]
    ) -> Dict[str, CompareExchangeValue[_T]]:
        pass

changed to

 def get_compare_exchange_values(
        self, keys: List[str], object_type: Optional[Type[_T]] = None
    ) -> Dict[str, CompareExchangeValue[_T]]:
        pass
  1. RDBC-811 Load starting with into stream - Fixed, changed signature - it doesn't take any stream/output bytes arg, it returns bytes instead
def load_starting_with_into_stream(
        self,
        id_prefix: str,
        matches: str = None,
        start: int = 0,
        page_size: int = 25,
        exclude: str = None,
        start_after: str = None,
    ) -> bytes:
  1. RDBC-750 lazily.load() and include().load()
# -----------
lazily.load()
# -----------
def load(self, object_type: Type[_T], *ids: str) -> Lazy[Dict[str, _T]]:
# -->
def load(self, id_or_ids: Union[List[str], str], object_type: Optional[Type[_T]] = None) -> Lazy[Dict[str, _T]]:

# -----------
include(...).load()
# -----------
 def load(self, object_type: Type[_T], ids: Union[List[str], str], on_eval: Callable = None) -> Optional[Lazy[Union[Dict[str, object], object]]]:
# --->
 def load(self, ids: Union[List[str], str], object_type: Type[_T], on_eval: Callable = None) -> Optional[Lazy[Union[Dict[str, object], object]]]:

@poissoncorp poissoncorp changed the title RDBC-811, RDBC-809, RDBC-750 - Breaking changes - new version 5.2.6 RDBC-811, RDBC-809, RDBC-808, RDBC-750 - Breaking changes - new version 5.2.6 Mar 4, 2024
@poissoncorp poissoncorp changed the title RDBC-811, RDBC-809, RDBC-808, RDBC-750 - Breaking changes - new version 5.2.6 RDBC-811, RDBC-809, RDBC-807, RDBC-750 - Breaking changes - new version 5.2.6 Mar 4, 2024
@poissoncorp poissoncorp merged commit 40b1baf into ravendb:v5.2 Mar 7, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants