DbGetCommand Object


Description:

NOTE: It is recommended that you do not use this command, because it accesses the underlying database tables directly, and these tables might change from release to release. Therefore, Spirent cannot supply support for issues encountered by customers using DbGetCommand. It is recommended that you use QueryResultCommand instead, because it protects customers from changes in the underlying tables through the use of pre-configured queries. Spirent intends to maintain backwards compatibility for customers using QueryResultCommand to access results.

Can be used with Command Sequencer: No

Parents: Sequencer

DbGetCommand Writable Attributes

Attribute Description
AttributeList

Specifies which attributes (columns) to return. Use a space-separated list of column names. The default (no argument) returns all columns.

Type: string

Default: "" (empty string)

DatabaseConnectionString

Name of the results database (summary database or iteration file) to open and query.

Type: string

Default: result.db

FileNamePrefix

If you want a CSV output file created, provide the filename prefix for the CSV file. The filename extension will be .csv. The content of the CSV file matches what is returned in the Output attribute.

Type: string

Default: "" (empty string)

Filter

Filters the rows that are returned. The default returns all rows. You can use the following comparison operators:

== (equals)

!= (does not equal)

> (greater than)

>= (greater than or equal to)

< (less than)

<= (less than or equal to)

Example: -filter "TotalTxFrameCount > 50"

This example will return rows that have TotalTxFrameCount values of 75 or 300, but not will not return rows with TotalTxFrameCount values of 48 or 50.

Type: string

Default: "" (empty string)

Parent

If you set this to the handle of the parent of the table that is specified by the Table attribute, the command will return just those rows under the parent.

Type: string

Default: "" (empty string)

ShowGrandparent

Whether to show the grandparent (the parent of the parent) in the output. If the Parent attribute is not used, this attribute is ignored.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Show the grandparent in the output.

FALSE

Do not show the grandparent in the output.

Table

Name of the table to query.

Type: string

Default: "" (empty string)

DbGetCommand Read-Only Attributes

Read-Only Attribute Description
Output

Output of the command in a CSV-formatted string.

Type: string

Default: "" (empty string)