3.26.3. Parameters for the dbtool
Prev | 3.26. Using the dbtool client to import, delete and export from the command line | Next

### 3.26.3. Parameters for the dbtool

1. Once you have browsed to the installation directory and entered dbtool, you can enter the parameters for the database actions.

2. The dbtool uses the parameters described in the table (Table 3.3, “dbtool parameters”):

Detail | Parameter
--- | ---
Help | -h Gives parameter help
Delete Project | -delete <project-name project-version> e.g. -delete "ExampleProject" 1.0 For information on keeping test result summaries, see the section later (Section 3.26.3.1, “Deleting Projects but keeping test result summaries”). For information on how to enter version numbers, see the section below (Section 3.26.3.5, “Entering version numbers in the DB Tool”)
Delete All | -deleteall e.g. -deleteall For information on keeping test result summaries, see the section later (Section 3.26.3.1, “Deleting Projects but keeping test result summaries”).
Keep test result summaries | -keepsummary (optional) e.g. -keepsummary (Section 3.26.3.1, “Deleting Projects but keeping test result summaries”)
Delete test result summaries | -deletesummaries e.g. -deletesummaries Deletes all test result summaries and their details. To specify a certain group of summaries and their details that should deleted use the additional parameters: -days, -project and -version. (Section 3.26.3.2, “Deleting test result summaries”)
Delete test result details | -deleteresultdetails e.g. -deleteresultdetails Deletes all test result details. Test result summaries will not be deleted. To specify a certain group of details that should be deleted use the additional parameters: -days, -project and -version. (Section 3.26.3.3, “Deleting test result details”)
Days | -days <days> (optional) e.g. -days 5 You can delete the test result summaries or test result details that are older than the given days. (Section 3.26.3.3, “Deleting test result details”) (Section 3.26.3.2, “Deleting test result summaries”)
Project | -project <project-name> (optional) Delete test result summaries or details of a project. e.g. -project "ExampleProject" (Section 3.26.3.3, “Deleting test result details”) (Section 3.26.3.2, “Deleting test result summaries”)
Version | -version <project-version> (optional) Delete test result summaries or results of a project version. If the project version is defined, the project name must be set. e.g. -version 1.0 (Section 3.26.3.3, “Deleting test result details”) (Section 3.26.3.2, “Deleting test result summaries”)
Directory | -directory <directory path> e.g. -directory "<pathToQADocs>/projects" The directory for imports and/or exports The directory must already exist
Export Project | -export <project-name project-version> e.g. -export "ExampleProject" "1.0" Existing files with the same name will be overwritten. For information on how to enter version numbers, see the section below (Section 3.26.3.5, “Entering version numbers in the DB Tool”).
Export All | -exportall e.g. -exportall The directory for the export all must be empty The directory must already exist
Import Project | -import <import-file> e.g. -import <ExampleProject.jub>
Create Version | -createVersion <project-name> <old-version> <new-version> e.g. -createVersion "MyProject" "1.0" "1.1" For information on versioning projects, see: Section 3.26.3.4, “Creating new versions of Projects” For information on how to enter version numbers, see the section below (Section 3.26.3.5, “Entering version numbers in the DB Tool”).
Workspace | -data <path to workspace> e.g. -data "<pathToQADocs>/workspace" The ITE workspace with the preference settings for the database connection This is optional if you enter the -dburl parameter
Database scheme | -dbscheme <scheme> e.g. -dbscheme "Oracle" This is optional if you enter the -dburl parameter
Database username | -dbuser <username> e.g. -dbuser "username" Use sa (without quotes) for the embedded database
Database password | -dbpw <password> e.g. -dbpw "password" Use <empty> ("") for the embedded database
Database URL (optional) | -dburl <URL> e.g. -dburl "db.example.de" If no URL is given, the default will be used. If you enter this, you do not need to enter the -data or -dbscheme parameter You can find the dburl in the database preferences

Table 3.3. dbtool parameters

#### 3.26.3.1. Deleting Projects but keeping test result summaries

You can use the parameter -keepsummary to specify that the test result summaries should not be deleted when the Project or Projects are deleted. This is useful for continuous integration processes, where the test results over time should be kept, but the Projects are reimported into the database (for example from the version control system) each night. If you do not enter this parameter, the summaries will be deleted with the Projects.

#### 3.26.3.2. Deleting test result summaries

You can use the parameter -deletesummaries to specify that the test result summaries should be deleted. You can also specify for which project and version the test result summaries will be deleted. Use days parameter to delete test result summaries, that are older than the given days.

#### 3.26.3.3. Deleting test result details

You can use the parameter -deleteresultdetails to specify that the test result details should be deleted. The related test result summaries will not be deleted. You can specify for which project and version the test result details will be deleted. Use days parameter to delete only test result details, that are older than the given days.

#### 3.26.3.4. Creating new versions of Projects

You can use the dbtool to create a new version of a Project that already exists in the database. You enter the Project name, the version you want to create a copy of, and the new version number that the Project should be created under. The create new version command functions in the same way as the create new version option in the ITE (Section 3.6.11, “Versioning Projects”). If the Project is not in the database in the specified version, or if the new version already exists, then the action will fail. We recommend using this when you are sure that no-one is working on the Project.

| If you are using the embedded database, see the section on using the embedded database with the Test Executor for information on which username and password to use (Section 3.25.4, “Using the test executor with the embedded database”).

Once you have entered all the necessary parameters, press »ENTER«.

#### 3.26.3.5. Entering version numbers in the DB Tool

You can enter version numbers such as "1.0.0_release" or "1.0".

If your version only uses a qualifier, you can enter it as e.g. "release". If you are using a qualifier-only version that begins with a number, then you must use a preceding underscore (e.g. "_3").