Cloudview is a graphical user interface (GUI) for creating, managing, and viewing Cloudscape databases.
The Cloudview on-line help system covers the following topics:
You can perform the following tasks using Cloudview:
While browsing a table, view, or query result, you can "drill down" into Java objects contained in the data. You can:
Cloudview is based on one principal screen, called the Cloudview Window.
The Cloudview Window consists of two parts: the Navigation (left) Panel and the Editing (right) Panel. You can resize the two panels by clicking and dragging the boundary between them.
To open an additional Cloudview Window, choose File->New->Window from the menu. All open databases in the first Cloudview Window also appear in the additional Window, and new connections are started to each databases. See Working with Connections and Working with Databases for more information on database connections.
This section covers the following topics:
The Navigation (left) panel, like a file browser, is built on a tree structure. To expand a branch, click the "+" symbol to the left of an icon. If a branch is empty, the "+" symbol disappears when you click it. To collapse an expanded branch, click the "-" symbol to the left of an icon.
The left panel contains two levels:
The System level always appears at the top of the Navigation panel. It shows the word System and the System icon. There can be only one System per Cloudview session.
The Database level displays the database name next to the Database icon. You can expand the database level to see item types:
Expand an Item Type icon to display all items of that type that exist in the associated database.
The Editing (right) panel changes to reflect the current level selected in the left panel. At each navigation level, you can perform different tasks in the right panel
Whenever a database or database item is selected in the Navigation panel, the top of the right panel always displays three buttons:
At the Database level, you can:
At the Item Type level, you can:
Click the icon in the upper part of the right panel to perform actions appropriate to the current navigation level. This icon is the same as the icon selected in the left panel. Clicking this icon produces the same choices as right-clicking that icon in the left panel.
To cause only the right panel to display, choose Details Only from the View menu.
Some tasks are performed using the menu bar rather than the panels in the Cloudview Window. You can perform certain actions using either the menu bar or the panels. Use the menu bar to perform the following tasks:
Cloudview accesses each database through a particular connection. The connection properties can be different for each database.
At any given time, Cloudview is set for default connection properties. A database's connection properties are set at the time the database is opened in Cloudview.
In the URL area of the Properties tab, enter:
In the Log-in area, enter your user name and password, if required.
In the Class field in the Driver area of the Properties window, one of the following values appears, depending on the prefix you have chosen:
If you are using another server framework, enter the appropriate value in the Driver area. For example, if you are using RmiJdbc, enter RmiJdbc.RJDriver in the Driver area.
If you connect to a database that requires upgrading to the current version of Cloudscape, a dialog box appears when you try to make the connection.
Note that once you have set the connection properties within Cloudview, they remain the same until you change them again, even if you shut down and relaunch Cloudview.
This section covers the following topics:
When you create a new database in Cloudview, the database's connection properties are inherited from the connection settings in Cloudview. Before creating a new database, you may want to check the current connection properties. For information on connection properties, see Working with Connections.
NOTE: To modify which drives are accessible from Cloudview directory browser, see the Configuring Cloudview section.
NOTE: You can change a non-source database to be a source database after creation using the convertTargetToSource property. For more information, see the Synchronization Guide.
You can open an existing database using one of the following:
Cloudview keeps a history list of databases on its File menu. To open a previously-opened database, choose from the history list on the File menu.
To open an existing database using a file browser:
NOTE: To automatically open a database when Cloudview opens, specify the database name on the command line when you launch Cloudview.
To close the connection to a database, choose the database in the left panel. Then do one of the following:
Note that closing the connection to a database does not shut it down. To shut down the database, exit Cloudview.
You can submit any SQL-J statement from within Cloudview. If the statement returns results, they appear in a grid in the bottom window.
The status bar under the bottom window displays the number of database rows affected. It also displays the compilation and execution time for the statement.
Use Cloudview's Database level to execute SQL-J statements.
This section covers the following topics:
To execute SQL-J statements against a database:
Results appear in the bottom window.
NEW: The ability to execute statements using <Ctrl-e> is new in version 3.0.
Results are displayed as each statement is executed. The statement that is currently executing is highlighted. If you click the Stop button while the statements are running, partial results are displayed for the statement running at the time execution is halted. If you do not stop execution, only the results from the final query are displayed after execution completes.
When you change the database by executing an SQL-J statement, the changes are automatically saved. SQL-J is always executed in auto-commit mode in Cloudview.
NOTE: It can be useful to open two Cloudview windows, one set to the SQL window in Details Only mode. This makes it easy to browse the database without having to navigate back to the SQL window each time you want to execute an SQL-J statement.
To execute SQL-J statements from a file:
The contents of the file appear in the SQL window.
If any queries are executed, their results appear in the bottom window.
To save the SQL-J batch that appears in the SQL window to a new file:
To save the batch to the same file, click the Script icon, then Save. The file you specify is overwritten each time you save the SQL-J batch. To save the batch to another file, choose Save As from the Script icon and specify another file name.
Auto text lets you build an SQL statement by pointing to the words you want to include in the statement.
To use auto text, click the Auto Text icon above the SQL window.
To include the name of an existing table:
To include the name of an existing view:
To include the name of a column:
Runtime statistics provide information about how a query is processed within Cloudscape. To make statistics available, click the Use Statistics box above the SQL window. To see the statistics, choose the Statistics tab after executing an SQL-J statement.
For information on using runtime statistics within Cloudview, see Tuning Cloudscape.
To stop a query while it is executing, click the Stop button beneath the bottom window. The query is stopped just before the next row is fetched. The status bar indicates how many rows have been fetched in the result so far, as well as the compilation and execution time for the terminated query.
To see statements that were run earlier on the current database, use the forward and back arrows above the SQL window.
If you issue multiple statements in a batch and then use the arrows, the entire batch appears in the window.
To execute a statement that was previously run on another database:
By default, database items that you create in the SQL window are case-insensitive and are represented internally as all uppercase. If you want to preserve the case of an item, use double quotes (") around the item.
For example, the following statement in the SQL window creates a table whose name is case-insensitive and appears in the left panel as "MYTABLE":
create table MyTable (counter int)
However, the following statement creates a table whose name is case-sensitive and appears in the left panel as "MyTable":
create table "MyTable" (counter int)
The following query retrieves data from "MYTABLE" but not from "MyTable", since case-insensitivity is assumed:
select * from MyTable
See the Cloudscape Reference Manual for more information on case sensitivity in SQL-J.
Case sensitivity is handled differently if you create items in the SQL window than if you create the items directly using Cloudview tools. See Case Sensitivity in Table and Column Names for details.
This section covers the following topics:
To view the tables in a database:
To view the columns in a table:
Information about the table's columns appears in a grid on the bottom of the right panel. The name of each column is listed under Name in the grid. The grid is read-only.
The grid contains the following fields for each column in the table:
To view the indexes defined on a table:
A list of the table's indexes appears in the right panel.
For a more detailed view of indexes, do one of the following:
The right panel then displays three tabs:
In addition to indexes, you can view and define primary, unique, and foreign keys on a table.
To view the keys defined on a table:
A list of the table's keys appears in the right panel. Primary keys display with a P' above the icon.
For a more detailed view of a key, do one of the following:
The right panel then displays two tabs:
To view the check constraints defined on a table:
A list of the table's check constraints appears in the right panel.
For a more detailed view of check constraints, do one of the following:
The right panel then displays two tabs:
When a table is selected in the left panel, the table's Properties tab displays the following information:
To view the statement that created a table:
The statement that created the table appears in the right panel. Below it is the statement that can drop the table, as well as statements to create and drop any indexes, keys, and check constraints on the table. These statements are read-only; you cannot modify or run them from this window. However, you can copy them into the SQL field on the Database panel, where you can save, edit, and execute them (see Executing SQL-J Statements).
Cloudview lets you browse data in a table. Cloudview also allows you to add, delete, or change any data of a SQL-J (non-Java-object) data type.
To view or alter data in a table:
Built-in data type values appear in the table grid. If a column contains a Java object, the object's toString value appears.
NOTE: Cloudview displays a BIT and BIT VARYING value containing 128 bytes or fewer as a hex string. You can copy the hex string, but you cannot alter it. If the BIT or BIT VARYING value is a gif, it is displayed as an image, otherwise nothing is displayed.
When you first choose to see the data in a table, the first one thousand rows are loaded. To load all the data in the table, click the "Load all" icon above the results grid. To load only the next one thousand rows, click the "Load next 1000 rows" icon.
To inspect a Java object within the table, choose it and click the Inspect icon (see Inspecting Java Objects).
You can also use a table's Data tab to add, delete, or modify data of a SQL-J (non-Java-Object) data type.
To modify data, click the field you want to alter and make the changes you want.
To add a row, click the Insert icon (plus sign) above the grid. A blank row appears above the currently selected row.
To delete a row, click the Delete icon above the grid.
NOTE: Changes to a table made in the Data tab are never automatically saved. To save changes, click the Save icon above the grid.
By default, system tables do not appear in Cloudview. To make them visible, check System Tables in the View menu. They appear in the list of tables in each database, and you can inspect them just like user tables.
Querying system tables can provide information about all items in a database, as opposed to only the items associated with a given table. For example, you can see all the indexes in a database by looking at the data in SYSCONGLOMERATES.
This creates a new table with one column. Information about the new table is displayed in the right panel. See Case Sensitivity in Table and Column Names for information about how case is handled in new table names.
Name. The name of the column. See Case Sensitivity in Table and Column Names for information about how case is handled in new column names. Type. The data type of the column. Choose an SQL-J built-in type or SERIALIZE from the drop-down menu. Class. The Java class name. If the data type is SERIALIZE, enter a class name in this column. Length. The length of the column. Alter this value only for CHAR, VARCHAR, BIT, and BIT VARYING columns. Leave this value blank for all other data types. Precision. Enter a precision value only for DECIMAL and NUMERIC columns; leave blank for all other data types. Scale. Enter the number of digits to appear after the decimal point in DECIMAL and NUMERIC columns. Leave blank for other data types. Nullable. Leave the value "Yes" if the column will accept NULLs. If you do not want a column to allow NULLs, choose No from the drop-down menu.
By default, new tables and columns are saved automatically when you move the cursor off the Table tab or Table item. You can also save the table or column before moving the cursor off the item by clicking OK. See Saving New Tables and Columns Automatically for more details.
To create a new index, do one of the following:
The index creation form appears in the right panel. To define the index:
NOTE: Unique Keys and Unique Indexes function the same way. The difference is in the SQL syntax used to create them: a unique index uses the CREATE UNIQUE INDEX statement, and a unique key uses the SQL standard ALTER TABLE ADD CONSTRAINT syntax.
NOTE: The index row must fit on the page, so make sure the page size is large enough.
To create a key, do one of the following:
The key creation form appears in the right panel. Use this form to create a key that is unique, primary, or foreign.
NOTE: Unique Keys function the same way as Unique Indexes. The difference is in the SQL syntax used to create them: a unique index uses the CREATE UNIQUE INDEX statement, and a unique key uses the SQL standard ALTER TABLE ADD CONSTRAINT syntax.
Follow these steps to create a check constraint:
To define the new check constraint:
You can use the Auto Text icon above the Condition field to help you write the condition. To choose a column from the table, click the Auto Text icon, choose Columns, then click the column you want. To add a comparator or other keyword, click the Auto Text icon, choose Key Words, then click the key word and symbol you want. You may have to type in the Condition field even if you use auto text. For example, to allow only values greater than 0 in the ID column, use auto text to choose the ID column and the ">" operator, then type 0 directly in the Condition field.
By default, table and column names are case-insensitive and are created as all uppercase. To create case-sensitive table and column names at the item level:
You can also use the SQL window at the Database level to create case-sensitive table and column names. Case is handled differently inside the SQL window; see Case Sensitivity in the SQL Window for details.
By default, all changes you make in Cloudview are saved automatically. If you want to be prompted to confirm the changes you have made:
If you have configured Cloudview to prompt you about changes:
NOTE: Changes to a table using the Data tab are never saved automatically; you must use the Save icon. See Viewing and Modifying Data in a Table for details.
To remove a table or tables from the database:
You can also remove an individual table as follows:
To remove indexes or keys from the database:
You can also remove an individual index or key as follows:
To remove check constraints from the database:
You can also remove an individual check constraint as follows:
This section covers the following topics:
The view panel displays in the right panel.
NEW: The ability to create views from Cloudview is new in version 3.0.
To view the statement that created a view:
The statement that created the view appears in the Query window in the right panel.
Built-in data type values appear in a table grid in the bottom pane. If a column contains an object, the object's toString value appears. To inspect the object, choose it and click the Inspect button (see Inspecting Java Objects).
To stop loading data while the view statement is executing, click the Stop button.
You can import data into an existing table, or export data from a table or view into a file.
This section covers the following topics:
Cloudview uses two types of files when importing and exporting data:
To import data into a table or export data from a table or view:
The title bar of the Import/Export window indicates the name of the table or view that you are importing data into or exporting data from.
Use Advanced Import/Export to import or export data using custom or explicit settings for separators, column definitions, field start and end characters, or to import/export using a control file. To perform Simple Import/Export, use the General tab of the Import/Export window.
Use the General tab to perform a simple import/export. In a simple import/export, you can optionally specify a delimiter symbol and quote characters or strings.
For example, you could use the default settings to export or import the following data:
"barbie","9.50","0"
"beanie baby elephant","6.50","0"
Use the Advanced tab to perform an import/export under the following conditions:
If you are importing/exporting delimited fields, see Delimited Data. If you are importing or exporting fixed-width fields, see Fixed-Width Data.
Use the Advanced tab to import/export delimited or fixed width data, data with explicit column definitions, or data with custom field and record separators. You can also choose whether to replace a table's existing data on import.
You can specify the following values:
All these settings (except Column Definition, which is either true or false) can be either single characters or strings. You can indicate a tab with "\t" and a backslash with "\\".
For example, the following settings:
Field Separator: Semicolon
Field Start: `
Field End: '
Record Separator: Empty line
Column Definition: true
might export the following data into the data file:
`TOY' `PRICE' `QUANTITY'
`barbie';`9.50';`0'
`beanie baby elephant';`6.50';`0'
To create or read from a data file that uses fixed-width columns instead of field separators:
Set the record separator in the Record Separator field, and enter the string that represents null values in the Null field.
The table or view column names and (for export) default column widths appear in a grid. If the default widths are acceptable, click OK. If you want to change the defaults, do one of the following:
Control files store data file formatting information.
To save the current Import/Export window settings to a control file:
To retrieve settings from a control file:
NOTE: Use Cloudview, not a text editor, to create and alter control files. Control file formats may change from release to release. Cloudscape supports creating and changing control files only if performed using Cloudview.
Cloudview lets you work with method aliases and work unit aliases.
This section covers the following topics:
For Method Aliases, enter the alias name, class name, and method name. For Work Unit Alias, enter the alias name as well as the class and method names for both source and target. Click OK after the fields are filled in.
To see an alias's type and method(s):
To see the statement that created the alias:
You can also right-click the alias you want to delete in the left panel, then choose Delete from the popup menu.
You can create and compile Stored Statements from Cloudview. This section discusses:
To create a new Stored Statement:
Follow the steps in this section to view existing Stored Statements, or system Stored Statements.
If a stored statement definition has changed since it was last compiled, you can recompile it from Cloudview.
NOTE: The Parameters field is only enabled if the Query contains a placeholder (such as ?").
You can add existing Jar Files to your database, and then execute or test them from Cloudview.
This section covers the following topics:
After you have added a Jar File, you can execute it from the Jar Files tab.
To view Jar files you have previously added to a database:
To remove a Jar file you have previously added to a database:
A new jar file can be added to an existing definition.
Publications are used only with Cloudsync, Cloudscape's synchronization option. The Publications icon appears in Cloudview only if you have installed Cloudsync. You can only create Publications for databases defined as Source Databases.
NOTE: This section assumes you understand publications in Cloudsync. For information on publications, see the Cloudscape Synchronization Guide.
A publication and the parameters passed to it define a target database. Since a publication is basically a database definition, the tree in the navigation panel below a publication name contains the same objects as the tree below a database name.
This section covers the following topics:
You can create a Publication from any Source database. Designate a database to be a source database at the time you create it, or by using the convertToSource parameter once the database has been created.
Define the following information for new parameters:
NOTE: Keys and Indexes associated with published tables are included implicitly.
NOTE: If you are unable to view or create Publications, verify that Cloudsync is installed, that your database has been created as (or converted to) a source database, and that your system path lists Cloudsync before any other Cloudscape products.
To access an existing publication highlight the publication name in the left panel.
The Publications tab in the right panel shows:
The Items tab displays the database objects included in the publication. This tab is used when creating new publications, and cannot be modified here for existing publications. To modify an existing publication, submit an ALTER PUBLICATION statement in the SQL window for the database.
When a publication is highlighted in the left pane, the SQL tab shows the CREATE and DROP statements for the publication.
To see the list of objects in a publication, expand the publication node in the left panel. Expand an item type node to see the included objects of that type. Highlight an item name to see its properties displayed in the right panel.
To see the views in a publication, click the Views icon under Publications in the left panel.
The views in the publication are displayed in the right panel.
To see which view columns are included in a publication, double-click the view item in the Views list, or choose the view item directly in the left panel. The published columns of that view are checked in the Included column.
To see the indexes and keys in a publication:
The indexes and unique constraints included in the publication are checked in the Included column.
To see the check constraints in a publication:
The check constraints included in the publication appear in the right panel.
work units in the publication are listed in the right panel.
When you are finished entering all the parameters, click OK.
To delete a publication, highlight the publication name in the left panel, then choose Delete.
The refresh operation synchronizes a target database with the source database. It is run at a target database.
To run the refresh operation from within Cloudview, choose the target database in the left panel, then do one of the following:
For more information on the refresh operation, see the Cloudscape Synchronization Guide.
Java objects can appear in the data grid of a table or view, or in SQL query results. To inspect Java objects:
This section covers the following topics:
To view an object's fields, click the "+" sign that appears to the left of the class name.
The names of the object's fields appear. If a field is public, its contents appear, if they are displayable. If the field is not public, its visibility level (e.g., private, protected) appears instead.
If the field is an array or vector, click the "+" sign to the left of the field to inspect its contents.
To view an object's methods, select the object. Its public methods appear in the right-hand window.
If an object's class is a subclass, you can view the methods of any superclasses. To do this, select the class bar at the top of the right-hand side of the window.
If an object's class implements an interface, you can view the interface's methods:
The drop-down list now contains the interfaces the object implements.
If a public method takes no parameters, you can execute it in Cloudview. To do this, select the method and click Execute. The value returned, if any, appears in the box in the lower right-hand corner.
If the method supplies a way to display a graphics, sound, or multimedia file, you can hear or see the file's contents.
When you start Cloudview for the first time, a log file and a properties file are created: SysVisual.log and SysVisual.properties. Cloudview uses information in these files upon subsequent startups. While it is inadvisable to modify these files in general, you may need to add a property to the SysVisuals.properties file.
Use the SysVisual.drives property to explicitly specify which drives are accessible from Cloudview. This property can be useful when trying to see an optional drive (such as the A: drive or a zip drive), or when For more information, see the Cloudscape Release Notes.
Cloudview creates and stores stored prepared statements in any databases that you examine with the tool. Cloudview stores these in a schema called SYSVISUAL.
Cloudview creates a file called SysVisual.LOG in the directory from which Cloudview is started. This file contains messages about the Cloudview session that you should provide to Technical Support when reporting any problems you may encounter when using Cloudview.
Cloudview creates a file called SysVisual.properties in the directory from which Cloudview is started. It contains state information about which driver to load, what databases were connected, and so on. You can remove this file to restore the default settings. Do not edit this file.