README.md

plscope-utils - SQL Developer Extension (plscope-utils for SQL Developer)

Introduction

plscope-utils simplifies common source code analysis tasks. This SQL Developer extension is based on PL/Scope and provides:

• A PL/Scope node in the Connections window.
• A Compile with PL/Scope context menu on the Connection and PL/Scope node.
• Detail viewers for tables, views, packages, procedures, functions, triggers, types and synonyms. These viewers are reachable via the appropriate nodes in the Connection window or via Popup Describe context menu when positioned on an identifier within a PL/SQL editor.
• A plscope-utils Reports folder within the Reports window.

All operations are based on objects available within an Oracle Database Server instance version 11.1 or higher. No database objects need to be installed for this extension. However, the majority of the queries require the all_statements view which is available since the Oracle Database version 12.2.

Examples

Compile with PL/Scope

Right click on the Connection or PL/Scope node in the Connection window to show the Compile with PL/Scope popup window.

The popup windows provides all relevant options for the Oracle Database version 12.2. However, if you are connected to an older version, just the applicable options are applied.

Viewers PL/Scope Node

The following screenshots show the available viewers for objects within the PL/Scope node. Every viewer has a column named Link. Click on this link to open the PL/SQL editor at the corresponding cursor position.

Identifiers

Statements

Uses

Used by

Table Usages

Column Usages

Reports

In the Reports window you find the plscope-utils Reports folder.

The following screenshots show an example for every report.

CRUD Operations

Duplicate SQL Statements

PL/SQL Naming Conventions

UDF Calls in SQL Statements

Unused Local Identifiers

Prerequisites

• Oracle Database 11.1 or higher
• Oracle SQL Developer 4.0 or higher

How to Build

1. Download and install SQL Developer 17.2.0

2. Download and install Apache Maven 3.5.0

3. Download and install a git command line client

4. Clone the plscope-utils repository

5. Open a terminal window in the plscope-utils root folder and type

    cd sqldev
   

6. Run maven build by the following command

    mvn -Dsqldev.basedir=/Applications/SQLDeveloper17.2.0.app/Contents/Resources/sqldeveloper clean package
   

   Amend the parameter sqldev.basedir to match the path of your SQL Developer installation. This folder is used to reference Oracle jar files which are not available in public Maven repositories

7. The resulting file plscope-utils_for_SQLDev_x.x.x-SNAPSHOT.zip in the target directory may be installed within SQL Developer

Installation

Via Update Center

1. Start SQL Developer

2. Select Check for Updates… in the help menu.

3. Press Add… to register the salvis.com update site http://update.salvis.com/.

4. Use the Search Update Center option and select the salvis.com update center to install the lastest version of plscope-utils for SQL Developer.

If you have troubles to configure the proxy settings, because your company requires some additional authentication or similar, then I suggest to download plscope-utils for SQL Developer from here and use the Install From Local File option as described below.

From file

1. Start SQL Developer

2. Select Check for Updates… in the help menu.

3. Use the Install From Local File option to install the previously downloaded plscope-utils_for_SQLDev_*.zip file.

License

plscope-utils is licensed under the Apache License, Version 2.0. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.