Copyright © 1996, 2003 Oracle Corporation. All Rights Reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. SQL*Plus® Quick Reference Release 10.1 December 2003 Part No. B12171-01 About this Quick Reference This Quick Reference shows iSQL*Plus buttons and icons, and iSQL*Plus and SQL*Plus command syntax. For detailed information on each command, refer to the SQL*Plus User's Guide and Reference. This Quick Reference has the following topics: Q Conventions for Command Syntax Q Documentation Accessibility Q Alphabetic List of SQL*Plus Commands Q Starting iSQL*Plus Q iSQL*Plus Navigation Q iSQL*Plus Preferences Q iSQL*Plus Workspace Buttons Q Starting and Leaving SQL*Plus Q Starting Up and Shutting Down a Database Q Entering and Executing Commands Q Manipulating SQL, SQL*Plus and PL/SQL Commands Q Formatting Query Results Q Accessing Databases Q Miscellaneous 2 Conventions for Command Syntax The following two tables describe the notation and conventions for command syntax used in this Quick Reference. Table 1 Commands, Terms, and Clauses Feature Example Explanation uppercase BTITLE Enter text exactly as spelled; it need not be in uppercase. lowercase italics column A clause value; substitute an appropriate value. words with specific meanings c A single character. char A CHAR value—a literal in single quotes—or an expression with a CHAR value. d or e A date or an expression with a DATE value. expr An unspecified expression. m or n A number of an expression with a NUMBER value. text A CHAR constant with or without single quotes. variable A substitution variable (unless the text specifies another variable type). Table 2 Punctuation Feature Example Explanation vertical bar | Separates alternative syntax elements that may be optional or mandatory. brackets [ON | OFF] One or more optional items. If two items appear separated by |, enter one of the items. Do not enter the brackets or |. braces {ON | OFF} A choice of mandatory items; enter one of the items. Do not enter the braces or |. underlining {ON | OFF} A default value; if you enter nothing, SQL*Plus assumes the underlined value. ellipsis n Preceding items may be repeated any number of times. 3 Documentation Accessibility Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For additional information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/ Accessibility of Code Examples in Documentation JAWS, a Windows screen reader, may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, JAWS may not always read a line of text that consists solely of a bracket or brace. Accessibility of Links to External Web Sites in Documentation This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites. 4 Alphabetic List of SQL*Plus Commands @ { url | file_name [ .ext ]} [ arg ] @@ { url | file_name [ .ext ] } [ arg ] / (slash) ACC[EPT] variable [NUM[BER] | CHAR | DATE | BINARY_FLOAT | BINARY_DOUBLE] [FOR[MAT] format ] [DEF[AULT] default ] [PROMPT text | NOPR[OMPT]] [HIDE] *A[PPEND] text ARCHIVE LOG {LIST | STOP} | {START | NEXT | ALL | integer } [TO destination ] ATTRIB U TE [ type_name . attribute_name [ option ]] BRE[AK] [ON report_element [ action [ action ]]] BTI[TLE] [ printspec [ text | variable ] ] | [ON | OFF] *C[HANGE] sepchar old [ sepchar [ new [ sepchar ]]] CL[EAR] option COL[UMN] [{ column | expr } [ option ]] COMP[UTE] [ function [LAB[EL] text ] OF { expr | column | alias } ON { expr | column | alias | REPORT | ROW} ] CONN[ECT] [{ logon | /} [AS {SYSOPER | SYSDBA}]] COPY {FROM database | TO database | FROM database TO database } {APPEND | CREATE | INSERT | REPLACE} destination_table [( column , column , column , )] USING query DEF[INE] [ variable ] | [ variable = text ] *DEL [ n | n m | n * | n LAST | * | * n | * LAST | LAST] DESC[RIBE] {[ schema .] object [ @connect_identifier ]} DISC[ONNECT] *ED[IT] [ file_name [. ext ]] EXEC[UTE] statement {EXIT | QUIT} [SUCCESS | FAILURE | WARNING | n | variable | :BindVariable ] [COMMIT | ROLLBACK] *GET [FILE] file_name [. ext ] [LIS[T] | NOL[IST]] HELP | ? [ topic ] *HO[ST] [ command ] *I[NPUT] [ text ] 5 L[IST] [ n | n m | n * | n LAST | * | * n | * LAST | LAST] *PASSW[ORD] [ username ] PAU[SE] [ text ] PRI[NT] [ variable ] PRO[MPT] [ text ] {EXIT | QUIT} [SUCCESS | FAILURE | WARNING | n | variable | :BindVariable ] [COMMIT | ROLLBACK] RECOVER { general | managed | BEGIN BACKUP | END BACKUP} REM[ARK] REPF[OOTER] [PAGE] [ printspec [ text | variable ] ] | [ON | OFF] REPH[EADER] [PAGE] [ printspec [ text | variable ] ] | [ON | OFF] R[UN] *SAV[E] [FILE] file_name [. ext ] [CRE[ATE] | REP[LACE] | APP[END]] SET system_variable value SHO[W] [ option ] SHUTDOWN [ABORT | IMMEDIATE | NORMAL | TRANSACTIONAL [LOCAL]] *SPO[OL] [ filename [. ext ] [CRE[ATE] | REP[LACE] | APP[END]] | OFF | OUT] STA[RT] { url | file_name [ .ext ] } [ arg ] STARTUP options | upgrade_options *STORE {SET} file_name [. ext ] [CRE[ATE] | REP[LACE] | APP[END]] TIMI[NG] [START text | SHOW | STOP] TTI[TLE] [ printspec [ text | variable ] ] | [ON | OFF] UNDEF[INE] variable VAR[IABLE] [ variable {NUMBER | CHAR | CHAR ( n [CHAR | BYTE]) | NCHAR | NCHAR ( n ) | VARCHAR2 ( n [CHAR | BYTE])| NVARCHAR2( n ) | CLOB | NCLOB | REFCURSOR | BINARY_FLOAT | BINARY_DOUBLE}] WHENEVER OSERROR {EXIT [SUCCESS | FAILURE | n | variable | :BindVariable ] [COMMIT | ROLLBACK] | CONTINUE[COMMIT | ROLLBACK | NONE]} WHENEVER SQLERROR {EXIT [SUCCESS | FAILURE | WARNING | n | variable | :BindVariable ] [COMMIT | ROLLBACK] | CONTINUE [COMMIT | ROLLBACK | NONE]} *Commands not available in iSQL*Plus. 6 Starting i SQL*Plus Use the following syntax in your web browser's URL field to display iSQL*Plus. http:// machine_name.domain : port /isqlplus[/dynamic? UserOpts ] or to start iSQL*Plus with DBA privileges, use: http:// machine_name.domain /isqlplus/dba[/dynamic? DBAOpts ] where UserOpts has the following syntax: UserLogin | Script | UserLogin & Script where DBAOpts has the following syntax: DBALogin | Script | DBALogin & Script where UserLogin has the following syntax: userid = username [/ password ] [@ connect_identifier ] where DBALogin has the following syntax: userid ={ username [/ password ] [@ connect_identifier ] | / } AS {SYSDBA | SYSOPER} and where Script has the following syntax: script = text [&type={url | text}] [&action={execute | load}] [& variable = value . . .] Examples To start iSQL*Plus, enter http:// machine_name.domain : port /isqlplus To start iSQL*Plus with DBA Privileges, enter http:// machine_name.domain : port /isqlplus/dba 7 i SQL*Plus Navigation The table lists navigation icons used to navigate in iSQL*Plus. i SQL*Plus Preferences The table lists preferences that can be set in iSQL*Plus. i SQL*Plus Workspace Buttons The table lists buttons in the iSQL*Plus Workspace, and their purpose. Icon Label Purpose Logout Log out of the iSQL*Plus session, return to the Login screen. Preferences Open the iSQL*Plus Preferences screen to set interface options, configure system options or change your password. Help Open the iSQL*Plus Help in a new browser window. Navigation Path Purpose Preferences > Interface Configuration To change options which affect the iSQL*Plus user interface. Preferences > System Configuration To change options which affect output formatting, script execution and database administration. Preferences > Change Password To change your Oracle database password. Button Purpose Execute To execute the contents of the Workspace. Load Script To load a script into the Workspace. The script can be local, or loaded via HTTP or FTP. Save Script To save the contents of the Workspace to a local file. Cancel To interrupt a script during execution. Next Page To view the next page of results. Clear To clear the script input and output areas. 8 Starting and Leaving SQL*Plus Use the following commands to log in to and out of SQL*Plus. SQLPLUS [[ option ] [ logon ] [ start ]] where option has the following syntax: -H[ELP] | -V[ERSION] | [ [-C[OMPATIBILITY] x . y [. z ]] [-L[OGON]] [-M[ARKUP] " mark_options "] [-R[ESTRICT] {1 | 2 | 3}] [-S[ILENT]] ] where mark_options has the following syntax: HTML [ON | OFF] [HEAD text ] [BODY text ] [TABLE text ] [ENTMAP {ON | OFF}] [SPOOL {ON | OFF}] [PRE[FORMAT] {ON | OFF}] where logon has the following syntax: { username [/ password ] [ @connect_identifier ] | /} [AS {SYSOPER | SYSDBA}] | /NOLOG and where start has the following syntax: @ { url | file_name [. ext ]} [ arg ] {EXIT | QUIT} [SUCCESS | FAILURE | WARNING | n | variable | :BindVariable ] [COMMIT | ROLLBACK] Commits or rolls back all pending changes, logs out of Oracle, terminates SQL*Plus and returns control to the operating system. In iSQL*Plus, commits or rolls back all pending changes, stops processing the current iSQL*Plus script and returns focus to the Workspace. In iSQL*Plus, click the Logout button to log out of Oracle. 9 Starting Up and Shutting Down a Database Starting up and shutting down a database requires DBA privileges. STARTUP options | upgrade_options where options has the following syntax: [FORCE] [RESTRICT] [PFILE= filename ] [QUIET] [ MOUNT [ dbname ] | [ OPEN [ open_options ] [ dbname ] ] | NOMOUNT ] where open_options has the following syntax: READ {ONLY | WRITE [RECOVER]} | RECOVER and where upgrade_options has the following syntax: [PFILE= filename ] {UPGRADE | DOWNGRADE} [QUIET] Starts an Oracle instance with several options, including mounting and opening a database. SHUTDOWN [ABORT | IMMEDIATE | NORMAL | TRANSACTIONAL [LOCAL]] Shuts down a currently running Oracle instance, optionally closing and dismounting a database. Entering and Executing Commands Use the following commands to execute and collect timing statistics on SQL commands and PL/SQL blocks. / (slash) Executes the most recently executed SQL command or PL/SQL block which is stored in the SQL buffer. Does not list the command. Use slash (/) at the command prompt or line number prompt in SQL*Plus command line, or use slash (/) in the iSQL*Plus Workspace. The buffer has no command history and does not record SQL*Plus commands. EXEC[UTE] statement Executes a single PL/SQL statement or runs a stored procedure. R[UN] Lists and executes the most recently executed SQL command or PL/SQL block which is stored in the SQL buffer. The buffer has no command history and does not record SQL*Plus commands. 10 TIMI[NG] [START text | SHOW | STOP] Records timing data for an elapsed period of time, lists the current timer's name and timing data, or lists the number of active timers. Use the following command to access the help system. HELP | ? [ topic ] Accesses the command-line help system. Enter HELP INDEX or ? INDEX for a list of topics. In iSQL*Plus, you can also click the Help button to display iSQL*Plus online help. You can view SQL*Plus resources at http://otn.oracle.com/tech/sql_plus/ and the Oracle Database Library at http://otn.oracle.com/documentation/. Use the following command to execute operating system commands. HO[ST] [ command ] Executes an operating system command without leaving SQL*Plus. Enter HOST without command to display an operating system prompt. You can then enter multiple operating system commands. With some operating systems, you can use another character instead of HOST such as "!" (UNIX) and "$" (Windows). See the Oracle installation and user's manuals provided for your operating system for details. HOST is not available in iSQL*Plus. Manipulating SQL, SQL*Plus and PL/SQL Commands Use the following commands to edit SQL commands and PL/SQL blocks. A[PPEND] text Adds specified text to the end of the current line in the SQL buffer. To separate text from the preceding characters with a space, enter two spaces. To append text that ends with a semicolon, end the command with two semicolons (a single semicolon is interpreted as a command terminator). APPEND is not available in iSQL*Plus. C[HANGE] sepchar old [ sepchar [ new [ sepchar ]]] Changes first occurrence of old on the current line of the SQL buffer. You can use any non-alphanumeric character such as "/" or "!" as a sepchar. You can omit the space between CHANGE and the first sepchar. The buffer has no command history list and does not record SQL*Plus commands. CHANGE is not available in iSQL*Plus. [...]... {NUMBER | CHAR | CHAR (n [CHAR | BYTE]) | NCHAR | NCHAR (n) | VARCHAR2 (n [CHAR | BYTE]) | NVARCHAR2(n) | CLOB | NCLOB | REFCURSOR | BINARY_FLOAT | BINARY_DOUBLE}] Declares a bind variable that can be referenced in PL/SQL, or lists the current display characteristics for a single variable or all variables Use the following symbols to create substitution variables and parameters for use in scripts &n... file to your computer's default printer Enter SPOOL with no clauses to list the current spooling status If no file extension is given, the default extension, lst or lis, is used In iSQL*Plus, use the Preferences screen to direct output to a file SPOOL is not available in iSQL*Plus TTI[TLE] [printspec [text | variable] ] | [ON | OFF] Places and formats a specified title at the top of each report page,... current session For example, to: set the display width for data customize HTML formatting enable or disable printing of column headings set the number of lines per page In iSQL*Plus, you can also use the Preferences screen to set system variables Enter a system variable followed by a value as shown below: SET APPI[NFO]{ON | OFF | text} SET ARRAY[SIZE] {15 | n} SET AUTO[COMMIT] {ON | OFF | IMM[EDIATE] | . respective owners. SQL*Plus® Quick Reference Release 10.1 December 2003 Part No. B12171-01 About this Quick Reference This Quick Reference shows iSQL*Plus. SQL*Plus User's Guide and Reference. This Quick Reference has the following topics: Q Conventions for Command Syntax Q Documentation Accessibility Q