| <html> |
| <!-- |
| |
| NO NO NO NO NO! |
| |
| ==============> DO NOT EDIT ME! <============== |
| |
| AUTOMATICALLY GENERATED FROM APICHANGES.XML, DO NOT EDIT |
| |
| SEE CHANGEME/apichanges.xml |
| |
| --> |
| |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| |
| <title>Change History for the Database Explorer API</title> |
| |
| <link rel="stylesheet" href="prose.css" type="text/css"> |
| |
| </head> |
| |
| <body> |
| |
| |
| <p class="overviewlink"> |
| <a href="overview-summary.html" shape="rect">Overview</a> |
| </p> |
| |
| |
| <h1>Introduction</h1> |
| |
| |
| <p>This document lists changes made to the Database Explorer API/SPI.</p> |
| |
| <!-- The actual lists of changes, as summaries and details: --> |
| |
| |
| <hr> |
| <h1> |
| <a name="list-all-apis">Index of APIs</a> |
| </h1> |
| <ul> |
| <li> |
| <a href="#database_explorer_api">Database Explorer API</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="incompat-by-date">Incompatible changes by date</a> |
| </h1> |
| <p>Fuller descriptions of all changes can be found below (follow links).</p> |
| <p>Not all deprecations are listed here, assuming that the deprecated |
| APIs continue to essentially work. For a full deprecation list, please |
| consult the |
| <a href="deprecated-list.html">Javadoc</a>.</p> |
| <ul></ul> |
| <h1> |
| <a name="all-by-date">All changes by date</a> |
| </h1> |
| <ul> |
| <li>(Jun 10 '13) <a href="#issue-231030"> |
| Configure usage of scrollable cursors. |
| </a> |
| </li> |
| <li>(Feb 13 '13) <a href="#issue-197408"> |
| Enable editting of connection properties for db connections |
| </a> |
| </li> |
| <li>(Nov 22 '10) <a href="#issue-192150">Allow specify display name of the DatabaseConnection</a> |
| </li> |
| <li>(May 6 '09) <a href="#issue-90210">Add a DatabaseConnection.getJDBCDriver() method</a> |
| </li> |
| <li>(Aug 27 '08) <a href="#issue-143837">Add ability to ensure a JDBC connection is valid</a> |
| </li> |
| <li>(Aug 15 '08) <a href="#issue-143441">Add support for always quoting and for unquoting SQL identifiers.</a> |
| </li> |
| <li>(Jun 27 '08) <a href="#issue-134309">Add ability to get the underlying JDBC Driver instance for a JDBCDriver</a> |
| </li> |
| <li>(Jun 27 '08) <a href="#issue-129633">Add ability to show the Add JDBC Driver dialog synchronously</a> |
| </li> |
| <li>(Jun 26 '08) <a href="#issue-128546">Add ability to connect a database connection directly with no UI</a> |
| </li> |
| <li>(Feb 26 '08) <a href="#issue-128502">Add ability to remove a database connection</a> |
| </li> |
| <li>(Nov 1 '07) <a href="#issue-120097">Made Database Explorer API stable</a> |
| </li> |
| <li>(Oct 5 '07) <a href="#issue-87600">Allow user to save password</a> |
| </li> |
| <li>(Sep 12 '07) <a href="#issue-115075">Added utility class for working with SQL identifiers</a> |
| </li> |
| <li>(Jun 17 '07) <a href="#issue-96200">Added support for dragging and dropping nodes from the Database Explorer</a> |
| </li> |
| <li>(Jul 20 '06) <a href="#issue-80629">Addded a method to open the NewConnectionDialog with an user and password pre-filled and methods which open the NewConnectionDialog and return the newly added database connection</a> |
| </li> |
| <li>(Mar 17 '06) <a href="#issue-73713">Addded an utility method to fill a combo box with database connections</a> |
| </li> |
| <li>(Sep 12 '05) <a href="#version-1.13">Initial version released</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-version">Changes by version</a> |
| </h1> |
| <p> |
| These API specification versions may be used to indicate that a module |
| requires a certain API feature in order to function. For example, if you |
| see here a feature you need which is labelled <samp>1.20</samp>, your |
| manifest should contain in its main attributes the line: |
| </p> |
| <pre>OpenIDE-Module-Module-Dependencies: org.netbeans.api.db.explorer > 1.20</pre> |
| <ul> |
| <li> |
| (1.57) <a href="#issue-231030"> |
| Configure usage of scrollable cursors. |
| </a> |
| </li> |
| <li> |
| (1.53) <a href="#issue-197408"> |
| Enable editting of connection properties for db connections |
| </a> |
| </li> |
| <li> |
| (1.42) <a href="#issue-192150">Allow specify display name of the DatabaseConnection</a> |
| </li> |
| <li> |
| (1.32) <a href="#issue-90210">Add a DatabaseConnection.getJDBCDriver() method</a> |
| </li> |
| <li> |
| (1.30) <a href="#issue-143837">Add ability to ensure a JDBC connection is valid</a> |
| </li> |
| <li> |
| (1.29) <a href="#issue-143441">Add support for always quoting and for unquoting SQL identifiers.</a> |
| </li> |
| <li> |
| (1.28) <a href="#issue-134309">Add ability to get the underlying JDBC Driver instance for a JDBCDriver</a> |
| </li> |
| <li> |
| (1.27) <a href="#issue-129633">Add ability to show the Add JDBC Driver dialog synchronously</a> |
| </li> |
| <li> |
| (1.26) <a href="#issue-128546">Add ability to connect a database connection directly with no UI</a> |
| </li> |
| <li> |
| (1.25) <a href="#issue-128502">Add ability to remove a database connection</a> |
| </li> |
| <li> |
| (1.24) <a href="#issue-120097">Made Database Explorer API stable</a> |
| </li> |
| <li> |
| (1.23) <a href="#issue-87600">Allow user to save password</a> |
| </li> |
| <li> |
| (1.22) <a href="#issue-115075">Added utility class for working with SQL identifiers</a> |
| </li> |
| <li> |
| (1.21) <a href="#issue-96200">Added support for dragging and dropping nodes from the Database Explorer</a> |
| </li> |
| <li> |
| (1.19) <a href="#issue-80629">Addded a method to open the NewConnectionDialog with an user and password pre-filled and methods which open the NewConnectionDialog and return the newly added database connection</a> |
| </li> |
| <li> |
| (1.18) <a href="#issue-73713">Addded an utility method to fill a combo box with database connections</a> |
| </li> |
| <li> |
| (1.13) <a href="#version-1.13">Initial version released</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-class">Changes by affected class</a> |
| </h1> |
| <h2> |
| <a name="org.netbeans.api.db.explorer.ConnectionManager"><code><span style="color:gray">org.netbeans.api.db.explorer.</span>ConnectionManager</code></a> |
| </h2><ul><li>(Jun 26 '08) <a href="#issue-128546">Add ability to connect a database connection directly with no UI</a> |
| </li> |
| <li>(Feb 26 '08) <a href="#issue-128502">Add ability to remove a database connection</a> |
| </li> |
| <li>(Jul 20 '06) <a href="#issue-80629">Addded a method to open the NewConnectionDialog with an user and password pre-filled and methods which open the NewConnectionDialog and return the newly added database connection</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.db.explorer.DatabaseConnection"><code><span style="color:gray">org.netbeans.api.db.explorer.</span>DatabaseConnection</code></a> |
| </h2><ul><li>(Jun 10 '13) <a href="#issue-231030"> |
| Configure usage of scrollable cursors. |
| </a> |
| </li> |
| <li>(Feb 13 '13) <a href="#issue-197408"> |
| Enable editting of connection properties for db connections |
| </a> |
| </li> |
| <li>(Nov 22 '10) <a href="#issue-192150">Allow specify display name of the DatabaseConnection</a> |
| </li> |
| <li>(May 6 '09) <a href="#issue-90210">Add a DatabaseConnection.getJDBCDriver() method</a> |
| </li> |
| <li>(Aug 27 '08) <a href="#issue-143837">Add ability to ensure a JDBC connection is valid</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.db.explorer.support.DatabaseExplorerUIs"><code><span style="color:gray">org.netbeans.api.db.explorer.support.</span>DatabaseExplorerUIs</code></a> |
| </h2><ul><li>(Mar 17 '06) <a href="#issue-73713">Addded an utility method to fill a combo box with database connections</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.db.explorer.DatabaseMetaDataTransfer"><code><span style="color:gray">org.netbeans.api.db.explorer.</span>DatabaseMetaDataTransfer</code></a> |
| </h2><ul><li>(Jun 17 '07) <a href="#issue-96200">Added support for dragging and dropping nodes from the Database Explorer</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.db.explorer.JDBCDriver"><code><span style="color:gray">org.netbeans.api.db.explorer.</span>JDBCDriver</code></a> |
| </h2><ul><li>(Jun 27 '08) <a href="#issue-134309">Add ability to get the underlying JDBC Driver instance for a JDBCDriver</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.db.explorer.JDBCDriverManager"><code><span style="color:gray">org.netbeans.api.db.explorer.</span>JDBCDriverManager</code></a> |
| </h2><ul><li>(Jun 27 '08) <a href="#issue-129633">Add ability to show the Add JDBC Driver dialog synchronously</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.db.sql.support.SQLIdentifiers"><code><span style="color:gray">org.netbeans.api.db.sql.support.</span>SQLIdentifiers</code></a> |
| </h2><ul><li>(Aug 15 '08) <a href="#issue-143441">Add support for always quoting and for unquoting SQL identifiers.</a> |
| </li> |
| <li>(Sep 12 '07) <a href="#issue-115075">Added utility class for working with SQL identifiers</a> |
| </li></ul><hr> |
| <h1> |
| <a name="details-by-api">Details of all changes by API and date</a> |
| </h1> |
| <hr style="width:50%"> |
| <h2> |
| <a name="database_explorer_api">Database Explorer API</a> |
| </h2> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="issue-231030"> |
| Configure usage of scrollable cursors. |
| </a> |
| </h3> |
| <em>Jun 10 '13; API spec. version: 1.57; affected top-level classes: <a href="./org/netbeans/api/db/explorer/DatabaseConnection.html"><code>DatabaseConnection</code></a>; made by: jhavlin; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=231030"> |
| #231030</a></em> |
| <br> |
| Users can enable or disable using of scrollable cursors, which |
| can make queries faster, but also can cause problems for some |
| drivers. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-197408"> |
| Enable editting of connection properties for db connections |
| </a> |
| </h3> |
| <em>Feb 13 '13; API spec. version: 1.53; affected top-level classes: <a href="./org/netbeans/api/db/explorer/DatabaseConnection.html"><code>DatabaseConnection</code></a>; made by: matthias42; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=197408"> |
| #197408</a></em> |
| <br> |
| Users can specify connection properties in the UI now. |
| The properties can be retrieved using new method |
| DatabaseConnection.getConnectionProperties(). There is also a |
| new factory method DatabaseConnection.create() that accepts an |
| object with additional connection properties. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-192150">Allow specify display name of the DatabaseConnection</a> |
| </h3> |
| <em>Nov 22 '10; API spec. version: 1.42; affected top-level classes: <a href="./org/netbeans/api/db/explorer/DatabaseConnection.html"><code>DatabaseConnection</code></a>; made by: jrechtacek; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=192150"> |
| #192150</a></em> |
| <br> |
| Allow to specify the display name of the connection as it shows |
| under the Databases node. Added new factory method to create |
| database connection with given display name. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-90210">Add a DatabaseConnection.getJDBCDriver() method</a> |
| </h3> |
| <em>May 6 '09; API spec. version: 1.32; affected top-level classes: <a href="./org/netbeans/api/db/explorer/DatabaseConnection.html"><code>DatabaseConnection</code></a>; made by: jrechtacek; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=90210"> |
| #90210</a></em> |
| <br> |
| Currently there is no easy way to get the JDBCDriver instance that a |
| DatabaseConnection will use / used to connect to a database. A |
| <code>DatabaseConnection.getJDBCDriver()</code> method should be added. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-143837">Add ability to ensure a JDBC connection is valid</a> |
| </h3> |
| <em>Aug 27 '08; API spec. version: 1.30; affected top-level classes: <a href="./org/netbeans/api/db/explorer/DatabaseConnection.html"><code>DatabaseConnection</code></a>; made by: davidvc; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=143837"> |
| #143837</a></em> |
| <br> |
| This change allows you to ensure that the physical database connection |
| obtained from a DatabaseConnection is valid or is null . |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-143441">Add support for always quoting and for unquoting SQL identifiers.</a> |
| </h3> |
| <em>Aug 15 '08; API spec. version: 1.29; affected top-level classes: <a href="./org/netbeans/api/db/sql/support/SQLIdentifiers.html"><code>SQLIdentifiers</code></a>; made by: abadea; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=143441"> |
| #143441</a></em> |
| <br> |
| Add support for always quoting and for unquoting SQL identifiers. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-134309">Add ability to get the underlying JDBC Driver instance for a JDBCDriver</a> |
| </h3> |
| <em>Jun 27 '08; API spec. version: 1.28; affected top-level classes: <a href="./org/netbeans/api/db/explorer/JDBCDriver.html"><code>JDBCDriver</code></a>; made by: davidvc; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=134309"> |
| #134309</a></em> |
| <br> |
| This change makes it possible to get the underlying Driver class. Without |
| this, the only way you can obtain the driver is to create your own classloader that |
| has the driver classpath URLs in its search list and then load the driver. |
| This makes things much easier. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-129633">Add ability to show the Add JDBC Driver dialog synchronously</a> |
| </h3> |
| <em>Jun 27 '08; API spec. version: 1.27; affected top-level classes: <a href="./org/netbeans/api/db/explorer/JDBCDriverManager.html"><code>JDBCDriverManager</code></a>; made by: davidvc; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=129633"> |
| #129633</a></em> |
| <br> |
| Add the ability to show the Add Driver dialog synchronously. This |
| must be run on the AWT event thread, but it returns the <code>JDBCDriver</code> that was added. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-128546">Add ability to connect a database connection directly with no UI</a> |
| </h3> |
| <em>Jun 26 '08; API spec. version: 1.26; affected top-level classes: <a href="./org/netbeans/api/db/explorer/ConnectionManager.html"><code>ConnectionManager</code></a>; made by: davidvc; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=128546"> |
| #128546</a></em> |
| <br> |
| Add the ability to connect a database connection directly from the API |
| without having any kind of UI pop up, be it a dialog or a progress window. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-128502">Add ability to remove a database connection</a> |
| </h3> |
| <em>Feb 26 '08; API spec. version: 1.25; affected top-level classes: <a href="./org/netbeans/api/db/explorer/ConnectionManager.html"><code>ConnectionManager</code></a>; made by: davidvc; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=128502"> |
| #128502</a></em> |
| <br> |
| Add the ability to remove a database connection from the Database |
| Explorer connection list. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-120097">Made Database Explorer API stable</a> |
| </h3> |
| <em>Nov 1 '07; API spec. version: 1.24; made by: abadea; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=120097"> |
| #120097</a></em> |
| <br> |
| The stability level of the Database Explorer API is changed to stable. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-87600">Allow user to save password</a> |
| </h3> |
| <em>Oct 5 '07; API spec. version: 1.23; made by: davidvc; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=87600"> |
| #87600</a></em> |
| <br> |
| This change updated the connection DTD to 1.1, adding a password |
| element. In the Database Explorer implementation, we allow the |
| user to indicate they want to save the password. This works across |
| invocations of the VM. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-115075">Added utility class for working with SQL identifiers</a> |
| </h3> |
| <em>Sep 12 '07; API spec. version: 1.22; affected top-level classes: <a href="./org/netbeans/api/db/sql/support/SQLIdentifiers.html"><code>SQLIdentifiers</code></a>; made by: davidvc; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=115075"> |
| #115075</a></em> |
| <br> |
| This change adds a <code>SQLIdentifiers.Quoter</code> class which |
| provides a utility method for quoting SQL identifiers. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-96200">Added support for dragging and dropping nodes from the Database Explorer</a> |
| </h3> |
| <em>Jun 17 '07; API spec. version: 1.21; affected top-level classes: <a href="./org/netbeans/api/db/explorer/DatabaseMetaDataTransfer.html"><code>DatabaseMetaDataTransfer</code></a>; made by: abadea; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=96200"> |
| #96200</a></em> |
| <br> |
| This change adds a <code>DatabaseMetaDataTransfer</code> class which |
| contains <code>DataFlavor</code>s for database objects and nested classes |
| representing those database objects during a drag and drop transfer. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-80629">Addded a method to open the NewConnectionDialog with an user and password pre-filled and methods which open the NewConnectionDialog and return the newly added database connection</a> |
| </h3> |
| <em>Jul 20 '06; API spec. version: 1.19; affected top-level classes: <a href="./org/netbeans/api/db/explorer/ConnectionManager.html"><code>ConnectionManager</code></a>; made by: abadea; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=80629"> |
| #80629</a></em> |
| <br> |
| This change adds a <code>showAddConnectionDialog</code> which opens the |
| New Connection Dialog while pre-filling a specified database user and password. |
| It also adds <code>showAddConnectionDialogFromEventThread</code> methods |
| which are counterparts to the <code>showAddConnectionDialog</code> methods, |
| with the difference that they return the newly added database connection, |
| but must be called from the event dispatching thread. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="issue-73713">Addded an utility method to fill a combo box with database connections</a> |
| </h3> |
| <em>Mar 17 '06; API spec. version: 1.18; affected top-level classes: <a href="./org/netbeans/api/db/explorer/support/DatabaseExplorerUIs.html"><code>DatabaseExplorerUIs</code></a>; made by: abadea; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=73713"> |
| #73713</a></em> |
| <br> |
| This change adds the <code>DatabaseExplorerUIs.connect()</code> |
| method, which populates a <code>JComboBox</code> with the list of connections |
| from a <code>ConnectionManager</code>. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="version-1.13">Initial version released</a> |
| </h3> |
| <em>Sep 12 '05; API spec. version: 1.13; made by: abadea</em> |
| <br> |
| First initial release of the Database Explorer API. |
| |
| |
| <hr> |
| <p><span class="footnote">Built on September 14 2018. | Copyright © 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p> |
| |
| |
| </body> |
| |
| </html> |
