HELP
The HELP command in ODXSQL displays information about commands and syntax
available for use in the ODXSQL program.
Enter HELP by itself at the ODXSQL prompt for a list of valid commands.
>HELP
Enter HELP followed by a specific command for syntax on that particular
command.
>HELP CONNECT
Enter HELP followed by SYNTAX for a list of all available commands and
their syntax.
>HELP SYNTAX
Enter HELP followed by API for a list of all commands in a table format
indicating which Omnidex API the command is available for use in. The
APIs are OA (OmniAccess), CLOA (Client OmniAccess), ODBC (Open Database
Connectivity), and JDBC (Java Database Connectivity).
>HELP API
Syntax
HELP [<command | SYNTAX | API>]
HELP
Required.
command | SYNTAX | API
Optional. Follow the HELP command with nothing, a particular command,
the SYNTAX keyword, or the API keyword.
HELP by itself displays a complete list of valid commands.
HELP followed by a command displays help information, including syntax,
about that particular command.
HELP followed by the SYNTAX keyword displays the syntax for all ODXSQL
commands.
HELP followed by the API keyword displays all ODXSQL commands in a table
indicating in which Omnidex APIs the command is available.
Options
N/A
Example
> HELP
ODXSQL Commands
---------------
(Commands prefixed with an asterisk are also available in
oaexecsql and
ODBC/JDBC, while commands without an asterisk are only available in ODXSQL.)
! Execute a shell command
. Execute last command
; Comment line
ABORT Cause software abort
ASSIGNVALUES * Assign values for a $VALUES clause
ATTACH * Attach an OST file as a table
BENCHMARK Perform performance benchmarks
BIND Bind a SELECT statement
CALC Perform basic calculator functions
CD Change directories
CLOSE CURSOR * Close a cursor
COMMAND * Execute a shell command via $COMMAND table
CONNECT * Connect to an environment file
CONVERT Export a file with data conversions
COPY Copy a fileset
CREATE DIRECTORY Create a directory
CREATE FILE Create a file
CREATE TABLE * Create a table
Press <RETURN> to continue, 'Q' to quit or '/' to stop paging ...
> HELP CONNECT
CONNECT
Connect to an environment file
(Also available in oaexecsql and ODBC/JDBC.)
Syntax:
CONNECT [TO] filename [AS [user]/[password]]
[WITH options]
>
> help SYNTAX
ODXSQL Commands
---------------
(Commands prefixed with an asterisk are also available in
oaexecsql and
ODBC/JDBC, while commands without an asterisk are only available in ODXSQL.)
!<shell command> or ! for interactive shell
<. | command number>
; [<directive [directive ...]>] text
<SUSPEND> <RESUME> <VERBOSE> <QUIET>
<COMMON> <END_COMMON> <SECTION> <END_SECTION>
<TEST> <END_TEST>
ABORT
* ASSIGNVALUES <value | (value [, value ...])> [TO label]
[ON [CURSOR] cursor] [WITH options]
* ATTACH OST filespec AS table [ON [INSTANCE] instance] [WITH
options]
BENCHMARK [<table | select-statement>] [WITH options]
BIND [ON [CURSOR] cursor] [WITH options]
Press <RETURN> to continue, 'Q' to quit or '/' to stop
paging ...
> HELP API
ODXSQL Commands
---------------
ODXSQL supports many commands, but not all commands are available
in all
API's. The following is a list of all commands and their supported API's.
Command |
OA |
CLOA |
ODBC |
JDBC |
! |
Yes |
Yes |
Yes |
Yes |
. |
Yes |
Yes |
Yes |
Yes |
; |
Yes |
Yes |
Yes |
Yes |
ABORT |
Yes |
Yes |
Yes |
Yes |
ASSIGNVALUES |
Yes |
Yes |
Yes |
Yes |
ATTACH |
Yes |
Yes |
Yes |
Yes |
BENCHMARK |
Yes |
Yes |
Yes |
Yes |
BIND |
Yes |
Yes |
Yes |
Yes |
CALC |
Yes |
Yes |
Yes |
Yes |
CD |
Yes |
Yes |
Yes |
Yes |
CLOSE CURSOR |
Yes |
Yes |
Yes |
Yes |
COMMAND |
Yes |
Yes |
Yes |
Yes |
CONNECT |
Yes |
Yes |
Yes |
Yes |
CONVERT |
Yes |
No |
No |
No |
COPY |
Yes |
Yes |
Yes |
Yes |
CREATE DIRECTORY |
Yes |
Yes |
Yes |
Yes |
Press <RETURN> to continue, 'Q' to quit or '/' to stop
paging .
Top
|
