Database Plugins

Database Plugins

The database plugin supports the following databases:

  • Access
  • MySQL
  • SQLServer
  • Sybase
  • Oracle (version 12c and later)

The database stores all the required information in the following tables:

  • Group Table
  • Properties Table

See the Property Loader Plugins - Database Table Schemas topic for more information about the required table schemas for this plugin.

The plugin contains the following plugin-specific import and export options:

  • Import Options
  • Export Options

Group Table

The Group Table is used to store information about a property loader group. The default name for this table is ‘GROUP_DESC’. The Group table schema contains following columns:

GROUP_ID —Contains the id of the property loader group. It is the primary key of the groups table and is of type VARCHAR and can contain 64 characters.

NAME —Contains the name of the property loader group. This column can contain null values. The data-type for this column is as follows:

  • Access – LONGTEXT
  • MySQL –VARCHAR(8000)
  • SQLServer –VARCHAR (8000)
  • Sybase –VARCHAR(32767)
  • Oracle – VARCHAR2(4000)

DESCRIPTION — Contains the description of the property loader group. This column can contain null values. The data-type for this column is as follows:

  • Access – LONGTEXT
  • MySQL –VARCHAR(8000)
  • SQLServer –VARCHAR (8000)
  • Sybase –VARCHAR(32767)
  • Oracle – VARCHAR2(4000)

Properties Table

The Properties Table is used to store information about various TestStand properties and their corresponding values. The default name for this table is ‘PROPERTIES’. The Property table schema contains following columns:

ID — This is an auto increment column and is used as primary key for the Property Table.

GROUP_ID — Specifies the id of the property loader group in which the property is present. It is foreign key and references the ‘GROUP_ID’ column of the groups table. It is of type VARCHAR and can contain 64 characters. This is a mandatory column and cannot contain null values or empty strings.

SEQUENCE_FILE_NAME — Contains the name of the target sequence file. This column can contain null values. It is of type VARCHAR and can contain a maximum of 255 characters.

SEQUENCE_NAME — Contains the name of the target sequence. This column can contain null values. It is of type VARCHAR and can contain a maximum of 255 characters.

CATEGORY — Contains the property object category (StationGlobals, FileGlobals, Locals, Parameters or Step[<UniqueStepId>]) for the TestStand property. All object category names must be enclosed in {} , expect Step. This is a mandatory column and cannot contain null values or empty string. The data-type for this column in different database is as follows:

  • Access – LONGTEXT
  • MySQL–VARCHAR(8000)
  • SQLServer–VARCHAR(8000)
  • Sybase –VARCHAR(32767)
  • Oracle – VARCHAR2(4000)

PROPERTY_LOOKUP — Contains the lookup string of TestStand properties or alias names within angular braces. This is a mandatory column and cannot contain null values or empty strings. The data-type for this column in different database is as follows:

  • Access – LONGTEXT
  • MySQL–VARCHAR(8000)
  • SQLServer–VARCHAR(8000)
  • Sybase –VARCHAR(32767)
  • Oracle – VARCHAR2(4000)

VALUE — Contains the value to which the specified of the TestStand property to whose value is exported or to which value is being imported. This column can contain null values. The data-type for this column in different database is as follows:

  • Access – LONGTEXT
  • MySQL–VARCHAR(8000)
  • SQLServer–VARCHAR(8000)
  • Sybase –VARCHAR(32767)
  • Oracle – VARCHAR2(4000)

Import Options

The database plugin contains the following plugin-specific import options:

Table Names — Contains the following options:

  • Group Table — The name of the table in the database from which group information will be used.
  • Properties Table — The name of the table in the database from which property information will be used. The foreign key used in the table should refer to the primary key of the Group table.

Filter Options — The column values that each row must match. Use New and Remove to create a new item in the list and remove currently selected item from the list.

  • Column Name — Specify the name of the column.
  • Expected Value — Specify the expected value of the column.

Validate — Validates that the specified table names in the Group and Properties tables exist in the specified database.

Export Options

The database plugin contains the following plugin-specific export options:

Group Table — The name of the table in the database to which group information will be exported.

Properties Table — The name of the table in the database from which property information will be exported.

Optional Columns To Export — Specifies whether values will be exported to optional columns or not. While performing export, values will be exported to all the optional columns that were checked.

  • Sequence File — Exports the name of the target sequence file into the SEQUENCE_FILE_NAME column in the selected properties table.
  • Sequence — Exports the name of the sequence into the SEQUENCE_NAME column of the selected properties table.
  • Type — Exports the type of TestStand property in the TYPE column of the selected properties table.

Overwrite Existing Records — Specifies if all values in the property table associated with the sequence file in the configured property loader group will be deleted before performing export using the Import/Export tool. When enabled, all the properties which refer to the current sequence file and property loader group will be deleted from the properties table and the new properties will be exported. When disabled, none of the properties will be deleted, and if a property already exists in the properties table in the database then its value will be overwritten.

Note If this option is enabled and Sequence File is checked in Optional Columns to Export , all properties in the properties table which refer to the current property loader group and have the same sequence file name as the sequence file from which properties are being exported will be deleted. If Sequence File is unchecked, all properties in the properties table which refer to the current property loader group and have empty sequence file names will be deleted from the table.