Skip to content

Example-based tutorials to extend SQL Developer functionality.

License

Notifications You must be signed in to change notification settings

PhilippSalvisberg/sqldev

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sqldev

Example-based tutorials to extend SQL Developer functionality.

Tutorials

How to set up SQL Developer and Eclipse for these tutorials.

Pure XML Extensions

SQL Developer allows users to write custom reports, editors, navigators and actions as XML files and include them in the preferences dialog under User Defined Extension.

Create a report within SQL Developer and share it as XML extension.

Report

Show details for a selected node in the Connections window. This is called an editor. Technically it's just a report.

Editor

Create a new node with children and grandchildren int the Connections navigator tree.

Navigator

Add two editors for some nodes of the previously created navigator.

Editor

Create a context menu item and a dialog to enter some parameters for an action to be performed. The action is implemented as an anonymous PL/SQL block.

Action

Create the same context menu item and dialog as in the previous example. In this case the action is implemented in JavaScript instead of PL/SQL.

Beside accessing the database you may access also Java classes thanks to the Nashorn script engine. Hence you may access the local file system and the network. And of course you may produce additional GUI components.

JavaScript (Nashorn)

Basic Extensions (XML)

SQL Developer extensions are ZIP files in a specific format. The format is defined in the JDeveloper's Extension Software Development Kit (ESDK) version 2.0.

These tutorials bundle the previously created XML extensions into a single extension (ZIP file). The Java code is reduced to a single file to handle custom resources, e.g. icons. The final ZIP file is built by Maven.

Create an extension (ZIP file) including all previously created XML extensions.

Report Navigator Action

Support an additional language (German) beside English in the previously created extension.

Report Navigator Action

Full-blown Extensions (XML & Java)

XML Extensions have limitations. Even if JavaScript Actions are used. To get the most out of the ESDK, more XML configuration and Java code is required.

Extend every menu in the main menubar and create a custom menu.

Custom menu

Extend the main toolbar. Inspect variables with the debugger and hot deploy code changes.

Toolbar

Extend the context menu in the navigator node and PL/SQL editor. Access connection properties such as username and password.

Action via Context Menu

Add a preference dialog to the previously created extension. Add conditional processing based on the current preference settings, e.g. to show or to hide the password of a connection.

Preferences

Show a new dockable window via main menu action.

Dockable Window

Extend the context menu of any grid table (query results, reports, editors, etc.) in SQL Developer.

Action via Context Menu of Grid Table

Documentation

In this Repository

External Links