Getting Started
This chapter is a quick tutorial for newcomers. You can learn the basics of this program step by step.
First Look
Add a Platform
Add a Database
Connect to the Database
Play with the Connected Database
Edit DB Connection information
Disconnect from a Database
Remove a Database
Remove a Platform
Before embarking on your adventure, you need to be familiar with the overall layout of this program.
When you execute this program, you will see one window divided into three panes.
Let's look at them briefly.
1. Altibase Explorer
Altibase Explorer is the entry point for this program. You can register platforms and database connections and explore database objects.
2. gSQL
gSQL is a graphical query tool. It gives you a convenient way to edit SQL statements, run SQL statements and scripts, print a statement execution plan, and browse statements sent using gSQL.
3. Result View
Result View is a shared area for viewing details of database objects when using Altibase Explorer and the results of a query or a statement execution plan when using gSQL.
Back to list
To add a new Altibase database connection, you need a platform, which is a machine on which Altibase DBMS(s) has been installed.
To add a platform, please follow steps:
- Select "Registered Platforms" at the top of Altibase Explorer.
- Open the context menu by clicking on it once with the right mouse button.
- Execute "Add Platform".
- Fill in the two input text fields:
- Platform Name: You can input any name as long as it is unique in Altibase Explorer.
- Address: IP address of a new platform
- Click "OK".
Back to list
Now, it's time to add a new database connection on the registered platform.
- Select the platform you added.
- Open the context menu by clicking on it once with the right mouse button.
- Execute "Add Stand-alone Altibase".
- Fill in the input fields:
- Altibase Name: Enter any name you like, as long as it is unique in Altibase Explorer.
- DB Port: The port number of the database to connect to.
- DB Name: The name of the database to connect to.
- User ID: A valid user ID for the database.
- Password: The password corresponding to the user ID.
- NLS for client: Choose a character set for translating data from the DBMS on the client side. (This option is not necessary when using version 5.3.1 or higher of Altibase DBMS.)
- JDBC driver: Location of JDBC driver to be used.
- To check what you have input, please click "Connection Test".
- Click "OK" if everything is fine.
Back to list
You are ready to connect to a database.
- Select the database you added.
- Open the context menu by clicking on it once with the right mouse button.
- Execute "Connect". This may take some time depending on your environment.
- When you are successfully connected, you will see the database objects in the target database.
- If the connection fails, a warning dialog appears and gives you some information to help you solve the problem.
Back to list
If you followed the preceding steps successfully, you are ready to explore the connected database.
Here are some tips to help you navigate:
- All schema objects are placed under their parent schemata.
For example, if you created a table named "SYS.T1", then you can find the "T1" table under the "SYS" schema.
Conversely, all non-schema objects are located under "System Objects".
- Double-click the left mouse button over a database object to browse its child objects and related objects.
For faster operation and reduced memory consumption, this program retrieves basic meta information
when connecting to a target database for the first time.
When a user subsequently requests detailed information on any database object,
it fulfills the request.
For instance, double-clicking on a table for the first time after connecting to a database will retrieve
the table's subordinate objects, such as columns or constraints, and related objects, such as indexes and triggers.
- Single-click the right mouse button over any database object to open its context menu, which is the main gate for most functions. You can use context menus to perform most tasks, including creating, editing, and dropping database objects.
- One time-saving shortcut is to perform the same task on multiple selected database objects. For example, you can drop five tables with a single click on the "drop" item in the context menu after selecting the five target tables.
Back to list
Sometimes, you may need to edit database connection information; for example, you may need to change the account used to establish the database connection. This is possible only when the target database is disconnected.
- Select the database for which you wish to change connection information.
- Open the context menu by clicking on it once with the right mouse button.
- Execute "Edit".
- Change the connection information as you wish.
- To check your changes, please click "Connection Test".
- Click "OK" if everything is fine.
Back to list
After finishing your work, you must close the connection to the target database.
- Select the target database.
- Open the context menu by clicking on it once with the right mouse button.
- 1.Execute "Disconnect". The program may ask you whether or not to save the gSQL query strings. This is, of course, up to you.
Back to list
When a registered database is no longer in use, you may want to remove it from Altibase Explorer.
- Select the target database.
- Open the context menu by clicking on it once with the right mouse button.
- Execute "Remove".
Back to list
When a registered platform is no longer in use, you may want to remove it from Altibase Explorer. However, keep it mind that if you remove a platform, all database connections associated with the target platform will also be removed.
- Select the target database.
- Open the context menu by clicking on it once with the right mouse button.
- Execute "Remove".
Back to list