The contents of the CUBRID Database Management System (CUBRID DBMS) product manual are as follows:
The following table provides conventions on definitions used in the CUBRID Database Management System product manual to identify "statements," "commands" and "reference within texts."
Convention |
Description |
Example |
---|---|---|
Italics |
Italics type is used to show the variable names. |
persistent: |
Boldface |
Boldface type is used for names such as the member function name, class name, constants, CUBRID keyword or names such as other required characters. |
fetch ( ) member function |
Constant Width |
Constant Width type is used to show segments of code example or describes a command's execution and results. |
csql database_name |
UPPER-CASE |
UPPER-CASE is used to show the CUBRID keyword (see Boldface). |
SELECT |
Single Quotes (' ') |
Single quotes (' ') are used with braces and brackets, and shows the necessary sections of a syntax. Single quotes are also used to enclose strings. |
{'{'const_list'}'} |
Brackets ([ ]) |
Brackets ([ ]) indicate optional parameters or keywords. |
[ONLY] |
Underline( _ ) |
Underline (_) indicates a default keyword if no keyword is specified. |
[DISTINCT|UNIQUE|ALL] |
Vertical bar( | ) |
Vertical bar (|) indicates that one or another option can be specified. |
[COLUMN|ATTRIBUTE] |
Braces around parameters({ }) |
Braces around parameters indicate that one of those parameters must be specified in a statement syntax. |
{2, 4, 6} |
Braces with ellipsis({ }...) |
Braces before an ellipsis indicate that a parameter can be repeated. |
{, class_name}... |
Angle brackets(< >) |
Angle brackets indicate a single key or a series of key strokes. |
<Ctrl+n> |