CAPTURE

Captures CQL query output and appends the output to a specified file. Error messages and cqlsh commands are displayed in the standard terminal output. All other cqlsh output is appended to the file. To display the current capture status, enter CAPTURE with no options.

Synopsis

CAPTURE [ '<file_name>' | OFF ]

Syntax legend

Table 1. Legend
Syntax conventions	Description
UPPERCASE	Literal keyword.
Lowercase	Not literal.
`< >`	Variable value. Replace with a user-defined value.
`[]`	Optional. Square brackets (`[]`) surround optional command arguments. Do not type the square brackets.
`( )`	Group. Parentheses ( `( )` ) identify a group to choose from. Do not type the parentheses.
`\|`	Or. A vertical bar (`\|`) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
`...`	Repeatable. An ellipsis ( `...` ) indicates that you can repeat the syntax element as often as required.
`'<Literal string>'`	Single quotation (`'`) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.
`{ <key> : <value> }`	Map collection. Braces (`{ }`) enclose map collections or key value pairs. A colon separates the key and the value.
`<datatype2`	Set, list, map, or tuple. Angle brackets ( `< >` ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
`<cql_statement>;`	End CQL statement. A semicolon (`;`) terminates all CQL statements.
`[--]`	Separate the command line options from the command arguments with two hyphens ( `--` ). This syntax is useful when arguments might be mistaken for command line options.
`' <<schema\> ... </schema\>> '`	Search CQL only: Single quotation marks (`'`) surround an entire XML schema declaration.
`@<xml_entity>='<xml_entity_type>'`	Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrConfig files.

<file_name>: The file to write the query output to. When you run the first query after starting the capture, the file is created if it does not already exist. Use a relative path from the current working directory or specify tilde (~) for your home directory. Absolute paths are not supported.
OFF: Stops capture.

Examples

Capture results to the winners text file:

CAPTURE '~/results/winners.txt'

The results directory must exist in your home directory. The winners text file is created if it does not exist.

Now capturing query output to '/Users/<local_system_user>/results/winners.txt'.

Execute a query that selects all cycling race winners:

SELECT *
FROM cycling.race_winners;

Results are appended to the end of the capture file. The results are not displayed in the terminal.