UltraLite C++ User's Guide
  About This Manual

Documentation conventions

This section lists the typographic and graphical conventions used in this documentation.

Syntax conventions 

The following conventions are used in the SQL syntax descriptions:

• Keywords    All SQL keywords appear in upper case, like the words ALTER TABLE in the following example:

  ALTER TABLE [ owner.]table-name

• Placeholders    Items that must be replaced with appropriate identifiers or expressions are shown like the words owner and table-name in the following example:

  ALTER TABLE [ owner.]table-name

• Repeating items    Lists of repeating items are shown with an element of the list followed by an ellipsis (three dots), like column-constraint in the following example:

  ADD column-definition [ column-constraint, ... ]

  One or more list elements are allowed. In this example, if more than one is specified, they must be separated by commas.

• Optional portions    Optional portions of a statement are enclosed by square brackets.

  RELEASE SAVEPOINT [ savepoint-name ]

  These square brackets indicate that the savepoint-name is optional. The square brackets should not be typed.

• Options    When none or only one of a list of items can be chosen, vertical bars separate the items and the list is enclosed in square brackets.

  [ ASC | DESC ]

  For example, you can choose one of ASC, DESC, or neither. The square brackets should not be typed.

• Alternatives    When precisely one of the options must be chosen, the alternatives are enclosed in curly braces and a bar is used to separate the options.

  [ QUOTES { ON | OFF } ]

  If the QUOTES option is used, one of ON or OFF must be provided. The brackets and braces should not be typed.

Graphic icons 

The following icons are used in this documentation.

• A client application.

  

• A database server, such as Sybase Adaptive Server Anywhere.

  

• A database. In some high-level diagrams, the icon may be used to represent both the database and the database server that manages it.

  

• Replication or synchronization middleware. These assist in sharing data among databases. Examples are the MobiLink Synchronization Server and the SQL Remote Message Agent.

  

• A programming interface.