Toolrunner: More Administrative tools

Printer-friendly version
Some of the traditional Objy/DB Admin tools now use a new mechanism of execution known as tool tunner. You can find the change in tool name and tool options below. All tools now require the –bootFile flag with the bootFilePath. The following are a subset of the Objectivity DB Admin tools. More Administrative tools have been added to the tool runner interface which are listed in a separate table after the Tool Runner table.

Here are the list of tools using tool runner:
ooattachdb
oochange
oochangedb
oocheckams
oocheckls
oocleanup
ooconvertformat
oocopydb
oocopyfd
oodeletefd
oodumpcatalog
ooexportfd
ooinstallfd
oolicense
oolistwait
oolockmon
oonewfd
ooschemadump
ooschemaupgrade
ootidy

- The option flag changed
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
ooattachdb AttachDb -db
Only works for non-placement fds.
-filePath
-catalogOnly
-dbmap -mapFile
-id
-host
-nullifyExternals
-standalone
-readOnly
-tidy
-noTitle
-help
-quiet
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
oochange ChangeFd -ap -apName Only works for non-placement fds.
-id -apId
-lockServerHost
-fdNumber
-bootfilehost -newBootFileHost
-bootfilepath -newBootFilePath
-sysFileHost
-sysFilePath
-catalogOnly
-jnlDirHost
-jnlDirPath
-offline
-online
-weight
-readOnlySchema
-readWriteSchema
-lockWait
-noWait
-standalone
-noTitle
-help
-quiet
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
oochangedb ChangeDb -db

-id
-ap -apName
-host
-filePath
-catalogOnly
-moveToAp
-weight
-exists ask Interactive behavior is no longer available. When you use exists, mention whether you want to delete or quit, where quit is the default value if -exists is omitted.
-readOnly

-readWrite
-allContainerFiles
-localContainerFiles
-standalone
-lockWait
-noTitle
-help
-quiet
Tool Name New Tool Name Value Value with New Option Additional Notes
oocheckams CheckAms <hostName> -host <hostName>
Option Flag Changed Option Flag
-noTitle No option changes were made from the old tool.
-help
-quiet
Tool Name New Tool Name Value Value with New Option Additional Notes
oocheckls CheckLs <hostName> -host <hostName>
Option Flag Changed Option Flag
-noTitle No option changes were made from the old tool.
-help
-quiet
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
oocleanup CleanupFd -local

-process
-transaction
Behavior changed to the equivalence of -transaction -deadowner.
-deadHost

-deadowner Tool no longer has this option.
-force
For active transactions, a report is displayed with a summary of possible results, and the user is requested to run the tool again using the -force flag if they wish to proceed with the expected outcome.
-resetLock

-standalone
-allPart
-onePart
-noTitle
-help
-quiet
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
ooconvertformat ConvertFormat -db

-cont
-id
-fd
-all
-check
-format
-from
-lockWait
-showTidy
-convertObjects
N/A - Not Present -standalone
-verbose
-noTitle
-help
-quiet
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
oocopydb CopyDb -db

-id
-host
-filePath
-exists ask Interactive behavior is no longer available. When you use exists, mention whether you want to delete or quit, where quit is the default value if -exists is omitted.
-external

-standalone
-noTitle
-help
-quiet
N/A - Not Present -outfile
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
oocopyfd CopyFd -host No option changes were made from the old tool.
-dirPath
-lockServerHost
-fdName
-exists
-standalone
-fdNumber
-noTitle
-help
-quiet
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
oodeletefd DeleteFd -force Tool no longer has this option. The tool will delete the fd without requiring user confirmation.
-standalone

-noTitle
-help
-quiet
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
oodumpcatalog DumpCatalog -outFile

-exists
-format -filenameDisplayFormat
-noLabel
-control
-ap -apName
-id -apId
-standalone
-noTitle
-help
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
ooexportfd ExportFd -schemaLock
Only works for non-placement fds.
-entireSchema
-nws -noWhiteSpace
-shortNames
-verbose
-stopOnError
-standalone
-standardMaps
-outFile
-maxFileSize
-compress Tool no longer has this option.
-exists ask Interactive behavior is no longer available. When you use exists, mention whether you want to delete or quit, where quit is the default value when -exists is omitted.
-noTitle

-help
-quiet
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
ooinstallfd InstallFd -lockServerHost

N/A - Not Present -fdName
-fdNumber
-fdFileHost
-fdFilePath
-dbDirHost
-dbDirPath
-jnlDirHost
-jnlDirPath
-purgeAps
-licenseFile
-noCheck
N/A - Not Present -noWait
-standalone
-noTitle
-quiet
-help
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
oolicense License -licenseFile No option changes were made from the old tool.
-fromDefault
-toDefault
-standalone
-noTitle
-help
-quiet
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
oolistwait ListWait -transaction No option changes were made from the old tool.
-host
-user
-lockServerHost
-noTitle
-help
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
oolockmon LockMonitor -detail No option changes were made from the old tool.
-host
-noTitle
-help
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
oonewfd CreateFd -fdName
Creates placement-managed fds.
-lockServerHost
-fdDirHost
-fdDirPath
-jnlDirHost
-jnlDirPath
-licenseFile
N/A - Not Present -noPlacement Use -noplacement to create non-placement fds.
-noTitle

