Skip Headers
Oracle® Application Express SQL Workshop and Utilities Guide
Release 3.1.2

Part Number E12857-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

2 Using SQL Scripts

This section provides information on how to use SQL Scripts to create, edit, view, run, and delete script files.

This section contains the following topics:

What is SQL Scripts?

A SQL script is a set of SQL commands saved as a file in SQL Scripts. A SQL script can contain one or more SQL statements or PL/SQL blocks. You can use SQL Scripts to create, edit, view, run, and delete script files.

When using SQL Scripts, remember the following:

Accessing SQL Scripts

To access SQL Scripts:

  1. Log in to the Workspace home page.

  2. To view SQL Scripts page you can either:

    • Click the SQL Workshop icon and then SQL Scripts to drill-down to the SQL Scripts page.

    • Click the down arrow on the right side of the SQL Workshop icon to view a drop down menu. Then select the SQL Scripts menu option.

    Description of scripts.gif follows
    Description of the illustration scripts.gif

    Note:

    For the purposes of consistency, this document uses the primary navigation path (or drill-down approach) when explaining navigation.

About the SQL Scripts Page

The SQL Scripts page display all SQL scripts created by the current user. You can control the appearance of the page by making a selection from the View list. The default view, Icons, displays each script as an icon. Details view displays each script as a row in a report.

Description of script_home.gif follows
Description of the illustration script_home.gif

The SQL Scripts page features the following controls:

Switching to Another SQL Workshop Component

You can navigate to another SQL Workshop component by selecting one of the following from the Component list located on the upper right side of the page:

About the Tasks List

A Tasks list displays on the right side of the SQL Scripts page.

Description of script_tasks.gif follows
Description of the illustration script_tasks.gif

The Task list contains the following links:

Creating a SQL Script

You can create a new script in the Script Repository by:

Topics in this section include:

Creating a SQL Script in the Script Editor

To create a new SQL script in the Script Editor:

  1. On the Workspace home page, click SQL Workshop and then SQL Scripts.

    The SQL Scripts page appears.

  2. Click the Create button.

    The Script Editor appears.

  3. Enter a name for the script in the Script Name field.

    Script name extensions are optional.

  4. Enter the SQL statements, PL/SQL blocks and SQL*Plus commands you want to include in your script.

    Remember that SQL Command Line commands are ignored at run time.

  5. Click Save to save your script to the repository.

    The SQL Scripts page appears listing your newly saved script.

Uploading a SQL Script

To upload a script from your local file system:

  1. On the Workspace home page, click SQL Workshop and then SQL Scripts.

    The SQL Scripts page appears.

  2. Click the Upload button.

    The Upload Script dialog appears.

  3. To upload a script you can either:

    • Enter the name and path to the script you want to upload to the Script Repository.

    • Click Browse to locate the script you want to upload.

  4. Optionally rename the script by entering the new name in the Script Name field.

    This is the name given to the script in the Script Repository.

  5. Click Upload to add the script to the Script Repository.

    The SQL Scripts page appears listing your newly uploaded script.

    The script is parsed during upload. If it has a syntax error, an error icon appears in place of the run icon in the SQL Scripts page Details view.

    If a script of the same name exists in the Script Repository, you are prompted to rename it.

Using the Script Editor

You use the Script Editor to add content to a new script, to edit existing scripts, and to run and delete scripts in the script repository.

Topics in this section include:

Editing an Existing Script

