#13068: Investigate enhancing FluidShell \session and \connect command to allow attaching to Query Analyzer connections

NielsGron reported 2015-02-02T04:09:51Z · last modified 2015-02-15T07:29:50Z

Investigate enhancing FluidShell \session and \connect command to allow attaching to Query Analyzer connections

Dev	JennyNishimura
QA	SachinPrakash

Priority	Major
Complexity	Unknown

Component	App - FluidShell - Command
Version	15.0

Users would like to be able to attach a FluidShell connection/session to an already open Query Analyzer window so that they can run scripts that create temporary tables, which are then accessible in the Query Analyzer window. Possible solution is to enhance the \session and \connect commands so you can do something like this :

\connect -k 100 -qa "Title of QA Window"
\session 100

The \connect would make a session available with ID 100, which would just be the connection of the Query Analyzer window with the title "Title of QA Window", and then the \session command would switch to that session.

All Comments (16) Change History

NielsGron 2015-02-02T04:24:18Z

We have the SessionCommand.java and ConnectCommand.java classes, where this should be implemented. We need to keep in mind that a user can have multiple application frames open, and thus a multiple list of Query Analyzer windows open. We have the WindowsTracker.java class, which extends the FrameTracker.java class which has the method the method .getAllFrames(), returning a list of JFrame objects. In this list of open JFrame objects, we need to look for any instances of an AppFrame.java class, which is the DataStudio frame class.

In the method QueryPanel.updateTabPlacement() you can see how it iterates through all the Query Analyzers of all the Frames. This is how we will need to find a Query Analyzer tab which matches the title the user requested in the \connect command. The QueryPanel.java class has a .getConnection() and .getConnectionProperties() method.

We will also need to determine how to handle if the user decides to \disconnect this connection in the FluidShell. Or if the user does a reconnect in the Query Analyzer window after the user attaches from the FluidShell.

JennyNishimura 2015-02-11T17:46:37Z · (edited)

connect command
- A new option "-qa" has been added. It attaches the connection from the Query Analyzer window with the specified title.
- When "-qa" is specified, the "-k" option specifies the session ID. All other options are ignored.
reconnect command
- If the session has a connection from a Query Analyzer window, it will attach the current connection from the Query Analyzer window to the session.
disconnect command
- If the session has a connection from a Query Analyzer window, the session is disconnected from FluidShell but the database connection in the Query Analyzer window is not closed.
session command
- When displaying the list of sessions, there is a new column named "QA Window" that shows the title of the Query Analyzer window.
The database connection is managed by the Query Analyzer window. FluidShell attaches the connection to the session. FluidShell doesn't close the database connection. However, if user disconnects the connection in the Query Analyzer window or closes the Query Analyzer window, the database connection is closed and FluidShell returns an error if user tries to use the connection.

swissarmyknife(*) 2015-02-11T00:46:17Z · (edited)

I've begun forming the documentation in v16 for this. Let me know if -qa option section below is appropriate.

https://www.aquaclusters.com/app/home/project/public/aquadatastudio/wikibook/Documentation16/page/257/connect

and related command notes can be found below

session
https://www.aquaclusters.com/app/home/project/public/aquadatastudio/wikibook/Documentation16/page/session/session

disconnect
https://www.aquaclusters.com/app/home/project/public/aquadatastudio/wikibook/Documentation16/page/260/disconnect

JennyNishimura 2015-02-11T17:47:11Z · (edited)

The updates to the session command are not needed. We don't document the columns for the session list. So we don't need to document what the new column is.

Please refer to the updated help text of the connect, reconnect, and disconnect commands when the new build is available.

JennyNishimura 2015-02-11T17:51:30Z

We will also need to determine how to handle if the user decides to \disconnect this connection in the FluidShell.

If the user runs the \disconnect command in FluidShell, the session is disconnected but the database connection in the Query Analyzer window remains connected.

Or if the user does a reconnect in the Query Analyzer window after the user attaches from the FluidShell.

If the user reconnects in the Query Analyzer window, the user will get an error that the connection is closed when trying to use the FluidShell session. The user can run the \reconnect command in FluidShell to attach to the current database connection from the Query Analyzer window.

swissarmyknife(*) 2015-02-11T20:48:21Z

