Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
updates cli images and docs
  • Loading branch information
mdrillin committed Apr 26, 2016
1 parent ad95acf commit 6c576a3
Show file tree
Hide file tree
Showing 12 changed files with 23 additions and 25 deletions.
24 changes: 11 additions & 13 deletions documentation/cli/connect-to-server.md
@@ -1,6 +1,6 @@
### Connect to a local Teiid Server

This sample shows how to connect to a teiid server instance using the VDB Builder cli. This example also demonstrates how to view the vdbs deployed to the server after you have successfully connected.
This sample shows how to connect to a teiid server instance using the VDB Builder cli. This example also demonstrates how to view the datasources deployed to the server after you have successfully connected.

You can use __tab completion__ to see the available commands options, or use __help commandName__ to see command details.

Expand All @@ -12,23 +12,21 @@ You can use __tab completion__ to see the available commands options, or use __h

### Connect to a server

You can connect to a teiid server within the VDBBuilder cli. The sample session below shows how to connect to the server and view the deployed VDBs. Note that once you are connected to a server, several more server commands will become available. You can discover the available server commands in VDBBuilder by typing 'help' after connecting to the server.
A default server is defined within the VDBBuilder cli. You can specify the server connection properties, then connect to and interact with the server. The sample session below shows how to connect to the server and view the deployed data sources. Note that once you are connected to a server, many more server commands will become available. You can discover the available server commands in VDBBuilder by typing 'help' after connecting to the server.

NOTE: VDBBuilder will attempt to connect to a server on startup if the global property SERVER_CONNECT_ON_STARTUP is set to true.

![Connect to Server](img/cli-connect-to-server.png)

---
Here is a summary of the commands used for the above session:

* __`list`__ - shows all children at the cli context. The workspace initially contains no children.
* __`create-teiid myServer`__ - create a Teiid object named __myServer__
* __`cd myServer`__ - 'navigates' down into __myServer__
* __`show-properties`__ - shows the property settings for __myServer__. No properties have been set, but the server will default to 'localhost' and admin port 9999.
* __`workspace`__ - navigate to the workspace
* __`set-server myServer`__ - set the server __myServer__ for this session.
* __`show-status`__ - display the workspace status. Note the current Teiid Instance is now __myServer__, but the status is [Not Connected]
* __`server-connect`__ - connects to __myServer__.
* __`show-status`__ - display the status again. This time, note the Teiid Instance status is [Connected]
* __`server-vdbs`__ - display the vdbs currently deployed on the connected server.
* __`server-disconnect`__ - disconnects from the __myServer__.
* __`show-status`__ - display the workspace status. Note the current server status is [Not Connected]
* __`server-show-properties`__ - shows the default server properties. You can use 'server-set-property' to change the properties.
* __`server-connect`__ - connects to the default server.
* __`show-status`__ - display the status again. This time, note the server status is [Connected]
* __`help`__ - shows the available commands. Note the server commands that are now available.
* __`server-datasources`__ - display the datasources currently deployed on the connected server.
* __`server-disconnect`__ - disconnects from the default server.

---
Binary file modified documentation/cli/img/cli-connect-to-server.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/cli/img/cli-createVDB-session.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/cli/img/cli-deploy-vdb-to-server.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/cli/img/cli-get-vdb-from-server.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/cli/img/cli-import-export-DDL.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/cli/img/cli-import-export-VDB.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/cli/img/cli-importVDB-session.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/cli/img/cli-record-playback-interactive.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/cli/img/cli-record-session.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/cli/img/cli-startup.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 12 additions & 12 deletions documentation/cli/server-vdb-interactions.md
Expand Up @@ -25,12 +25,12 @@ You can deploy a VDB from VDB Builder to a running server. The sample session b
---
Here is a summary of the commands used for the above session:

* __`show-status`__ - display the shell status. Note the Teiid Instance is __myServer__, and the status is [Connected]
* __`list`__ - show all children in __workspace__. Note that we have a VDB __TestVDB__ in our workspace.
* __`server-vdbs`__ - show all VDBs on the connected server, __myServer__. Note that __TestVDB__ does not exist on the server.
* __`server-deploy-vdb TestVDB`__ - deploy __TestVDB__ from VDB Builder to the connected server.
* __`server-vdbs`__ - again, show all VDBs on the connect server. Note that __TestVDB__ has been deployed!
* __`server-vdb TestVDB`__ - show more detail for __TestVDB__ on the connect server __myServer__.
* __`show-status`__ - display the shell status. Note the server status is [Connected]
* __`list`__ - show all children in __workspace__. Note that we have one VDB __VdbDashboardDS__ in our workspace.
* __`server-vdbs`__ - show all VDBs on the connected server. Note that __VdbDashboardDS__ does not exist on the server.
* __`server-deploy-vdb VdbDashboardDS`__ - deploy __VdbDashboardDS__ from VDB Builder to the connected server.
* __`server-vdbs`__ - again, show all VDBs on the connected server. Note that __VdbDashboardDS__ has been deployed!
* __`server-vdb VdbDashboardDS`__ - show more detail for __VdbDashboardDS__ on the connect server.

---

Expand All @@ -43,12 +43,12 @@ You can also fetch a VDB from a running server and save it to the VDB Builder wo
---
Here is a summary of the commands used for the above session:

* __`show-status`__ - display the shell status. Note the Teiid Instance is __myServer__, and the status is [Connected]
* __`show-status`__ - display the shell status. Note the current server status is [Connected]
* __`list`__ - show all children in __workspace__. Note that we do not have any VDBs.
* __`server-vdbs`__ - show all VDBs on the connected server, __myServer__. Note that __TestVDB__ exists on the server.
* __`server-get-vdb TestVDB`__ - gets __TestVDB__ from the connected server, and copies it to VDB Builder workspace.
* __`list`__ - show all children in __workspace__. Note that __TestVDB__ is now in the VDB Builder workspace!
* __`cd TestVDB`__ - navigate into __TestVDB__.
* __`show-summary`__ - shows a summary (properties and children) for the current context, __TestVDB__
* __`server-vdbs`__ - show all VDBs on the connected server. Note that __VdbDashboardDS__ exists on the server.
* __`server-get-vdb VdbDashboardDS`__ - gets __VdbDashboardDS__ from the connected server, and copies it to VDB Builder workspace.
* __`list`__ - show all children in __workspace__. Note that __VdbDashboardDS__ is now in the VDB Builder workspace!
* __`cd VdbDashboardDS`__ - navigate into __VdbDashboardDS__.
* __`show-summary`__ - shows a summary (properties and children) for the current context, __VdbDashboardDS__

---

0 comments on commit 6c576a3

Please sign in to comment.