1.2 Installing and Starting SQL Developer

This section contains subsections with instructions for installing SQL Developer on all supported systems.

SQL Developer does not require an installer. To install SQL Developer, you will need an unzip tool. You can download a free, cross-platform unzip tool, Info-Zip, available at http://www.info-zip.org/.

Important:

Do not install SQL Developer into any existing ORACLE_HOME. You will not be able to uninstall it using Oracle Universal Installer.

Also, do not install SQL Developer into an existing sqldeveloper folder or directory. Either delete the existing sqldeveloper folder or directory first, or ensure that the new SQL Developer version is installed into a different location.

Important:

If you are using a prerelease (Early Adopter) version of SQL Developer, and if you want to be able to continue to use this prerelease version after installing the official release kit, you must unzip the official release kit into a different directory than the one used for the prerelease version.

If Oracle Database (Release 11 or later) is also installed, a version of SQL Developer is also included and is accessible through the menu system under Oracle. This version of SQL Developer is separate from any SQL Developer kit that you download and unzip on your own, so do not confuse the two, and do not unzip a kit over the SQL Developer files that are included with Oracle Database. Suggestion: Create a shortcut for the SQL Developer executable file that you install, and always use it to start SQL Developer.

Before you install SQL Developer, look at the remaining sections of this guide to see if you need to know or do anything else first.

The steps for installing SQL Developer depend on whether or not you will be using it on a Windows system that does not have Java SDK (JDK) release 7 or later installed:

For a Windows system with JDK release 7 or later installed, follow the instructions in Section 1.2.1.

For all other systems (Linux and Mac OS X systems, and Windows systems with no JDK release 7 or later installed), follow the instructions in Section 1.2.2.

1.2.1 Windows Systems

If a Windows 64-bit SQL Developer kit that includes JDK 7 is available, you can download and install that on a Windows 64-bit system, and SQL Developer will use the embedded JDK that is provided with that kit.

However, if you need or simply want to use a JDK on your Windows 64-bit system, you can install the JDK (if it is not already installed) and the Windows 32/64-bit SQL Developer kit, and SQL Developer will use the JDK that is installed on your system.

Note:

Do not install SQL Developer into an existing sqldeveloper folder. Either delete the existing sqldeveloper folder first, or ensure that the new SQL Developer version is installed into a different location.

If a Windows 64-bit SQL Developer kit that includes JDK 7 is available, you can download and install that on a Windows 64-bit system, and SQL Developer will use the embedded JDK that is provided with that kit.

However, if you need or simply want to use a JDK on your Windows 64-bit system, you can install the JDK (if it is not already installed) and the Windows 32/64-bit SQL Developer kit, and SQL Developer will use the JDK that is installed on your system.

If you do not need or want to install a suitable Java Development Kit (JDK 7 or later), go to step 3. Otherwise, download and install the JDK as follows:

The installation itself is simple. For example, on a Windows PC you can unzip the downloaded file into C:\, which will create C:\sqldeveloper with files and folders in and under it.

If you are asked to enter the full pathname for the JDK, click Browse and find it. For example, on a Windows system the path might have a name similar to C:\Program Files\Java\jdk1.7.0_51.

Unzip the SQL Developer kit into a folder (directory) of your choice, which will be referred to as <sqldeveloper_install>. Ensure that the Use folder names option is checked when unzipping the kit.

Unzipping the SQL Developer kit causes a folder named sqldeveloper to be created under the <sqldeveloper_install> folder. For example, if you unzip the kit into C:\, the folder C:\sqldeveloper is created, along with several subfolders under it.

To start SQL Developer, go to <sqldeveloper_install>\sqldeveloper, and double-click sqldeveloper.exe.

If you are asked to enter the full pathname for the JDK, click Browse and find java.exe. For example, the path might have a name similar to C:\Program Files\Java\jdk1.7.0_51.

After SQL Developer starts, you can connect to any database by right-clicking the Connections node in the Connections Navigator and selecting New Connection. Alternatively, if you have any exported connections (see Section 1.4 or Section 1.10), you can import these connections and use them.

You can learn about SQL Developer by clicking Help, then Table of Contents, and reading the help topics under SQL Developer Concepts and Usage.

Do not install SQL Developer into an existing sqldeveloper directory. Either delete the existing sqldeveloper directory first, or ensure that the new SQL Developer version is installed into a different location.

Note:

On Macintosh systems, a native Macintosh application in the form sqldeveloperxxx.tar.gz is provided. When it is expanded, it appears as a Macintosh application that can be put into the applications folder. If you choose to expand this file, it will replace any older sqldeveloper applications in that folder.

To install and start SQL Developer, follow these steps:

Unzip the SQL Developer kit into a directory (folder) of your choice. (Ensure that the Use folder names option is checked when unzipping the kit.) This directory location will be referred to as <sqldeveloper_install>.

Unzipping the SQL Developer kit causes a directory named sqldeveloper to be created under the <sqldeveloper_install> directory. It also causes many files and directories to be placed in and under that directory.

To start SQL Developer, go to the sqldeveloper directory under the <sqldeveloper_install> directory, and run sh sqldeveloper.sh.

You can learn about SQL Developer by clicking Help, then Table of Contents, and reading the help topics under SQL Developer Concepts and Usage.

1.3 Migrating User Settings from a Previous Release

The first time you start SQL Developer after installing it or after adding any extensions, you are asked if you want to migrate your user settings from a previous release. (This occurs regardless of whether there was a previous release on your system.)

These settings refer to database connections, reports, and certain SQL Developer user preferences that you set in a previous version by clicking Tools and then Preferences. However, some user preferences are not saved, and you must respecify these using the new release.

To migrate user settings from a previous SQL Developer release:

Unzip the kit for the current release so as to create a new sqldeveloper directory.

When you start the SQL Developer current release, click Yes when asked if you want to migrate settings from a previous release.

In the dialog box that is displayed, you can accept the default option to migrate the settings from the most recent SQL Developer installation. Or, if you want to migrate the settings from an earlier installation, you can click to show all builds and then select the desired one.

1.4 Migrating Information from Previous Releases

If you have used a previous release of SQL Developer, you may want to preserve database connections that you have been using. To preserve database connections, save your existing database connections in an XML file. To save the connections, right-click the Connections node in the Connections Navigator and select Export Connections. After you complete the installation described in this guide, you can use those connections by right-clicking the Connections node in the Connections Navigator and selecting Import Connections

If you want to use any user-defined reports or the SQL history from a previous version, see Section 1.5 for information about where these are located. If you have user-defined reports and SQL history from Release 1.0, they are modified by any later SQL Developer release to a format that is different from and incompatible with Release 1.0.

SQL Developer preferences (specified by clicking Tools and then Preferences) from a prerelease version of the current release cannot currently be saved and reused; you must respecify any desired preferences.

1.5 Location of User-Related Information

SQL Developer stores user-related information in several places, with the specific location depending on the operating system and certain environment specifications. User-related information includes user-defined reports, user-defined snippets, SQL Worksheet history, code templates, and SQL Developer user preferences. In most cases, your user-related information is stored outside the SQL Developer installation directory hierarchy, so that it is preserved if you delete that directory and install a new version.

The user-related information is stored in or under the IDE_USER_DIR environment variable location, if defined; otherwise as indicated in Table 1-4, which shows the typical default locations (under a directory or in a file) for specific types of resources on different operating systems. (Note the period in the name of any directory named .sqldeveloper.)

If you want to prevent other users from accessing your user-specific SQL Developer information, you must ensure that the appropriate permissions are set on the directory where that information is stored or on a directory above it in the path hierarchy. For example, on a Windows system you may want to ensure that the SQL Developer folder and the \<user-name>\Application Data\SQL Developer folder under Documents and Settings are not sharable; and on a Linux or Mac OS X system you may want to ensure that the ~/.sqldeveloper directory is not world-readable.

1.6 Database Certification for SQL Developer (Oracle and Third-Party)

This section describes Oracle and non-Oracle (third-party) databases that are certified for use with SQL Developer.

For any DB2 release: db2jcc.jar and db2jcc_license_cu.jar files required; available from IBM.

Microsoft Access

Access 97

Access 2000

Access XP (2002)

Access 2003

Access 2007

For any Access release: no JDBC driver needed, but you must ensure read access to system tables in the .mdb file.

Microsoft SQL Server

SQL Server 7

SQL Server 2000

SQL Server 2005

SQL Server 2008

For any Microsoft SQL Server release: JDBC driver jtds-1.2.jar required; included in jtds-1.2-dist.zip available from sourceforge.net; also available through Help, Check for Updates.

MySQL

MySQL 3.x

MySQL 4.x

MySQL 5.x

For any MySQL release: JDBC driver required. For MySQL 5.x: mysql-connector-java-5.0.4-bin.jar, which is included in mysql-connector-java-5.0.4.zip; also available through Help, Check for Updates. (Do not use the latest MySQL driver 5.1.)

Sybase Adaptive Server

Sybase 12

Sybase 15

For any Sybase Adaptive Server release: JDBC driver jtds-1.2.jar required; included in jtds-1.2-dist.zip available from sourceforge.net; also available through Help, Check for Updates.

Teradata

Teradata 12

Teradata 13

JDBC driver files tdgssconfig.jar and terajdbc4.jar required; included (along with a readme.txt file) in the TeraJDBC__indep_indep.12.00.00.110.zip or TeraJDBC__indep_indep.12.00.00.110.tar download.

For information about creating and using connections to third-party databases, see the information about database connections in the SQL Developer online help or Oracle SQL Developer User's Guide.

1.7 Advanced Security for JDBC Connection to the Database

You are encouraged to use Oracle Advanced Security to secure a JDBC connection to the database. Both the JDBC OCI and the JDBC Thin drivers support at least some of the Oracle Advanced Security features. If you are using the OCI driver, you can set relevant parameters in the same way that you would in any Oracle client setting. The JDBC Thin driver supports the Oracle Advanced Security features through a set of Java classes included with the JDBC classes in a Java Archive (JAR) file and supports security parameter settings through Java properties objects.

However, if you are using Java J2SE 1.6.0_24 or higher but before Java 7 Update 6, you must manually install Java Access Bridge 2.0.2 after you install the screen reader (if it is not already installed). Download Java Access Bridge for Windows version 2.0.2. The file you will download is accessbridge-2_0_2-fcs-bin-b06.zip. It is available from: http://www.oracle.com/technetwork/java/javase/tech/index-jsp-136191.html (Refer to the Java Access Bridge documentation available from this website for more information about installation and the Java Access Bridge.)

JAWS 12.0.522

Follow these steps to set up a screen reader and Java Access Bridge.

Install the screen reader, if it is not already installed.

Refer to the documentation for your screen reader for more information about installation.

Start SQL Developer by running the file sqldeveloper.exe located in the folder <sqldev_home>\sqldeveloper\sqldev\bin.

The preceding steps assume you are running Windows and using a Windows-based screen reader. A console window that contains error information (if any) will open first and then the main SQL Developer window will appear, after SQL Developer has started. Any messages that appear will not affect the functionality of SQL Developer.

1.9.1 If You Need to Install Java Access Bridge

If you are using Java J2SE 1.6.0_24 or later but before Java 7 Update 6, you must manually install Java Access Bridge 2.0.2 after you install the screen reader (if it is not already installed).

The installer first checks the JDK version for compatibility, then the Available Java virtual machines dialog displays.

Click Search Disks. Then select to search only the drive that contains the SQL Developer build and the JDK version in the program files directory (if it exists).

The search process can take a long time on a large disk with many instances of JDK or SQL Developer, or when searching multiple disks. However, unless you complete an exhaustive search of your disk, Access Bridge will not be optimally configured, and will not be correctly installed to all of the Java VMs on your system. After selecting the disk to search, click Search.

Confirm that you want to install the Java Access Bridge into each of the Java virtual machines displayed in the dialog, by clicking Install in All.

Click OK when you see the Installation Completed message.

Confirm that the following files have been installed in the Winnt\System32 directory (or the equivalent Windows XP or Vista directory), or copy them from <accessbridge_home>\installerfiles because they must be in the system path in order to work with SQL Developer:

JavaAccessBridge.dll
JAWTAccessBridge.dll
WindowsAccessBridge.dll

Note that the system directory is required in the PATH system variable.

Note:

In the remaining steps in this section, if you are using the SQL Developer kit that does not include a JDK (that is, if the kit file name ends in -no-jre-zip), replace <sqldev_home> with <jdev_home>.

Confirm that the following files have been installed in the <sqldev_home>\jdk\jre\lib\ext directory, or copy them from <accessbridge_home>\installerfiles:

access-bridge.jar
jaccess.jar

Note:

For Data Modeler, for this step and any remaining steps in this section that refer to <sqldev_home>, replace <sqldev_home> with <datamodeler_home>.

Confirm that the file accessibility.properties has been installed in the <sqldev_home>\jdk\jre\lib directory, or copy it from <accessbridge_home>\installerfiles.

Start your screen reader.

Start SQL Developer by running the file sqldeveloper.exe located in the folder <sqldev_home>\sqldeveloper\sqldev\bin.

1.10 Uninstalling SQL Developer

Before you uninstall SQL Developer, if you plan to install SQL Developer (the same or an updated version) later, you may want to save your existing database connections; and if so, see Section 1.4 before uninstalling.

To uninstall SQL Developer, remove the entire SQL Developer installation directory (that is, the directory named sqldeveloper and all directories and files under it in the hierarchy).

If you also want to remove all user-specific SQL Developer information, you should also delete the directory under which that information is stored (that is, the SQL Developer user information directory). For the location of this directory, see Section 1.5.

If you have created a shortcut for SQL Developer, and if you do not plan to install SQL Developer into the same location again, you should remove that shortcut or modify the shortcut properties to reflect the new location.

1.11 SQL Developer Documentation

SQL Developer provides user documentation in the Oracle SQL Developer User's Guide and in the online help. To see the help, click the Help menu, or click the Help button or press the F1 key in relevant contexts while you are using SQL Developer.

In addition to the user's guide and installation guide, the following migration-related guides are available: