[jira] [Commented] (PHOENIX-2991) Add missing documentation for functions

["James Taylor (JIRA)" <ji...@apache.org>]

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

James Taylor commented on PHOENIX-2991:
---------------------------------------

Thanks for checking on this, [~elserj].  I agree that TO_TIME and TO_TIMESTAMP should get documented. Equally (or more) importantly would be to document that we support ANSI SQL date/time literals (see http://dev.mysql.com/doc/refman/5.7/en/date-and-time-literals.html).

I don't think we should document DISTINCT_COUNT as it's really just the internal function to which COUNT(DISTINCT ) gets compiled. I'm not sure about COLLECTDISTINCT. Should that be documented, [~maryannxue]?

The IndexStateName, SQLIndexType, SQLTableType, SqlTypeName, and SQLViewType are internal as well - they're used by our metadata APIs to convert from our internal representation to the metadata API values. The "supported" APIs are the metadata APIs - these shouldn't be used on their own.





> Add missing documentation for functions
> ---------------------------------------
>
>                 Key: PHOENIX-2991
>                 URL: https://issues.apache.org/jira/browse/PHOENIX-2991
>             Project: Phoenix
>          Issue Type: Task
>            Reporter: Josh Elser
>            Assignee: Josh Elser
>             Fix For: 4.9.0, 4.8.1
>
>
> In PHOENIX-2990, I noticed that we were missing some functions on the reference page on the website:
> * DistinctCountAggregateFunction.java (the shorthand version {{DISTINCT_COUNT}} is missing, but {{COUNT(distinct )}} is present)
> * DistinctValueAggregateFunction.java
> * ExternalSqlTypeIdFunction.java
> * GetBitFunction.java
> * GetByteFunction.java
> * IndexStateNameFunction.java
> * OctetLengthFunction.java
> * SetBitFunction.java
> * SetByteFunction.java
> * SQLIndexTypeFunction.java
> * SQLTableTypeFunction.java
> * SqlTypeNameFunction.java
> * SQLViewTypeFunction.java
> * ToTimeFunction.java
> * ToTimestampFunction.java
> TO_TIME and TO_TIMESTAMP are probably the most heinous since we actually refer to them elsewere in the same document. It would be nice to make sure these are all documented.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)