diff --git a/sqldeveloper/extension/ManagingExtensions.md b/sqldeveloper/extension/ManagingExtensions.md new file mode 100644 index 00000000..03a5b0c8 --- /dev/null +++ b/sqldeveloper/extension/ManagingExtensions.md @@ -0,0 +1,54 @@ +# [SQL Developer](http://www.oracle.com/technetwork/developer-tools/sql-developer/) Examples + +## Managing Extensions + * [Getting Extensions](#getting-extensions) + * [Download Centers](#download-centers) + * [Adding an Update Center](#adding-an-update-center) + * [Using an Update Center](#using-an-update-center) + * [Using a Check for Updates bundle](#using-a-check-for-updates-bundle) + * [Build your own](#build-your-own) + * [Enabling and Disabling Extensions](#enabling-and-disabling-extensions) + * [Removing or Rolling Back Extensions](#removing-or-rolling-back-extensions) + + +### Getting Extensions +#### Download Centers +Navigate to Help->Check for Updates. +![Select update source image](images/ME-CFU-Check-1.png) + +##### Adding an Update Center +If you need to add a reference to an update center, press the Add button to enter the name and location. If the new update center is web based, enter the URL. If it is file system based, enter the path or use the browse button. There is an external _(not supported by Oracle)_ [example update center](https://github.com/bjeffrie/sqldev-update-center) for these extensions. You can add https://raw.githubusercontent.com/bjeffrie/sqldev-update-center/master/update-center.xml as an update center location to access it. +![Add update center dialog image](images/ME-CFU-Add-1.png) + +##### Using an Update Center +Check the update centers you want to search and hit Next. You will be presented with a list of updates available for your version of SQL Developer from the selected update centers. Clicking on an entry shows information about the extension in the right panel. Select the extensions you want to add/update. + +![Select updates to install image](images/ME-CFU-Add-2.png) +Press Next. +![Select updates to install Summary page image](images/ME-CFU-Add-3+4.png) +Press Finish. If there are any licenses required, you will be asked to accept them. SQL Developer will ask you if it can restart. +![Check for Updates restart dialog image](images/ME-CFU-Restart.png) + +#### Using a Check for Updates bundle +A Check for Updates (CFU) bundle is a zip file with the extension and metadata about it. Select Install from Local File(s), and enter the path or use the Browse button. _(The [Example Update Center](https://github.com/bjeffrie/sqldev-update-center) (external) has pre-built cfu bundles for these examples.)_ + +![Select update source install from local file image](images/ME-CFU-Local-1.png) +Press Next. +![Select update source install from local file Summary page image](images/ME-CFU-Local-2.png) +Press Finish. If there are any licenses required, you will be asked to accept them. SQL Developer will ask you if it can restart. +![Check for Updates restart dialog image](images/ME-CFU-Restart.png) + +#### Build your own +See the [Set Up / Tutorial](./setup.md) - A step by step guide to building your first extension and check for updates bundle. See the extension [read me](./README.md) for other example extensions. + +### Enabling and Disabling Extensions +__Note:__ _The About Oracle SQL Developer dialog has an Extensions tab that displays the load status. Newly installed extensions are typically in "Triggers Loaded" state which means SQL Developer 'knows' about the extension, but has not "Fully Loaded" it yet. Loading is (generally) triggered by either choosing a menu action provided by the extension or visiting its preference page (if any). Once fully loaded, most extensions will fully load on subsequent sessions._ + +Navigate to Tools->Features... +![Manage Features and Updates dialog Features tab image](images/ME-MFU-Features.png) +If the extension allows it, you can use the check boxes to toggle extensions on and off from this page. There will be a pop-up progress dialog while the extension loading information is updated. + +### Removing or Rolling Back Extensions +Navigate to Tools->Features... and select the Installed Updates tab. +![Manage Features and Updates dialog Installed Updates tab image](images/ME-MFU-Installed-Updates.png) +From this panel, you can uninstall or roll back updates by selecting the desired entries and pressing Uninstall. diff --git a/sqldeveloper/extension/README.md b/sqldeveloper/extension/README.md index 32fef09c..4b3fac78 100644 --- a/sqldeveloper/extension/README.md +++ b/sqldeveloper/extension/README.md @@ -6,6 +6,8 @@ Depending on requirements, this can be done in either XML or java and deployed b ### New +* [Managing Extensions](./ManagingExtensions.md) - ([Issue 113](https://github.com/oracle/oracle-db-examples/issues/113)) How to add, disable, and remove extensions. + * [ConnectionHelper](java/ConnectionHelper) Optionally accept connection info from the command line and/or on a [SocketServer](https://docs.oracle.com/javase/tutorial/networking/sockets/clientServer.html) @@ -20,6 +22,9 @@ A simple command line client for the ConnectionHelper socket server. * [Set Up / Tutorial](./setup.md) - A step by step guide to building your first extension and check for updates bundle. +* [Managing Extensions](./ManagingExtensions.md) - How to add, disable, and remove extensions. + + * ["Simple" User Extensions (XML)](xml) diff --git a/sqldeveloper/extension/build.properties b/sqldeveloper/extension/build.properties index 1f7d141a..b35d2f9f 100644 --- a/sqldeveloper/extension/build.properties +++ b/sqldeveloper/extension/build.properties @@ -17,5 +17,5 @@ extension.owner.url=https://github.com/oracle/oracle-db-examples/tree/master/sql # # Base location of the CFU site. # This is where the produced updates.xml will say the cfu bundle files are. -update.url=https://gitcdn.xyz/repo/bjeffrie/sqldev-update-center/master +update.url=https://raw.githubusercontent.com/bjeffrie/sqldev-update-center/master diff --git a/sqldeveloper/extension/images/ME-CFU-About-Extensions.png b/sqldeveloper/extension/images/ME-CFU-About-Extensions.png new file mode 100644 index 00000000..42d50b0a Binary files /dev/null and b/sqldeveloper/extension/images/ME-CFU-About-Extensions.png differ diff --git a/sqldeveloper/extension/images/ME-CFU-Add-0-Dialog.png b/sqldeveloper/extension/images/ME-CFU-Add-0-Dialog.png new file mode 100644 index 00000000..ed83ca9d Binary files /dev/null and b/sqldeveloper/extension/images/ME-CFU-Add-0-Dialog.png differ diff --git a/sqldeveloper/extension/images/ME-CFU-Add-1.png b/sqldeveloper/extension/images/ME-CFU-Add-1.png new file mode 100644 index 00000000..9f506138 Binary files /dev/null and b/sqldeveloper/extension/images/ME-CFU-Add-1.png differ diff --git a/sqldeveloper/extension/images/ME-CFU-Add-2.png b/sqldeveloper/extension/images/ME-CFU-Add-2.png new file mode 100644 index 00000000..1f20aa23 Binary files /dev/null and b/sqldeveloper/extension/images/ME-CFU-Add-2.png differ diff --git a/sqldeveloper/extension/images/ME-CFU-Add-3+4.png b/sqldeveloper/extension/images/ME-CFU-Add-3+4.png new file mode 100644 index 00000000..0b8848da Binary files /dev/null and b/sqldeveloper/extension/images/ME-CFU-Add-3+4.png differ diff --git a/sqldeveloper/extension/images/ME-CFU-Check-1.png b/sqldeveloper/extension/images/ME-CFU-Check-1.png new file mode 100644 index 00000000..578b43f6 Binary files /dev/null and b/sqldeveloper/extension/images/ME-CFU-Check-1.png differ diff --git a/sqldeveloper/extension/images/ME-CFU-Local-1.png b/sqldeveloper/extension/images/ME-CFU-Local-1.png new file mode 100644 index 00000000..a83d47e6 Binary files /dev/null and b/sqldeveloper/extension/images/ME-CFU-Local-1.png differ diff --git a/sqldeveloper/extension/images/ME-CFU-Local-2.png b/sqldeveloper/extension/images/ME-CFU-Local-2.png new file mode 100644 index 00000000..fff39902 Binary files /dev/null and b/sqldeveloper/extension/images/ME-CFU-Local-2.png differ diff --git a/sqldeveloper/extension/images/ME-CFU-Restart.png b/sqldeveloper/extension/images/ME-CFU-Restart.png new file mode 100644 index 00000000..072fc4bc Binary files /dev/null and b/sqldeveloper/extension/images/ME-CFU-Restart.png differ diff --git a/sqldeveloper/extension/images/ME-MFU-Features.png b/sqldeveloper/extension/images/ME-MFU-Features.png new file mode 100644 index 00000000..dd26cb30 Binary files /dev/null and b/sqldeveloper/extension/images/ME-MFU-Features.png differ diff --git a/sqldeveloper/extension/images/ME-MFU-Installed-Updates.png b/sqldeveloper/extension/images/ME-MFU-Installed-Updates.png new file mode 100644 index 00000000..eca7b927 Binary files /dev/null and b/sqldeveloper/extension/images/ME-MFU-Installed-Updates.png differ