Documenting Calcite's extension APIs

[Julian Hyde <jh...@apache.org>]

While reviewing Timo’s change to support user-defined grouped window functions [1] I realized that we don’t have list of all of the interfaces that allow you to extend Calcite. So I took a shot at doing this[2][3].

Can someone please review what I have written? Have I missed any important ones? Feel free to correct, or write more!

Julian

[1] https://issues.apache.org/jira/browse/CALCITE-1867 <https://issues.apache.org/jira/browse/CALCITE-1867>

[2] https://issues.apache.org/jira/browse/CALCITE-2021 <https://issues.apache.org/jira/browse/CALCITE-2021>

[3] https://github.com/julianhyde/calcite/tree/1867-grouped-window <https://github.com/julianhyde/calcite/tree/1867-grouped-window> 

Re: Documenting Calcite's extension APIs

[Michael Mior <mm...@uwaterloo.ca>]

Unfortunately I'm not really familiar with what interfaces are available,
so I can't speak to coverage. But I reviewed your current draft and added
some comments inline on the commit. Also, in the cases where we have tests
for the extension interface, it would be helpful to point the test code
when documenting so we have an example which is guaranteed to work.

--
Michael Mior
mmior@apache.org

2017-10-24 0:44 GMT-04:00 Julian Hyde <jh...@apache.org>:

> While reviewing Timo’s change to support user-defined grouped window
> functions [1] I realized that we don’t have list of all of the interfaces
> that allow you to extend Calcite. So I took a shot at doing this[2][3].
>
> Can someone please review what I have written? Have I missed any important
> ones? Feel free to correct, or write more!
>
> Julian
>
> [1] https://issues.apache.org/jira/browse/CALCITE-1867 <
> https://issues.apache.org/jira/browse/CALCITE-1867>
>
> [2] https://issues.apache.org/jira/browse/CALCITE-2021 <
> https://issues.apache.org/jira/browse/CALCITE-2021>
>
> [3] https://github.com/julianhyde/calcite/tree/1867-grouped-window <
> https://github.com/julianhyde/calcite/tree/1867-grouped-window>