16.10 - UserRemarks - Teradata Database

Teradata Database SQL Request and Transaction Processing

prodname
Teradata Database
vrm_release
16.10
created_date
June 2017
category
Programming Reference
User Guide
featnum
B035-1142-161K

Function of UserRemarks

Stores user comments about captured plans written using either the Teradata System Emulation Tool or Visual EXPLAIN client utilities.

UserRemarks Table Definition

The following CREATE TABLE request defines the UserRemarks table:

   CREATE TABLE UserRemarks(
     QueryID     INTEGER,
     StepID      INTEGER,
     WorkloadID  INTEGER,
     RowType     CHARACTER(1) CHARACTER SET LATIN NOT CASESPECIFIC
                 NOT NULL,
     SeqNumber   INTEGER NOT NULL,
     UpdTime     TIMESTAMP(6) NOT NULL,
     UserName    VARCHAR128 CHARACTER SET UNICODE
                 NOT CASESPECIFIC NOT NULL,
     Remarks     VARCHAR31000 CHARACTER SET UNICODE
                 NOT CASESPECIFIC NOT NULL)
   PRIMARY INDEX (QueryID, UserName);

Attribute Definitions for UserRemarks

The following table defines the UserRemarks table attributes:

Attribute Definition
QueryID The ID of the query about which remarks are being saved.

Partial NUPI for the table.

StepID The ID of the step about which remarks are being saved.
WorkloadID The ID of the workload to which the query belongs.
RowType Specifies which utility collected the remarks and whether they were saved or generated.
  • If T, the comments were generated automatically by the Teradata System Emulation Tool utility during import.
  • If V, the comments were saved by the Visual EXPLAIN utility.
SeqNumber A system-generated number (1 for the first row, 2 for second, and so on) to indicate the sequential order of remarks.
UpdTime The timestamp when the remark was last updated.
UserName The UserName of the user who last updated the row.

Partial NUPI for the table.

Remarks The remarks of the step or query.

UserRemarks Related Topics

See the following books for more information about the Teradata System Emulation Tool and Teradata Visual Explain utilities:

  • Teradata System Emulation Tool User Guide
  • Teradata Visual Explain User Guide