You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by bl...@apache.org on 2015/11/24 14:56:23 UTC

cassandra git commit: Fix inconsistencies within CQLSH help

Repository: cassandra
Updated Branches:
  refs/heads/cassandra-2.1 8b9a9161c -> f319f0a23


Fix inconsistencies within CQLSH help

patch by Michael Edge; reviewed by Benjamin Lerer for CASSANDRA-10719


Project: http://git-wip-us.apache.org/repos/asf/cassandra/repo
Commit: http://git-wip-us.apache.org/repos/asf/cassandra/commit/f319f0a2
Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/f319f0a2
Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/f319f0a2

Branch: refs/heads/cassandra-2.1
Commit: f319f0a236c09a3f97cf33c3efa56fc8abb0d0fe
Parents: 8b9a916
Author: Michael Edge <ed...@gmail.com>
Authored: Tue Nov 24 14:51:35 2015 +0100
Committer: Benjamin Lerer <b....@gmail.com>
Committed: Tue Nov 24 14:51:35 2015 +0100

----------------------------------------------------------------------
 bin/cqlsh | 27 ++++++++++++++++++---------
 1 file changed, 18 insertions(+), 9 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cassandra/blob/f319f0a2/bin/cqlsh
----------------------------------------------------------------------
diff --git a/bin/cqlsh b/bin/cqlsh
index 56cd218..f4bedcd 100755
--- a/bin/cqlsh
+++ b/bin/cqlsh
@@ -1396,7 +1396,7 @@ class Shell(cmd.Cmd):
         (DESC may be used as a shorthand.)
 
           Outputs information about the connected Cassandra cluster, or about
-          the data stored on it. Use in one of the following ways:
+          the data objects stored in the cluster. Use in one of the following ways:
 
         DESCRIBE KEYSPACES
 
@@ -1404,20 +1404,20 @@ class Shell(cmd.Cmd):
 
         DESCRIBE KEYSPACE [<keyspacename>]
 
-          Output CQL commands that could be used to recreate the given
-          keyspace, and the tables in it. In some cases, as the CQL interface
-          matures, there will be some metadata about a keyspace that is not
-          representable with CQL. That metadata will not be shown.
+          Output CQL commands that could be used to recreate the given keyspace,
+          and the objects in it (such as tables, types, etc.).
+          In some cases, as the CQL interface matures, there will be some metadata
+          about a keyspace that is not representable with CQL. That metadata will not be shown.
 
-          The '<keyspacename>' argument may be omitted when using a non-system
-          keyspace; in that case, the current keyspace will be described.
+          The '<keyspacename>' argument may be omitted, in which case the current
+          keyspace will be described.
 
         DESCRIBE TABLES
 
           Output the names of all tables in the current keyspace, or in all
           keyspaces if there is no current keyspace.
 
-        DESCRIBE TABLE <tablename>
+        DESCRIBE TABLE [<keyspace>.]<tablename>
 
           Output CQL commands that could be used to recreate the given table.
           In some cases, as above, there may be table metadata which is not
@@ -1425,7 +1425,7 @@ class Shell(cmd.Cmd):
 
         DESCRIBE INDEX <indexname>
 
-          Output CQL commands that could be used to recreate the given index.
+          Output the CQL command that could be used to recreate the given index.
           In some cases, there may be index metadata which is not representable
           and which will not be shown.
 
@@ -1442,6 +1442,15 @@ class Shell(cmd.Cmd):
           Works as though "DESCRIBE KEYSPACE k" was invoked for each non-system keyspace
           k. Use DESCRIBE FULL SCHEMA to include the system keyspaces.
 
+        DESCRIBE TYPES
+
+          Output the names of all user-defined-types in the current keyspace, or in all
+          keyspaces if there is no current keyspace.
+
+        DESCRIBE TYPE [<keyspace>.]<type>
+
+          Output the CQL command that could be used to recreate the given user-defined-type.
+
         DESCRIBE <objname>
 
           Output CQL commands that could be used to recreate the entire object schema,