-help
-quiet
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
ooschemadump SchemaDump -outFile

-standalone
-encode
-exists ask Interactive behavior is no longer available. When you use exists, mention whether you want to delete or quit, where quit is the default value when -exists is omitted.
-noTitle

-help
-quiet
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
ooschemaupgrade SchemaUpgrade -inFile No option changes were made from the old tool.
-standalone
-noTitle
-help
-quiet
Tool Name New Tool Name Option Flag Changed Option Flag Additional Notes
ootidy Tidy -db No option changes were made from the old tool.
-id
-tmpdirhost
-tmpDirPath
-standalone
-noTitle
-help
-quiet
Here is a list of new tools that were added in R11.0. These were not migrated from the previous release. The –bootFile option is needed when using bootFilePath for these tools as well.

Tool Name Option Flag
ExportPlacement -outFile
-allversions
-noTitle
-help
-quiet
Tool Name Option Flag
ExportSchema -outFile
-overwrite
-includeSystemDefined
-noTitle
-help
-quiet
Tool Name Option Flag
ImportPlacement -inFile
-noTitle
-help
-quiet
Tool Name Option Flag
ImportSchema -inFile
-noTitle
-help
-quiet
Tool Name Option Flag
AddIndex -indexSpecification
-objectPlacer
-level
-noTitle
-help
-quiet
Tool Name Option Flag
AddIndexSpecification -name
-keySpecification
-class
-isUnique
-noTitle
-help
-quiet
Tool Name Option Flag
AddKeySpecification -name
-class
-attribute
-noTitle
-help
-quiet
Tool Name Option Flag
DropIndex -indexSpecification
-objectPlacer
-level
-noTitle
-help
-quiet
Tool Name Option Flag
ListIndexes -outputFormat
-noTitle
-help
-quiet
Tool Name Option Flag
AddStorageLocation -name
-description
-storageLocation
-zone
-dbPlacerGroup
-noTitle
-help
-quiet
Tool Name Option Flag
CreateContainers -count
-group
-storageLocation
-zone
-noTitle
-help
-quiet
Tool Name Option Flag
ListStorage -includeUnavailable
-noTitle
-help
-quiet
Tool Name Option Flag
RemoveStorageLocation -name
-storageLocation
-zone
-dbPlacerGroup
-noTitle
-help
-quiet
Tool Name Option Flag
CrgToXsd -noTitle
-help
-quiet
-inFile
-outFile
You can run the tools by using a command line or by using tool APIs.

When executing the tools via command line, open a command shell and enter the desired tool. For example, type in: objy schemadump -bootfile test.boot. You should see something like this:

Objectivity/DB (TM) Schema Dump Utility, Version: 11.2.0
Copyright (c) Objectivity, Inc 2012, 2013. All rights reserved.

Dumping class ooDotNetDateTime
Dumping class ooDateTime

Schema dumped from Federated Database "test.boot" to file "schema.dmp".

How to execute a tool from an application:

  1. Create and populate a tool-parameters object representing your input to the tool.
    Example: ToolParameters params;
  2. (Optional) Create a tool-output sink for capturing the tool’s output.
    Example: StringToolOutputSink sink;
  3. Call the Tool::execute static method with the name of the tool as a string.
    Example: Tool::execute(“createfd”, params);
    or if you’re using an output sink,
    Tool:execute(“installfd”, params, &sink);
When executing the tools via API calls, write a C++ program where you send the parameters of the tool you wish to run.
For example, if you want to execute DeleteFD using the tool API:
#include <iostream>
#include <objy/Tools.h>

using namespace std;
using namespace objy::tool;

int main(int argc, char* argv[])
{
     ToolParameters params;
     params.add("bootfile", "myFD.boot");

      StringToolOutputSink sink;
     int result = Tool::execute("DeleteFD", params, &sink); //0 means success, 1 means failure

     string normalOutput = sink.getOut();
     string errorOutput = sink.getErr();

     cout << “output: “ << normalOutput << endl;
     cout << “error: “ << errorOutput << endl;

     return 0;
}
You will see the following output on the console:

output: Federated Database myFD.boot successfully deleted

error:
For more information, please refer to Chapters 18 and 19 from the Administrative Guide, which can be viewed from this link: http://support.objectivity.com/docs/objectivity/11_2_0/guide/pdf
Product: 
Objectivity/DB
Version: 
11.2