I've edited the documentation in v16 using the contents of the help from v15.0.14-1

you can refresh the links I posted above, and this newly edited link
https://www.aquaclusters.com/app/home/project/public/aquadatastudio/wikibook/Documentation16/page/279/reconnect

tariqrahiman 2015-02-11T21:03:17Z

@jenny: can you also check the reconnect icon in the Fluidshell toolbar. The reconnect command works fine and I am able to attach to the QA and query the temp table, but not when I click on the reconnect icon

JennyNishimura 2015-02-11T22:20:11Z

I've fixed the Reconnect icon to attach to the current QA connection. Please verify using 15.0.14-2.

JennyNishimura 2015-02-11T22:32:04Z

Jonathan, the "Notes" section you added to the session command should have been added to the disconnect command instead.

swissarmyknife(*) 2015-02-11T23:31:10Z

please review the new feature page for this, as I don't know if I am doing a good job of screenshotting and explaining this feature:

https://www.aquaclusters.com/app/home/project/public/aquadatastudio/wikibook/New-Features-16.0/page/FluidShell-Query-Analyzer-Connection-Sharing/FluidShell-Query-Analyzer-Connection-Sharing

NielsGron 2015-02-12T04:59:04Z

Need to test scenarios :

Scenario 1

1. Open QW to "SQL Server"

2. Open FS to "SQL Server"

3. FS :> \connect -qa 'sa@SQL Server' -k 101

4. FS :> select @@spid/

5. Rename QW to 'sa@SQL Server6'

6. FS :> select @@spid/

7. FS :> \session

* note name of QA Window

Scenario 2

1. Open QW to "SQL Server"

2. Open FS to "SQL Server"

3. FS :> \connect -qa 'sa@SQL Server' -k 101

4. FS :> select @@spid/

5. QW : Reconnect

6. FS :> select @@spid/

7. FS :> \connect -qa 'sa@SQL Server' -k 101

8. FS :> \session
9. 5. QW : Disconnect

10. FS :> select @@spid/

11. FS :> \connect -qa 'sa@SQL Server' -k 101

12. FS :> \session
13. QW : Reconnect

14. FS :> select @@spid/

Scenario 3
1. Open QW to "SQL Server"

2. Open FS to "SQL Server"

3. FS :> \connect -qa 'sa@SQL Server' -k 101

4. FS :> select @@spid/

5. QW : Change Server to "SQL Server2"

6. FS :> select @@spid/

7. FS :> \session

8. FS :> \reconnect

Scenario 4
1. Open QW to "SQL Server"

2. Open FS to "SQL Server"

3. FS :> \connect -qa 'sa@SQL Server' -k 101

4. FS :> select @@spid/

5. FS :> \session

6. FS :> \disconnect

7. FS :> \session

8. FS :> select @@spid/

8. FS :> \connect -qa 'sa@SQL Server' -k 101

9. FS :> select @@spid/

10. FS :> \reconnect
11. FS :> \session

12. FS :> select @@spid/

NielsGron 2015-02-12T05:00:51Z

There are issues with the scenarios I've added.

JennyNishimura 2015-02-12T19:15:43Z · (edited)

I have tested these scenarios. See my notes below. Please let me know what the issues are and what needs to be fixed.

Scenario 1

1. Open QW to "SQL Server"

2. Open FS to "SQL Server"

3. FS :> \connect -qa 'sa@SQL Server' -k 101

4. FS :> select @@spid/

5. Rename QW to 'sa@SQL Server6'
--> We currently do not sync the QA window title in the session list. We made this decision during design and implementation.

6. FS :> select @@spid/

7. FS :> \session

* note name of QA Window

Scenario 2

1. Open QW to "SQL Server"

2. Open FS to "SQL Server"

3. FS :> \connect -qa 'sa@SQL Server' -k 101

4. FS :> select @@spid/

5. QW : Reconnect

