Easily find issues by searching: #<Issue ID>
Example: #1832
Easily find members by searching in: <username>, <first name> and <last name>.
Example: Search smith, will return results smith and adamsmith
Aqua Data Studio provides three different ways to retrieve user credentials outside the application:Invoke an executable, Instantiate the Java classname specified, or Retrieve password from Secure Storage. All of these methods allow you to use multiple connections from multiple databases. For all of these methods, in your register server dialog, instead of entering an actual username and password, you enter a token which tells Aqua Data Studio to retrieve the credentials outside of the application. For instance, a company could have their usernames and passwords for DBs stored in a central LDAP repository. Then they code use the mechanism provided below in Aqua Data Studio to lookup the user's correct username and password for their DB.
In your register server dialog, for Login Name and/or password, you specify the value in the format:
~`c:\path_of_exe\exe_name_to_launch`~
The use of backticks ` is required. Do NOT use single quotes '
When a user uses Aqua Data Studio to connect to a DB server with such a value, Aqua Data Studio invokes the specified executable and whatever value is returned by the exe in stdout (standard out) is what Aqua Data Studio uses for the username/password.
Below is an example in OS X.
The contents of retrieve_username.sh (hard-coded for illustration purposes). This file echoes "root" which is passed to Aqua Data Studio and then Aqua Data Studio passes "root" for the "Login Name" credential.
Below is an example in Windows showing the Login Name referring to retrieve_username.bat and a command prompt showing the contents of the retrieve_username.bat file.
In your register server dialog, for Login Name, you specify the value in the format:
~`creduser::JavaClassName`~
For password, you specify in the format:
~`credpass::JavaClassName`~
The use of backticks ` is required. Do NOT use single quotes '
With this approach, Aqua Data Studio will attempt to instantiate the classname specified. If instantiated successfully, Aqua Data Studio will then invoke the class's getUserName() / getPassword() method. The value returned from this method will be used for username / password.
Contents of Java class CredentialPrototype: (hard-coded the username for illustration purposes)
First go to File->Options:Secure Storage and add a Secure Storage entry for the password. For example:
Once you have successfully created a secure storage entry of your database server password, the next step would be to navigate to your register server dialog. Navigate to the Password field, and specify the value in the format below. The ::password specified here is configurable and you can use any other name to reflect your server registration password to the created secured storage entry.
~`credsecure::password`~
The use of backticks ` is required. Do NOT use single quotes '
This method can only be used for the Password field
With this approach, Aqua Data Studio will then look up the specified Secure Storage Field Name & decrypt it & use its value for the password field specified.
Multiple Server Registrations with different passwords using Secure Storage
In case you have the same password for all your registered servers, you can use a single entry for the credsecure mechanism as in the above example. Now, if you have several database registrations with distinct passwords, create 1 entry each for the passwords under File->Options:Secure Storage and use the entries in your server registrations. For e.g:
~`credsecure::pwd_db1`~