Administration Tool

To see a summary of commands, run the administration tool with no arguments:

tibdg

To see information about a specific command or command area, run the administration tool with that command as an argument. For example:

tibdg copyset

tibdg table

tibdg status

Administration tool commands interact with the realm server:

• Storing definitions in the realm server
• Retrieving definitions from the realm server
• Retrieving status information from the realm server

Every interaction command requires the location of the realm server, either as an argument or as the value of an environment variable.

You can use the administration tool in two ways:

• Immediate command execution When you execute a tibdg command line, the tool makes the change in the realm server workspace, and immediately deploys that change to the realm server's clients (namely, data grid component processes).

  This mode is convenient for changes to a running data grid (such as adding a new table), for saving the data grid definition to a file, and for requesting status information about a running data grid.

• Command script Alternatively, you can create a command script file containing several commands. Then tibdg executes that batch of commands, accumulating those changes in the realm server workspace. Finally, the tool deploys all the workspace changes to the realm server's clients before exiting.

  This mode is convenient for for a series of related changes, such as defining a data grid, or creating a table and its columns.

Consider the following two examples, which accomplish the same goal: defining a data grid. The first example executes five separate command lines, deploying each change immediately.

tibdg grid create 
tibdg copyset create my_copyset
tibdg node create my_node
tibdg keeper create my_keeper
tibdg proxy create my_proxy

In contrast, the second example consists of five commands in a script file, my_script_file.tibdg:

grid create 
copyset create my_copyset
node create my_node
keeper create my_keeper
proxy create my_proxy

Then it executes the script with one command line, deploying all the changes at the end.

tibdg -s my_script_file.tibdg