[
https://issues.apache.org/jira/browse/CASSANDRA-10719?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15013508#comment-15013508
]
Michael Edge commented on CASSANDRA-10719:
------------------------------------------
Patch added for all 3 versions.
I tested all 3 versions, executing the following test cases. Results were as
expected; of course in some cases the test case did not apply to the Cassandra
version. For instance, functions and aggregates did not exist in v2.1.
h4. Test case
bq. Start cqlsh; do not select a keyspace
_should return identical results, and match exact ‘help’ entry in cqlsh_
* Help describe
* Help desc
_should list all objects within all keyspaces_
* Desc tables
* Desc functions
* Desc aggregates
* Desc types
_should describe specific object within the named keyspace_
* Desc table <keyspace>.<table name>
* Desc function <keyspace>.<function name>
* Desc aggregate <keyspace>.<aggregate name>
* Desc type <keyspace>.<type name>
_should describe specific table within the named keyspace_
* Desc <keyspace>.<table name>
_should fail - 'desc <object>' is only supported for tables, indexes, views_
* Desc <keyspace>.<function name>
* Desc <keyspace>.<aggregate name>
* Desc <keyspace>.<type name>
bq. Use <keyspace>
_should only list objects within that keyspace_
* Desc tables
* Desc functions
* Desc aggregates
* Desc types
_should describe specific object within the currently selected keyspace_
* Desc table <table name>
* Desc function <function name>
* Desc aggregate <aggregate name>
* Desc type <type name>
_should describe specific table within the currently selected keyspace_
* Desc <table name>
_should fail - 'desc <object> is only supported for tables, indexes, views_
* Desc <function name>
* Desc <aggregate name>
* Desc <type name>
> Inconsistencies within CQL 'describe', and CQL docs/'help describe'
> -------------------------------------------------------------------
>
> Key: CASSANDRA-10719
> URL: https://issues.apache.org/jira/browse/CASSANDRA-10719
> Project: Cassandra
> Issue Type: Improvement
> Components: CQL, Documentation and Website
> Reporter: Michael Edge
> Assignee: Michael Edge
> Priority: Minor
> Labels: cqlsh, doc-impacting, docs
> Fix For: 3.x
>
> Attachments: CASSANDRA-2.1-10719-Describe.patch,
> CASSANDRA-2.2-10719-Describe.patch, CASSANDRA-3.0-10719-Describe.patch
>
>
> While investigating the issue CASSANDRA-9678 I noticed a number of
> inconsistencies in the way 'describe' operates, so I'm opening a new issue to
> address these. This issue will also address CASSANDRA-9678.
> I'd be happy to work on this.
> There are a number of inconsistencies in the way 'describe' operates within
> cqlsh, and also in the 'help describe' description within cqlsh compared to
> the CQL documentation (at
> http://docs.datastax.com/en/cql/3.3/cql/cql_reference/describe_r1.html)
> For example, 'desc functions' will list all functions for all keyspaces
> regardless of whether there is a current keyspace or not, whereas 'desc
> tables' or 'desc types' will list only the tables or types for the current
> keyspace.
> Some commands exist in cqlsh that are not in the CQL documentation, nor in
> the 'help describe' description. For example, 'desc functions' is a valid
> CQLSH command but does not appear in either the CQL docs or 'help describe'.
> I suggest we align the way the 'describe' command works so that it works
> consistently regardless of whether it is describing a table, type, function
> or any other database object, and also update the CQL and 'help describe'
> docs to match. Since 'describe tables' and it's variants has been around the
> longest we should probably align other 'describe' commands to 'describe
> tables'.
> My preliminary analysis has shown at least the following inconsistencies:
> - 'desc functions' (with current keyspace), differs from 'desc tables' and
> 'desc types'.
> - a number of commands are missing from the CQL docs or 'help describe, such
> as: desc table <keyspace>.<tablename>, desc functions (no current keyspace),
> desc function <function name>, desc type <keyspace>.<type name>, etc.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
