Help Center/ GaussDB(DWS)/ Tool Guide/ DSC/ About This Document/ Document Conventions

Updated on 2024-04-28 GMT+08:00

View PDF

Document Conventions

This section describes the content, symbol, and command conventions of this document.

Disclaimer

The purchased products, services, and features are subject to the signed contract. All or part of the products, services, and features described in this document may not be available for purchasing or using. Unless otherwise specified in the contract, all statements, information, and recommendations in this document are provided in the form of "as-is" and do not constitute a warranty, guarantee, or representation of any kind, express or implied.

Symbol Convention

Symbols that may be found in this document are defined as follows:

Symbol	Description
	Indicates an imminently hazardous situation which, if not avoided, will result in serious injury or death.
	Indicates a potentially hazardous situation which, if not avoided, will result in death or serious injury.
	Indicates a potentially hazardous situation which, if not avoided, may result in minor or moderate injury.
	Indicates a potentially hazardous situation which, if not avoided, could result in equipment damage, data loss, performance deterioration, or unanticipated results. NOTICE is used to address practices not related to personal injury.
	Provides additional information to emphasize or supplement important points of the main text. NOTE is used to address information not related to personal injury, equipment damage, or environment damage.

Command Conventions

Commands in this document comply with the following conventions:

**Table 1** Command conventions
Format	Description
Boldface	The keywords of a command are in Boldface.
Italic	Command arguments, paths, files, or folders are in italics.
[ ]	Square brackets enclose syntax choices (keywords or arguments) that are optional.
{ x \| y \| ... }	Braces enclose a set of required syntax choices separated by vertical bars (\|), from which you select one.
[ x \| y \| ... ]	Square brackets enclose a set of optional syntax choices separated by vertical bars, from which you select one or none.
{ x \| y \| ... }*	Asterisk marked braces enclose a set of required syntax choices separated by vertical bars, from which you select at least one.
[ x \| y \| ... ]*	Asterisk marked square brackets enclose optional syntax choices separated by vertical bars, from which you select one choice, multiple choices, or none.
&<1-n>	The argument or keyword and argument combination before the ampersand (&) sign can be entered 1 to n times.
#	A line that starts with a pound (#) sign is comments.