Files
impala/docs/topics/impala_comments.xml
Jim Apple 3be0f122a5 IMPALA-3398: Add docs to main Impala branch.
These are refugees from doc_prototype. They can be rendered with the
DITA Open Toolkit version 2.3.3 by:

/tmp/dita-ot-2.3.3/bin/dita \
  -i impala.ditamap \
  -f html5 \
  -o $(mktemp -d) \
  -filter impala_html.ditaval

Change-Id: I8861e99adc446f659a04463ca78c79200669484f
Reviewed-on: http://gerrit.cloudera.org:8080/5014
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: John Russell <jrussell@cloudera.com>
2016-11-17 22:38:44 +00:00

54 lines
1.5 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="comments">
<title>Comments</title>
<prolog>
<metadata>
<data name="Category" value="Impala"/>
<data name="Category" value="SQL"/>
<data name="Category" value="Developers"/>
<data name="Category" value="Data Analysts"/>
</metadata>
</prolog>
<conbody>
<p>
<indexterm audience="Cloudera">comments (SQL)</indexterm>
Impala supports the familiar styles of SQL comments:
</p>
<ul>
<li>
All text from a <codeph>--</codeph> sequence to the end of the line is considered a comment and ignored.
This type of comment can occur on a single line by itself, or after all or part of a statement.
</li>
<li>
All text from a <codeph>/*</codeph> sequence to the next <codeph>*/</codeph> sequence is considered a
comment and ignored. This type of comment can stretch over multiple lines. This type of comment can occur
on one or more lines by itself, in the middle of a statement, or before or after a statement.
</li>
</ul>
<p>
For example:
</p>
<codeblock>-- This line is a comment about a table.
create table ...;
/*
This is a multi-line comment about a query.
*/
select ...;
select * from t /* This is an embedded comment about a query. */ where ...;
select * from t -- This is a trailing comment within a multi-line command.
where ...;
</codeblock>
</conbody>
</concept>