feat: Add method to add analyzer rules to SessionContext

[pingsutw]

Which issue does this PR close?

Closes #10846

Rationale for this change

The new session context works fine with the rules I added, but there is no way to register the rules to the session context directly.

What changes are included in this PR?

adding SessionContext::add_analyzer_rule that simply calls SessionState::add_analyzer_rule

Are these changes tested?

unit tests

Are there any user-facing changes?

[alamb]

Thank you for this contribution @pingsutw 🙏

I was going to say that we should add tests for this API, but it seems as though there are no existing tests for add_analyzer_rule 😢

https://github.com/search?q=repo%3Aapache%2Fdatafusion+add_analyzer_rule&type=code

It is probably time to add an example or test, similar to the user_defined_plan here:

datafusion/datafusion/core/tests/user_defined/user_defined_plan.rs

Line 251 in 3773fb7

.add_optimizer_rule(Arc::new(TopKOptimizerRule {}));

However I don't think you have to do it in this PR unless you want to

I filed #10855 to track the idea

[alamb]

I think technically this is an API change as now the api takes a mut reference rather than self

However, I think the change is good as now add_analyzer_rule looks more like a standard mutation style api (that takes &mut self) rather than a builder style (self)

What do you think about adding an api to make things consistent? (we could do this as a separate PR)

    pub fn with_analyzer_rule(
      mut self, 
        analyzer_rule: Arc<dyn AnalyzerRule + Send + Sync>,
  ) -> Self {
..
}

[pingsutw]

Should we also update add_optimizer_rule add_physical_optimizer_rule? (mut self -> &mut self)

Also, do we need to add with_optimizer_rule and with_physical_optimizer_rule to make it consistent?
If so, I can do it in a separate PR.

[comphead]

Would be nice to have an examples, or doc test for the this method

[alamb]

I agree -- we are tracking adding an example for how to use custom analyzer rules in #10855, so perhaps we can add the example as part of that ticket (i think @goldmedal said he may have some time to work on that eventually)

[alamb]

FWIW I have a WIP PR to improve these examples -- I hope to get it up for review sometime this weekend

[alamb]

@pingsutw please let me know if you have time to add an example for this API, otherwise I think perhaps we can merge it in and add coverage as part of #10855 (or we could hold off on this code until the PR that adds the example)

[pingsutw]

I'll update my pr and add an example tonight

[alamb]

Thank you very much @pingsutw -- this is looking good

[alamb]

Would it be possible to add test that exercises these APIs?

For example, perhaps a test that does something like

select 42, arrow_typeof(42)

Which I think this code will print out 42 and UInt?

[alamb]

Looks good to me -- thank you @pingsutw

I merged this PR up from main to resolve a conflict

[pingsutw]

I merged this PR up from main to resolve a conflict

Thank you for the help!