6. FS :> select @@spid/
--> Query not sent: server is disconnected. (This is correct because the original QA connection has been disconnected. If you do \reconnect in FS, then it'll work.)
6a. FS > \disconnect (We need to do disconnect here; otherwise the connect command using the same session ID in step 7 will fail.)
7. FS :> \connect -qa 'sa@SQL Server' -k 101

8. FS :> \session
9. QW : Disconnect

10. FS :> select @@spid/
--> Connection to database is already closed. (This is correct because the QA connection has been closed.)

~~11. FS :> \connect -qa 'sa@SQL Server' -k 101~~ (session ID 101 is already in use)

12. FS :> \session
13. QW : Reconnect
--> You need to do a reconnect in FS to attach to the current QA connection.
13a. FS :> \reconnect

14. FS :> select @@spid/

Scenario 3
1. Open QW to "SQL Server"

2. Open FS to "SQL Server"

3. FS :> \connect -qa 'sa@SQL Server' -k 101

4. FS :> select @@spid/

5. QW : Change Server to "SQL Server2"

6. FS :> select @@spid/

7. FS :> \session

8. FS :> \reconnect
--> You get the error message "there is no Query Analyzer window titled 'sa@SQL Server'. This is correct because the QA window is now titled ''sa@SQL Server2'. This is the correct behavior for the current implementation.

Scenario 4
1. Open QW to "SQL Server"

2. Open FS to "SQL Server"

3. FS :> \connect -qa 'sa@SQL Server' -k 101

4. FS :> select @@spid/

5. FS :> \session

6. FS :> \disconnect

7. FS :> \session

8. FS :> select @@spid/
--> Query not sent: server is disconnected. This is correct because you didn't switch back to the "default" session. If step 7 is "session default", then step 8 will succeed.
8. FS :> \connect -qa 'sa@SQL Server' -k 101

9. FS :> select @@spid/

10. FS :> \reconnect
11. FS :> \session

12. FS :> select @@spid/

I have tested these scenarios. See my notes below. Please let me know what the issues are and what needs to be fixed.

Scenario 1

1. Open QW to "SQL Server"

2. Open FS to "SQL Server"

3. FS :> \connect -qa 'sa@SQL Server' -k 101

4. FS :> select @@spid/

5. Rename QW to 'sa@SQL Server6'
--> We currently do not sync the QA window title in the session list. We made this decision during design and implementation.

6. FS :> select @@spid/

7. FS :> \session

* note name of QA Window

Scenario 2

1. Open QW to "SQL Server"

2. Open FS to "SQL Server"

3. FS :> \connect -qa 'sa@SQL Server' -k 101

4. FS :> select @@spid/

5. QW : Reconnect

8. FS :> \session
9. QW : Disconnect

10. FS :> select @@spid/
--> Connection to database is already closed. (This is correct because the QA connection has been closed.)

~~11. FS :> \connect -qa 'sa@SQL Server' -k 101~~ (session ID 101 is already in use)

12. FS :> \session
13. QW : Reconnect
--> You need to do a reconnect in FS to attach to the current QA connection.
13a. FS :> \reconnect

14. FS :> select @@spid/

Scenario 3
1. Open QW to "SQL Server"

2. Open FS to "SQL Server"

3. FS :> \connect -qa 'sa@SQL Server' -k 101

4. FS :> select @@spid/

5. QW : Change Server to "SQL Server2"

6. FS :> select @@spid/

7. FS :> \session

Scenario 4
1. Open QW to "SQL Server"

2. Open FS to "SQL Server"

3. FS :> \connect -qa 'sa@SQL Server' -k 101

4. FS :> select @@spid/

5. FS :> \session

6. FS :> \disconnect

7. FS :> \session

9. FS :> select @@spid/

10. FS :> \reconnect
11. FS :> \session

12. FS :> select @@spid/

JennyNishimura 2015-02-13T20:59:00Z

Scenario 1: Fixed to show the current QA window title in session list.

Scenario 2: No change

Scenario 3: Fixed to display the QA window title as "[Closed]" in \session (step 7) and return the error message "The Query Analyzer window has been closed." in \reconnect (step 8).

Scenario 4: No change

tariqrahiman 2015-02-13T22:35:19Z

Verified in ADS v15.0.14-5

NielsGron 2015-02-15T07:29:50Z

Verified in ADS v15.0.14-5

Search Tips

Aqua Data Studio / nhilam

Investigate enhancing FluidShell \session and \connect command to allow attaching to Query Analyzer connections

Issue #13068

Completion