Contribute
Style Guide for MindsDB Documentation
Syntax for SQL commands
Follow the rules below when writing an SQL command.
- Add a semi-colon
;
at the end of each SQL command. - Use all-caps when writing the keywords, such as
SELECT
,FROM
,JOIN
,WHERE
,GROUP BY
,ORDER BY
,PREDICT
,AS
,CREATE TABLE
,INSERT INTO
, etc. - When writing a query, start a new line for the following keywords:
SELECT
,FROM
,JOIN
,WHERE
,GROUP BY
,ORDER BY
,PREDICT
,USING
,AND
,OR
. It is to avoid the horizontal scrollbar.
Example
Syntax for SQL commands along with their output
Follow the syntax below when documenting an SQL command and its output.
On execution, we get:
Where:
Name | Description |
---|---|
VARIABLE NAME GOES HERE | VARIABLE DESCRIPTION GOES HERE |
If the output is not a table, remove the output table from above and place your output message there.
Example 1
On execution, we get:
Where:
Name | Description |
---|---|
column_name | column description |
Output of Example 1
On execution, we get:
Where:
Name | Description |
---|---|
column_name | column description |
Example 2
On execution, we get:
Output of Example 2
On execution, we get:
Was this page helpful?