CUBRID 데이터베이스 관리 시스템(Database Management System, DBMS) 매뉴얼의 구성은 다음과 같다.
다음 표는 CUBRID 데이터베이스 관리 시스템 제품 매뉴얼에서 '문장', '명령어', 그리고 '텍스트 안에서의 참조'를 식별하는데 사용되는 문서 규약이다.
규약 |
설명 |
예제 |
---|---|---|
Italics |
Italics type은 변수 이름을 나타내는데 사용된다. |
persistent: stringVariableName |
Boldface |
Boldface는 멤버 함수 이름, 클래스 이름, 상수, CUBRID 키워드 또는 다른 필수 문자와 같은 이름을 나타내는데 사용된다. |
fetch ( ) member function class odb_User |
Constant Width |
Constant Width type의 글꼴은 코드 예제 또는 명령어의 실행 및 결과를 나타내는데 사용된다. |
csql database_name |
UPPER-CASE |
UPPER-CASE는 CUBRID 키워드를 나타내는데 사용된다(Boldface 참조). |
SELECT |
Single Quotes (' ') |
중괄호, 대괄호와 같이 사용하는 작은 따옴표(' ')는 문법의 필요한 부분을 나타낸다. 또한 작은 따옴표는 스트링을 싸는데도 사용된다. |
{'{' const_list'}'} |
Brackets ([ ]) |
대괄호([ ])는 파라미터나 키워드가 선택적임을 나타내는데 사용된다. |
[ONLY] |
Underline( _ ) |
밑줄(_)은 명시되지 않을 때의 디폴트 키워드를 나타내는데 사용된다. |
[DISTINCT|UNIQUE|ALL] |
Vertical bar( | ) |
수직 막대(|)는 여럿 중의 하나만을 선택할 수 있음을 나타내는데 사용된다. |
[ATTRIBUTE|COLUMN] |
Braces around parameters({ }) |
중괄호로 싼 파라미터는 문장의 문법으로 여럿 중에서 하나만을 반드시 선택해야 함을 나타내는데 사용된다. |
CREATE {CLASS|TABLE} |
Braces around values({ }) |
중괄호로 싼 값은 집합을 구성하는 원소를 나타내는데 사용된다. |
{2. 4, 6} |
Braces with ellipsis({ }...) |
중괄호 뒤의 생략 부호(...)는 파라미터 지정이 반복될 수 있음을 나타내는데 사용된다. |
{, class_name}... |
Angle brackets(< > ) |
산괄호(< > )는 단일 키 또는 일련의 키 입력을 나타내는데 사용된다. |
< Ctrl+n> |