To edit a SQL script:

  1. On the Workspace home page, click SQL Workshop and then SQL Scripts.

    The SQL Scripts page appears.

  2. You can load a script into the editor as follows:

    • In Icons view, click the script icon.

    • In Details view, click the Edit icon.

    The Script Editor appears.

    Description of script_editor.gif follows
    Description of the illustration script_editor.gif

  3. Edit the script.

    Note that new lines are automatically indented to the previous line start column. Other features of the Script Editor include:

    • Search and Replace. Click Find to display the text and JavaScript regular expression find and replace options. Click Find again to hide the options. See "Searching and Replacing Text or Regular Expressions".

    • Line Selection. Click the line number on the left side of the Script Editor to select the associated line of your script for copying or deleting.

    • Cut, Copy, and Paste. Use standard edit controls to cut, copy and paste content in the Script Editor.

    • Auto indenting lines. New lines automatically indent to the previous line start column.

    You can test your script during editing by running the script to reveal errors. The Run Script dialog and the Script Results pages enable you to resume editing the script. See "Executing a SQL Script", and "Viewing SQL Script Results".

  4. Click Save to save your script to the Script Repository,

    The SQL Scripts page appears.

Searching and Replacing Text or Regular Expressions

Clicking the Find button in the Script Editor displays the Find and Replace with fields at the top of the page. Use these fields to search for and replace text strings and JavaScript regular expressions within a script. To exit Find mode, click Find again.

Description of script_find.gif follows
Description of the illustration script_find.gif

To access Find mode in the Script Editor:

  1. On the Workspace home page, click SQL Workshop and then SQL Scripts.

    The SQL Scripts page appears.

  2. Select a script.

    The Script Editor appears.

  3. Click the Find button.

    The Find and Replace fields appear.

  4. In the Find field, enter the string you wish to find. In Replace with, enter the new string to be added and then click the appropriate button (Replace, Find Next, or Replace All.)

    To further refine your search, select the appropriate check box:

    • Match Case

    • Match Whole Words

    • Match Regular Expression

  5. To exit Find mode, click Find.

Summary of Script Editor Controls

Table 2-1describes the buttons and controls available within the Script Editor

Table 2-1 Buttons and Controls within the Script Editor

Button Descriptions

Cancel

Cancel the editing session and exit the Script Editor without saving changes made since the last save.

Download

Saves a copy of the current script to your local file system. Enter a name for the script on your local file system and a directory path.

Delete

Removes the current script from the Script Repository.

See Also: "Deleting a SQL Script"

Save

Save your changes to the current script to the Script Repository.

Run

Submits the script for execution.

See Also: "Executing a SQL Script"

Undo (Ctrl+Z)

Removes, or undoes, the most recent line edit made in the Script Editor.

Redo (Ctrl+Y)

Repeats the most recent line edit made in the Script Editor.

Find

Click Find to access search and replace mode. Click Find again to exit Find mode.

See Also: "Searching and Replacing Text or Regular Expressions"


Deleting a SQL Script

You can delete scripts from the Script Repository by deleting selected scripts from the SQL Scripts page, or deleting the current script in the Script Editor.

Topics in this section include:

Deleting Scripts from the SQL Scripts Page

To delete scripts from the SQL Scripts page.

  1. On the Workspace home page, click SQL Workshop and then SQL Scripts.

    The SQL Scripts page appears.

  2. From the View list, select Details and click Go.

    Details view appears.

  3. Select the scripts to be deleted.

    To select individual scripts, click the check box to the left of the Edit icon. To select all scripts visible in the current page, click the check box in the column heading.

  4. Click Delete Checked to permanently remove the selected scripts from the Script Repository. You are prompted to confirm this action before the script is deleted.

    The message "Script(s) deleted" appears above the updated list of Scripts.

Deleting a Script in the Script Editor

To delete a script in the Script Editor:

  1. On the Workspace home page, click SQL Workshop and then SQL Scripts.

    The SQL Scripts page appears.

  2. Open the script you want to delete in the Script Editor.

  3. Click Delete to permanently remove the script from the Script Repository. You are prompted to confirm this action before the script is deleted.

    The SQL Scripts page appears. The message "Script(s) deleted" appears above the updated list of scripts.

Copying a SQL Script

You can copy a script in the Script Repository by saving it with a new name.

To copy a script:

  1. On the Workspace home page, click SQL Workshop and then SQL Scripts.

    The SQL Scripts page appears.

  2. Load the script to copy into the editor.

  3. Enter a name for the copied script in the Script Name field.

  4. Click Save to save a copy of the script in the Script Repository.

    The SQL Scripts page appears listing the newly copied script.

