1. Using Oracle® SQL Developer Web
  2. About Oracle SQL Developer Web

1 About Oracle SQL Developer Web

Oracle SQL Developer Web is a browser-based application that uses ORDS (Oracle REST Data Services) to provide many of the database development and administration features of desktop-based Oracle SQL Developer.

Note:

Some features of Oracle SQL Developer Web are only available if you sign in as a user with the DBA role. For such features, a "restricted availability" statement appears at the start of the feature description; for example:

Availability icon Available only if you signed in as a database user with the DBA role.

The main features include running SQL statements and scripts in the worksheet, exporting data, creating Data Modeler diagrams for existing schemas, and enabling database administrators to monitor the database.

For a complete integrated development environment, see Oracle SQL Developer.

1.1 About the SQL Developer Web User Interface

The SQL Developer Web user interface has three components:

  • The Header at the top

  • The page body, whose content varies depending on which page you are viewing

  • The Status Bar at the bottom

Header

The header contains the selector icon, the main menu, the help icon, and the user drop-down list.

  • Selector Icon

    Click the selector icon selector icon to switch between the Dashboard and the SQL Developer headers and to access the Admin menu.


    Description of selector_options.jpg follows
    Description of the illustration selector_options.jpg

  • Main Menu

    The main menu lists the pages available. The Dashboard is a single page and so has no main menu. The SQL Developer header's main menu has the following tabs:

    • Home: Displays widgets that provide a general overview of the activity and status in SQL Developer Web. See The Home Page.

    • Activity: Provides several pages to view the performance and other characteristics of your database. See The Activity Pages.

    • Worksheet: Enables you to enter and execute SQL and PL/SQL commands. See The Worksheet Page.

    • Data Modeler: Enables you to create diagrams from existing database schemas, generate DDL statements, and create reports. See The Data Modeler Page.

  • Help Icon

    Click the help icon to open the contextual or online help for the page you are viewing.

  • User Drop-Down List

    The user drop-down list shows the database user you are signed in as, and provides the following items when you open it:

    • Preferences: Opens a dialog that lets you set your preferred time zone and user interface language. The languages available are English, German, Spanish, French, Italian, Japanese, Koren, Portuguese, and Chinese.

    • Log: Opens a dialog that shows the list of HTTP calls made during your SQL Developer Web session.

    • About: Opens a dialog providing version information for the database and other components as well as copyright and licensing information.

    • Sign Out: Signs you out of your database session.

Status Bar

The status bar contains icons that link to log files. The three icons (Errors, Warnings, Processes) are filters that have been applied to the log file.

Description of statusbar.png follows
Description of the illustration statusbar.png

Errors, Warnings: Displays an Errors or Warnings dialog, which lists log entries from unsuccessful REST calls or from any other problem in the application.

Processes: Displays a Processes dialog, which logs REST calls that are either finished or ongoing.

Log notification link: Displays a Log dialog, containing log entries of the following types: Errors, Warnings, Processes, SQL History and SQL Result.

1.2 Accessing Oracle SQL Developer Web

Oracle SQL Developer Web is included with Oracle REST Data Services.

To access SQL Developer Web, you must do the following:

  1. Enable SQL Developer Web in Oracle REST Data Services. For more information, see Advanced Installation Using Command-Line Prompts in Oracle REST Data Services Installation, Configuration, and Development Guide.

  2. To use SQL Developer Web, you must sign in as a database user whose schema has been REST-enabled for SQL Developer Web.

    Execute the following code as a database user with the DBA role:

    BEGIN
 ords_admin.enable_schema(
  p_enabled => TRUE,
  p_schema => 'schema-name',
  p_url_mapping_type => 'BASE_PATH',
  p_url_mapping_pattern => 'schema-alias',
  p_auto_rest_auth => TRUE
 );
 commit;
END;

    where:

    • schema-name is the database schema name in all-uppercase.
    • schema-alias is an alias for the schema name that will appear in the URL the user will use to access SQL Developer Web. Oracle recommends that you do not use the schema name itself as a security measure to keep the schema name from being exposed.
    • p_auto_rest_auth specifies that the REST /metadata-catalog/ endpoint requires authorization. REST uses the metadata-catalog to get a list of published services on the schema.

  3. In the SQL Developer Web login page (http://domain name/ords/sql-developer), enter the name of the user and click Next.

    Description of login_page.png follows
    Description of the illustration login_page.png

    You see the URL change to /ords/<Username>. Enter the password, and click Sign in. If the enabled schema has the DBA role, the Dashboard page is displayed. Otherwise, the SQL Developer Home page is displayed.

    When you log out, you return to the login page (http://domain name/ords/sql-developer) and are prompted for the user name again.

To go to the SQL Developer Web Home page from the Dashboard, click the Selector icon Selectorat the top left of the screen, and then click SQL Developer. Alternatively, you can directly access the SQL Developer Web features by clicking the relevant icon in the Dashboard Quick Links box.