[jira] [Commented] (CALCITE-517) Document remote JDBC driver and client-server architecture

["Kevin Risden (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/CALCITE-517?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16385418#comment-16385418 ] 

Kevin Risden commented on CALCITE-517:
--------------------------------------

[~julianhyde] - Think this is complete? The diagram above is listed here: https://calcite.apache.org/avatica/docs/

> Document remote JDBC driver and client-server architecture
> ----------------------------------------------------------
>
>                 Key: CALCITE-517
>                 URL: https://issues.apache.org/jira/browse/CALCITE-517
>             Project: Calcite
>          Issue Type: Bug
>          Components: avatica
>            Reporter: Julian Hyde
>            Assignee: Julian Hyde
>            Priority: Major
>
> Vladimir wrote:
> {quote}0) The patch does change major functionality, however it does not
> change the documentation.
> Good old proverb is "if it's not documented it does not exist".
> I think we need to agree if we apply that rule or not (e.g. some SPIs
> might be better "documented" in tests rather than in text form),
> however here we deal with user-facing feature, so I my vote is
> documentation is a must.
> 1) We need some sort of picture (png/svg/ascii chart/whatever) that
> shows how the pieces are communicating.
> Otherwise users would have no idea
> 1.1) which ports are required open at client and server sides
> 1.2) what are the security rules (authentication/authorization for the RPC)
> 1.3) how keep-alive is implemented (is it?), what is the connection
> test query. Well, test query is certainly not a part of RPC, however
> it is a must for end-users to be able to create a data source for
> Calcite.{quote}
> There is a picture here: https://raw.githubusercontent.com/julianhyde/share/master/slides/avatica-architecture.png



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)