Review Board 1.7.22


SQOOP-805 Sqoop2: Document show option function in CommandClientGuide

Review Request #8780 - Created Dec. 29, 2012 and submitted

Jarek Cecho
SQOOP-805
Reviewers
Sqoop
sqoop-sqoop2
I've added documentation of new client function.

 

Diff revision 1 (Latest)

  1. docs/src/site/sphinx/CommandLineClient.rst: Loading...
docs/src/site/sphinx/CommandLineClient.rst
Revision d52efa11ec7cd366a32cd25a1d9b3f306c2845a7 New Change
[20] 123 lines
[+20]
124
+----------------+--------------------------------------------------------------------------------------------------------+
124
+----------------+--------------------------------------------------------------------------------------------------------+
125
| Function       | Description                                                                                            |
125
| Function       | Description                                                                                            |
126
+================+========================================================================================================+
126
+================+========================================================================================================+
127
| ``server``     | Display connection information to the server (host, port, webapp)                                      |
127
| ``server``     | Display connection information to the server (host, port, webapp)                                      |
128
+----------------+--------------------------------------------------------------------------------------------------------+
128
+----------------+--------------------------------------------------------------------------------------------------------+

    
   
129
| ``option``     | Display various client side options                                                                    |

    
   
130
+----------------+--------------------------------------------------------------------------------------------------------+
129
| ``version``    | Show version of both client and server (build numbers, supported protocols)                            |
131
| ``version``    | Show version of both client and server (build numbers, supported protocols)                            |
130
+----------------+--------------------------------------------------------------------------------------------------------+
132
+----------------+--------------------------------------------------------------------------------------------------------+
131
| ``connector``  | Show connector meta data - set of parameters that connectors needs to create connections and jobs      |
133
| ``connector``  | Show connector meta data - set of parameters that connectors needs to create connections and jobs      |
132
+----------------+--------------------------------------------------------------------------------------------------------+
134
+----------------+--------------------------------------------------------------------------------------------------------+
133
| ``framework``  | Show framework meta data - set of parameters that Sqoop framework needs to create connections and jobs |
135
| ``framework``  | Show framework meta data - set of parameters that Sqoop framework needs to create connections and jobs |
[+20] [20] 22 lines
[+20]
156

    
   
158

   
157
Example: ::
159
Example: ::
158

    
   
160

   
159
  show server --all
161
  show server --all
160

    
   
162

   

    
   
163
Show Option Function

    
   
164
~~~~~~~~~~~~~~~~~~~~

    
   
165

   

    
   
166
Show values of various client side options. This function will show all client options when called without arguments.

    
   
167

   

    
   
168
+-----------------------+--------------------------------------------------------------+

    
   
169
| Argument              |  Description                                                 |

    
   
170
+=======================+==============================================================+

    
   
171
| ``-n``, ``--name``    | Show client option value with given name                     |

    
   
172
+-----------------------+--------------------------------------------------------------+

    
   
173

   

    
   
174
Please check table in `Set Option Function`_ section to get a list of all supported option names.

    
   
175

   

    
   
176
Example: ::

    
   
177

   

    
   
178
  show option --name verbose

    
   
179

   
161
Show Version Function
180
Show Version Function
162
~~~~~~~~~~~~~~~~~~~~~
181
~~~~~~~~~~~~~~~~~~~~~
163

    
   
182

   
164
Show versions of both client and server as well as supported protocols.
183
Show versions of both client and server as well as supported protocols.
165

    
   
184

   
[+20] [20] 299 lines
  1. docs/src/site/sphinx/CommandLineClient.rst: Loading...