Misleading/invalid documentation on SessionContext::sql and SessionConfig::create_logical_plan #7272

Activity

1. UlfarErl commented on Aug 12, 2023

   

   UlfarErl

   on Aug 12, 2023

   Author

   More actions

   @alamb I spotted this when looking for a read-only LogicalPlan interface, just like the one you were aiming for in issue #4720 (and your PR #4721). Those were closed without any apparent plan for such an interface. It would be great to document (even if planned for the future).
2. alamb commented on Aug 13, 2023

   

   alamb

   on Aug 13, 2023

   Contributor

   More actions

   Thanks @UlfarErl -- I agree the comments and API could be improved -- I'll try and improve them this week

   The key for "read only" is to not call SessionContext::execute_logical_plan -- so do

   SessionContext::create_logical_plan

   And then

   session_context.state().create_physical_plan
   

   I agree this is not clear from the docs.
3. alamb

   self-assigned this

   on Aug 13, 2023
4. alamb commented on Aug 18, 2023

   

   alamb

   on Aug 18, 2023

   Last edited by alamb

   Contributor

   More actions

   Hi @UlfarErl -- I made a PR to update the documentation here #7327

   While working on it, it became clear the API is somewhat confusing (as you have already pointed out) #7328 -- PR to fix: #7333
5. alamb

   closed this as completedin #7333on Aug 22, 2023