Executing a SQL Script

You can execute scripts stored in the Script Repository. You can submit a script for execution either from the Script Editor, or from the SQL Scripts page.

When you submit a script for execution, the Run Script page appears. It displays the script name, when it was created and by who, when it was last updated and by who, the number of statements it contains, and its size in bytes. It also lists unknown statements such as SQL*Plus commands that it will ignore during execution.

Finally, it lists statements with errors. If there are errors, the Run control does not appear.

Topics in this section include:

Executing a SQL Script in the Script Editor

To execute a script in the Script Editor:

  1. Open the script you want to execute in the Script Editor. See "Using the Script Editor".

  2. Click Run in the Script Editor.

  3. The Run Script page appears.

    The Run Script page displays information about the script and lists statements in error preventing execution, or statements such as SQL*Plus commands that will be ignored when the script is executed.

    The Run Script page has three controls:

    • Cancel returns you to the SQL Scripts page without executing the script.

    • Edit Script loads the script into the Script Editor. Note that Edit Script appears instead of Run when a script has errors.

    • Run to submit the script for execution. Note that Run is not available if there are script errors.

  4. Click Run to submit the script for execution.

    The Manage Script Results page appears listing script results.

  5. To view script results, click the View icon under View Results.

Executing a SQL Script from the SQL Scripts Page

To execute a script from the SQL Scripts page:

  1. On the Workspace home page, click SQL Workshop and then SQL Scripts.

    The SQL Scripts page appears.

  2. From the View list, select Details and click Go.

    Details view appears.

  3. Click the Run icon for the script you want to execute. The Run icon is located on the far right side adjacent to the script name.

  4. The Run Script page appears.

    The Run Script page displays information about the script and lists statements in error preventing execution, or statements such as SQL*Plus commands that will be ignored when the script is executed. The Run Script page has three controls:

    Cancel to return to the SQL Scripts page without executing the script.

    Edit Script to load the script into the Script Editor. Edit Script appears instead of Run when a script has errors.

    Run to submit the script for execution. Run is not available for scripts with errors.

  5. Click Run to submit the script for execution.

    The Manage Script Results page appears listing available results for the script.

  6. Click the View icon for the results you want to view. The View icon is at the right end of the scripts listed in the Manage Script Results page.

About the Run Script Page

On the Run Script page, you can:

Viewing SQL Script Results

You use the Manage Script Results page to view and delete script results.

You can also select script results to view from the Icons view of the SQL Scripts page, and from the Results column of the SQL Scripts page Details view.

Topics in this section include:

Viewing Results from the SQL Scripts Page

To view script results from the SQL Scripts page:

  1. On the Workspace home page, click SQL Workshop and then SQL Scripts.

    The SQL Scripts page appears.

  2. You can access the Manage Script Results page in the following ways:

    • On the Tasks list, click Manage Results.

    • In Details view, click the Results number for the script you want to display.

    • In Icons view, click the Show Results check box and then the appropriate icon. Results icons only appear in the Icons view if you click the Show Results check box.

    The Manage Script Results page appears, listing available results for the script. See "About the Manage Script Results Page".

    Description of script_manage_results.gif follows
    Description of the illustration script_manage_results.gif

  3. Click the View icon for the results you want to view. The View icons display on the far right side of page under the heading View Results.

    The Results page appears. See "About the Results Page".

About the Manage Script Results Page

On the Manage Script Results page you can:

  • Search for a result. Enter a result name or partial name in the Script field and click Go. To view all results, leave the Script field blank and click Go. You control how many rows display by making a selection from the Display list.

  • Change the Page View. You can change the appearance of the page by making a selection from the View list. Available View options include:

    • Icons displays each result as an icon identified by the script name, and time and date stamp.

    • Details displays each result as a line in a report. Each line includes a check box to enable the selection of results for deletion, the associated script name which is a link enabling it to be loaded into the Script Editor, who ran the script, when the run started, how long it took to run, whether the run is complete or not, the number of statements executed, the size in bytes, and a View icon to view the results.

  • Delete a result. In Details view, select the check box associated with each result you want to delete, and click Delete Checked.

  • Sort results. In Details view, click a column heading to sort the listed results by that column.

About the Results Page

The Results page displays the script name and status (Complete, Canceled, Executing or Submitted), and lists the statements executed.

Description of script_results.gif follows
Description of the illustration script_results.gif

On the Results page you can:

  • Choose the view. Click the Detail or Summary radio button and click Go to specify whether to display complete or summarized information.

  • Choose the number of rows to display. In Summary view, make a selection from the Display list and click Go to specify the number of rows displayed.

  • Sort the statement report. In Summary view, select a column heading to sort the listed values by that column.

  • Edit the script. Click Edit Script to load the script into the Script Editor. See "Using the Script Editor".

Exporting and Importing SQL Scripts

You can transfer scripts from your current Script Repository to a Script Repository in a different workspace by using the Export and Import tasks. Exported scripts are encoded in a single file on your local file system. Once exported, you then log in to another workspace and import the file. During import, the file is run to re-create the scripts in the current Script Repository.

By default, the Export SQL Scripts page lists all scripts in the Script Repository created by the current user. There are two panes on the Export SQL Scripts page, the Scripts pane and the Scripts to Export pane. You use the Scripts pane to select scripts to export. Then, you use the Scripts to Export pane to finalize the scripts to export, to choose a name for the export script, and to save the selected scripts in the export script on your local file system. You use the Import Scripts pane to select the export script containing the scripts to import.

Topics in this section include:

Copying Scripts to an Export Script

To copy scripts to an export script:

  1. On the Workspace home page, click SQL Workshop and then SQL Scripts.

    The SQL Scripts page appears.

  2. On the Tasks list, click Export.

    The Export SQL Scripts page appears.

  3. Click the check box for each of the scripts you want to export. The check boxes display on the left side adjacent to the script name. To select all displayed scripts for export, click the column head check box.

  4. Click Add to Export to create a list of scripts to be added to the export script.

    The selected scripts are added to the list of scripts in the Scripts to Export pane.

  5. Enter a name for the export script in the File Name field.

    The default script name is workspace_name_script.sql.

  6. Click Export All to export the scripts to the export script.

    You are prompted to enter the directory where you want to save the export script.

About the Scripts Pane

Description of script_pane.gif follows
Description of the illustration script_pane.gif

In the Scripts pane you can:

About the Scripts to Export Pane

Description of script_export.gif follows
Description of the illustration script_export.gif

In the Scripts to Export pane you can:

Importing Scripts from an Export Script

To import scripts from an export script:

  1. On the Workspace home page, click SQL Workshop and then SQL Scripts.

    The SQL Scripts page appears.

  2. On the Tasks list, click Import.

    The Import Scripts pane appears. See "About the Import Scripts Pane".

  3. Enter the name and path to the export script you want to import to the Script Repository, or click Browse to locate the export script you want to import.

  4. Click Next to list the scripts in the export script.

    The Action column indicates whether the imported script is new, or whether it will replace an existing script of the same name.

  5. Click Import Script(s) to import the listed scripts into the current Script Repository.

    The SQL Scripts page appears listing the imported scripts.

About the Import Scripts Pane

Description of script_import.gif follows
Description of the illustration script_import.gif

In the Import Scripts pane you can:

Viewing Script and Result Quotas

You can view the script limits in the current workspace on the Script Quotas page.

To view the Script Quotas page:

  1. On the Workspace home page, click SQL Workshop and then SQL Scripts.

    The SQL Scripts page appears.

  2. On the Tasks list, click Show Quotas.

    The Script Quotas page appears.

  3. Click OK to return to the SQL Scripts page.

About the Script Quotas Page

The Script Quotas page displays the following limits: