Data Tools Platform Connectivity

Data Tools Platform Connectivity
Data Tools Platform Connectivity
ekapner
Contents
Data Source Explorer View....................................................................................4
Setting Connectivity Preferences.........................................................................5
Database Connection Profile Preferences...............................................................................5
Driver Definitions......................................................................................................................5
Label Decorations Preferences................................................................................................6
Creating a Database Connection Profile..............................................................7
Refreshing a Connection Profile...............................................................................................7
Renaming a Connection Profile................................................................................................8
Deleting a Connection Profile...................................................................................................8
Testing a Connection Profile.....................................................................................................8
Importing a Connection Profile.................................................................................................9
Exporting a Connection Profile.................................................................................................9
Editing Connection Profile Properties......................................................................................9
Connection Profile Common Properties......................................................................10
Connection Profile Default Schema Filter Properties..................................................10
Connection Profile Default Stored Procedure Filter Properties...................................10
Connection Profile Default Table Filter Properties.......................................................10
Connection Profile JDBC Connection Properties........................................................11
Connection Profile Derby JDBC Connection Properties..............................................12
Connection Profile Version Properties.........................................................................12
Console Editor Application..........................................................................................13
Creating a Driver Definition.................................................................................14
Editing a Driver Definition.......................................................................................................14
Data Tools Platform Connectivity
iii
Data Source Explorer View
Data Source Explorer View
The Data Source Explorer contains connection profile instances.
The Data Source Explorer provides a list of configured connection profiles. If categories are enabled, you
can see the list grouped into categories, for example, Databases and ODA Data Sources. Use the Data
Source Explorer to connect to, navigate, and interact with resources associated with the selected connection
profile. It also provides import and export capabilities to share connection profile definitions with other Eclipse
Workbenches.
4
Setting Connectivity Preferences
Setting Connectivity Preferences
Set preferences for how nodes get displayed for Open Data Access, connection profiles and driver definitions.
1. Select Window > Preferences from the main menu.
2. Expand Data Management > Connectivity and select Open Data Access, Database Connection
Profile or Driver Definitions.
Database Connection Profile Preferences
Determines how connection profile information displays: grouped by schema or listed alphabetically with
database object owner in parentheses next to the object name.
By default, database objects display in alphabetical order and indicate the owner name in parentheses. For
more refined control, you can set these options through Data Source Explorer for an entire connection profile
or for an individual database. However, if you change the preference settings, they override the connection
profile and database settings and set all objects to display according to the option(s) you select in this tab.
Subgroup preferences also dictate how database objects appear by indicating how database objects are
organized into folders.
Option
Description
Show Schema
Groups database objects under each schema name.
Show Database Object Owner
Displays database objects alphabetically with the owner
name next to them, for example, Contacts (GROUPO).
Driver Definitions
Add, edit, or delete driver definitions for a specific database server. Connection profiles use driver definitions
to establish database connections.
Driver details can include driver classes, URL, and JAR locations, but this is dependent on the requirements
of each driver. You can define driver definitions before you create connection profiles, or when you create or
edit a connection profile that requires a driver definition.
Table 1. Driver Definitions page
Option
Description
Vendor Filter
Select a specific database vendor to just list the drivers for
that vendor.
Driver Definitions list
Lists existing driver definitions.
Add
Create a new driver definition.
Edit
Edit the selected driver definition.
Remove
Remove the selected driver definition.
Copy
Copy the selected driver definition. If you want to change
the copy's name from the default, edit the driver definition.
Data Tools Platform Connectivity
5
Setting Connectivity Preferences
Table 2. New/Edit Driver Definition Name/Type tab
Option
Description
Vendor Filter (New only)
Select a specific database vendor to just list the driver
templates for that vendor.
Available Driver Templates (New only)
Select a driver that corresponds with your database server.
Driver Name
(Optional) Modify the default or existing name, which is
based on the driver definition name.
Driver Type
Displays the driver type.
Table 3. New/Edit Driver Definition JAR List tab
Option
Description
Driver Files
Lists the existing JARs or ZIPs associated with this driver
defintion.
Add JAR/Zip
Add a JAR or ZIP to the driver definition.
Edit JAR/Zip
Change the selected JAR or ZIP to a different one. You
can also change the path information for all JARs and ZIPs.
Remove JAR/Zip
Remove the selected JAR or ZIP file.
Clear All
Remove all listed JAR and ZIP files.
Note: Options in the Properties tab vary based on database server type. You can edit or enter a property
in the Value box.
Label Decorations Preferences
Set label decorations preferences to set the display format of objects appearing in the Database Development
perspective.
Table 4. Label decorations: Text tab
6
Property
Description
Column format
Specify the display format for table columns. Select Add Variables to add a
variable to the format.
Example
Displays an example of the selected format.
Creating a Database Connection Profile
Creating a Database Connection Profile
A connection profile contains the connection property information needed to connect to a database runtime
instance.
Prerequisites
Switch to the Database Development perspective. Make sure that the database server is running before
attempting to test the connection or to connect to the database server.
1. In Data Source Explorer, right-click Databases and select New.
2. (Optional) Filter the Connection Profile Types list.
For example, to list all databases that begin with the letter D, enter a d in the text box. You can also enter
a text string such as JDBC or embedded to filter the list.
3. Select a connection profile type.
4. (Optional) Change the Name from the system-provided default, and/or enter a Description, and click
Next.
You must change the name if a connection profile already exists with the same name.
5. Indicate a driver definition.
•
Select one from the list. If a driver definition does not exist for the database type you selected, you can
create one.
•
Select
New Driver Definition to create a new driver definition.
Select
Edit Driver Definition to edit an existing driver definition.
•
The Properties tabs populate with default template information for the selected driver.
6. (Optional) Add or modify the Properties information in the Connection or Other Properties tabs.
a) Click Save Password to save the password for the database server login.
b) Select Connect When the Wizard Completes to connect to the database server once you finish
defining this connection profile.
c) Select Connect Every Time the Workbench Is Started to automatically connect to the database
server using this connection profile when you launch Eclipse.
d) Click Test Connection to ping the server and to verify that the connection profile is working.
7. (Optional) Click Next to view Summary information.
8. Click Finish to create the connection profile.
Refreshing a Connection Profile
If you modify the properties of a connection profile, you can refresh the connection profile to update its
contents.
1. Open Data Source Explorer.
2. Expand the category for the connection profile you want to rename.
3. Right-click the connection profile and select Refresh.
Data Tools Platform Connectivity
7
Creating a Database Connection Profile
Renaming a Connection Profile
You can rename a connection profile.
Prerequisites
Disconnect from the database server.
1.
2.
3.
4.
Open Data Source Explorer.
Expand the category for the connection profile you want to rename.
Right-click the connection profile and select Rename.
Edit the name of the connection profile and click OK.
Deleting a Connection Profile
You can delete a connection profile.
Prerequisites
Disconnect from the database server.
1.
2.
3.
4.
Open Data Source Explorer.
Expand the category for the connection profile you want to delete.
Right-click the connection profile and select Delete.
Click Yes to confirm deletion.
Testing a Connection Profile
Ping the data source/enterprise resource to test a connection profile.
1.
2.
3.
4.
Open Data Source Explorer.
Expand the category for the connection profile you want to test
Right-click the connection profile and select Ping.
Choose from the following:
Table 5. Ping options
8
Option
Action
If the ping fails
Verify that the data source/enterprise resource is running and check the connection
profile properties.
To view error information
Click Details in the Error dialog.
If the ping succeeds
Click OK.
Creating a Database Connection Profile
Importing a Connection Profile
Import one or more connection profiles into the current workspace.
You might import a connection profiile if you created connection profiles in a previous version of DTP and
want to reuse them in the current version of DTP, or want to share a common set of connection profiles across
a workgroup.
1.
In Data Source Explorer, click
Import.
2. Enter the fully qualified path to the connection profile file, or click Browse.
3. (Optional) Click Overwrite Existing Connection Profiles with Same Names.
4. Click OK.
The connection profile appears under its data source category.
Exporting a Connection Profile
Export one or more connection profiles to a text file.
You might want to export connection profiles if you:
•
•
•
•
Plan to create a new workspace or upgrade to a newer version of DTP.
Want to reuse existing connection profiles.
Share a common set of connection profiles across a workgroup.
Want to deploy a set of connection profiles to a backend server environment, whose application can work
directly with the exported file. You can copy the file to a server with no need to explicitly import the
connection profiles.
Connection profiles are exported as text files, either plain or encrypted.
1.
2.
3.
4.
5.
In Data Source Explorer, click
Export.
Select the connection profiles you want to export.
Enter a fully qualified to create a new file, or click Browse to overwrite an existing file.
(Optional) Deselect Encrypt File Content if the connection profiles do not contain passwords or any other
content that poses a security risk.
Click OK.
Editing Connection Profile Properties
Edit data source/enterprise resource configuration parameters for a specific connection profile.
Note:
You can also view and edit connection profile properties in the Console Editor Application, which is an
application you can launch outside the Eclipse workbench.
1. Open Data Source Explorer.
2. Expand the category for the connection profile you want to edit properties.
3. Right-click the data source/enterprise resource and select Properties.
Data Tools Platform Connectivity
9
Creating a Database Connection Profile
4. Select a property option to display its associated Properties page.
5. Edit the connection profile properties as necessary.
Connection Profile Common Properties
Edit the properties common to all connection profiles.
Property
Description
Name
Enter a unique and descriptive name for the connection
profile.
Description
(Optional) Enter a profile description that helps you
distinguish it from others.
Connect Every Time the Workbench Is Started
(Optional) Connect automatically to the data source when
the workbench displays during startup.
Connection Profile Default Schema Filter Properties
Indicate which schemas display in Data Source Explorer.
Property
Description
Expression
Select the filtering method.
Text box
Enter one or more characters used in the filter expression. This field is case sensitive.
You do not need to use wildcards or meta-characters.
For example, if you selected Starts With the Characters and entered a capital S in this
text box, Data Source Explorer displays only the schemas with names that begin with a
capital S.
Disable Filter
Deselect the checkbox to enter a filter expression to determine which schemas display
in Data Source Explorer.
Connection Profile Default Stored Procedure Filter Properties
Indicate which stored procedures display in Data Source Explorer.
Property
Description
Expression
Select the filtering method.
Text box
Enter one or more characters used in the filter expression. This field is case sensitive.
You do not need to use wildcards or meta-characters.
For example, if you selected Starts With the Characters and entered a capital S in this
text box, Data Source Explorer displays only the stored procedures with names that
begin with a capital S.
Disable Filter
Deselect the checkbox to enter a filter expression to determine which stored procedures
display in Data Source Explorer.
Connection Profile Default Table Filter Properties
Indicate which tables display in Data Source Explorer.
10
Creating a Database Connection Profile
Property
Description
Expression
Select the filtering method.
Text box
Enter one or more characters used in the filter expression. This field is case sensitive.
You do not need to use wildcards or meta-characters.
For example, if you selected Starts With the Characters and entered a capital S in this
text box, Data Source Explorer displays only the tables with names that begin with a
capital S.
Disable Filter
Deselect the checkbox to enter a filter expression to determine which tables display in
Data Source Explorer.
Connection Profile JDBC Connection Properties
Edit the properties of a JDBC connection profile.
Property
Description
Drivers
Select a driver from the list. If an appropriate driver
definition does not exist, you can create one.
•
Select
New Driver Definition to create a new
driver definition.
•
Select
Edit Driver Definition to edit an existing
driver definition.
Database
Database associated with the connection profile.
URL
URL address for the profile. In most cases, if you selected
a provided driver, you do not need to modify the value in
this field.
User Name
User ID associated with the connection profile.
Password
Password for the database server login.
Save Password
Save the password for this connection profile. Passwords
persist only for the current session. If you do not save your
password and exit the workbench, you have to enter it
when trying to connect to the database server via the
connection profile for the new session.
Note: Whether you want to save your password depends
on your organization's security policy. Passwords are saved
in the workspace metadata in the ServerProfiles.dat file
with minimal encryption.
Optional
1. In the text box, specify connection properties using the
KEY=value format, or choose from the drop-down list,
and click Add.
For example, DYNAMIC_PREPARE=true.
2. Use the Up, Down, Remove, and Clear All buttons to
delete or change the order of the connection properties.
Data Tools Platform Connectivity
11
Creating a Database Connection Profile
Property
Description
Test Connection
Ping the server and verify that the connection profile is
working.
Connection Profile Derby JDBC Connection Properties
Edit the properties of a Derby JDBC connection profile.
Property
Description
Drivers
Select a driver from the list. If an appropriate driver
definition does not exist, you can create one.
•
Select
New Driver Definition to create a new
driver definition.
•
Select
Edit Driver Definition to edit an existing
driver definition.
Database Location
Enter the fully qualified path to the database, or click
Browse. You can select an existing database or create a
new one.
User Name
User ID associated with the connection profile.
Password
Password for the database server login.
URL
Displays the URL address for the profile.
Create Database (If Required)
Creates a database, if the one you indicated in the
Database Location does not exist.
Upgrade Database to Current Version
Select if you are using an older version of a Derby database
and want to use the version that matches the driver version.
Save Password
Save the password for this connection profile. Passwords
persist only for the current session. If you do not save your
password and exit the workbench, you have to enter it
when trying to connect to the database server via the
connection profile for the new session.
Note: Whether you want to save your password depends
on your organization's security policy. Passwords are saved
in the workspace metadata in the ServerProfiles.dat file
with minimal encryption.
Optional
1. In the text box, specify connection properties using the
KEY=value format, or choose from the drop-down list,
and click Add.
For example, DYNAMIC_PREPARE=true.
2. Use the Up, Down, Remove, and Clear All buttons to
delete or change the order of the connection properties.
Test Connection
Ping the server and verify that the connection profile is
working.
Connection Profile Version Properties
Connects to the data source and updates version information.
12
Creating a Database Connection Profile
Property
Description
Connect and Update Version Information
Click to connect to the database and update JDBC-specific
information for the database server.
Console Editor Application
The Console Editor Application is a system console to make minor changes to an exported connection profile,
such as the file path to the JDBC driver JARs, a connection URL, an ODA data source file path, and so on.
When you copy an exported file to a server platform for deployment, you can use this editor tool to quickly
adjust the connection profile properties without having to open Data Source Explorer in the Eclipse
workbench.The updates are saved in a separate file for all the connection profiles.
Before you can use the Console Editor Application, you must install
org.eclipse.datatools.connectivity.console.profile_<version>.jar in your Eclipse environment, along with the
other DTP plug-ins.
From within your Eclipse home directory, enter the command syntax.
eclipse[c] -nosplash -application org.eclipse.datatools.connectivity.console.profile.StorageFileEditor [ -? | -in
<connectionProfileFile> | -out <saveAsFile> | -profile <profileName> ]
For Windows platforms, indicate eclipsec. For other platforms, use eclipse.
Table 6. Optional command line options
Option
Description
-?
Displays help.
-in <connectionProfileFile>
Enter the name of the connection profile storage file to view
and/or change.
-out <saveAsFile>
Enter the name of the output file to save your changes.
-profile <profileName>
Enter the name of a connection profile to view and/or
change. If you do not specify a connection profile name,
the Console Editor steps through all the profiles found in
the input file.
Note: If you do not specify an argument value, the Console Editor prompts you for an input value.
Data Tools Platform Connectivity
13
Creating a Driver Definition
Creating a Driver Definition
Create a driver to connect to a specific database.
1.
2.
3.
4.
Select Window > Preferences from the main menu bar.
Expand Data Management > Connectivity and select Driver Definitions.
Click Add.
In the Name/Type tab, select a driver template.
a) (Optional) Select a Vendor Filter to display only those databases for a specific vendor.
b) Select a driver template.
c) (Optional) Modify the Driver Name if a driver definition with this name already exists.
5. In the JAR List tab, indicate the path to the JAR or ZIP file associated with the driver.
a) Click Add JAR/Zip.
b) Browse to the location of the JAR or ZIP file.
c) Click Open.
6. (Optional) In the Properties tab, modify the default properties for the driver definition template.
Note: Options in the Properties tab vary based on database server type.You can edit or enter a property
in the Value box.
7. Click OK.
Editing a Driver Definition
Edit an existing driver definition.
You can edit a driver definition through the Driver Definitions preference pages or when creating a connection
profile.
1.
2.
3.
4.
5.
6.
7.
Select Window > Preferences from the main menu bar.
Expand Data Management > Connectivity and select Driver Definitions.
(Optional) Select a Vendor Filter to display only those databases for a specific vendor.
Select an existing driver defintion and click Edit.
(Optional) In the Name/Type tab, modify the Driver Name.
(Optional) In the JAR List tab, indicate or modify the path to the JAR or ZIP file associated with the driver.
(Optional) In the Properties tab, modify the default properties for the driver definition template.
Note: Options in the Properties tab vary based on database server type.You can edit or enter a property
in the Value box.
8. Click OK.
14
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement