/AWS1/CL_PIEDIMENSIONGROUP

A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions:

• db.sql.id - The hash of a running SQL statement, generated by Performance Insights.

• db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-.

• db.sql.statement - The full text of the SQL statement that is running, for example, SELECT * FROM employees.

• db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_group TYPE /AWS1/PIESANITIZEDSTRING /AWS1/PIESANITIZEDSTRING

The name of the dimension group. Valid values are as follows:

• db - The name of the database to which the client is connected. The following values are permitted:

  • Aurora PostgreSQL

  • Amazon RDS PostgreSQL

  • Aurora MySQL

  • Amazon RDS MySQL

  • Amazon RDS MariaDB

  • Amazon DocumentDB

• db.application - The name of the application that is connected to the database. The following values are permitted:

  • Aurora PostgreSQL

  • Amazon RDS PostgreSQL

  • Amazon DocumentDB

• db.blocking_sql - The SQL queries blocking the most DB load.

• db.blocking_session - The sessions blocking the most DB load.

• db.blocking_object - The object resources acquired by other sessions that are blocking the most DB load.

• db.host - The host name of the connected client (all engines).

• db.plans - The execution plans for the query (only Aurora PostgreSQL).

• db.query - The query that is currently running (only Amazon DocumentDB).

• db.query_tokenized - The digest query (only Amazon DocumentDB).

• db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).

• db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).

• db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB).

• db.user - The user logged in to the database (all engines except Amazon DocumentDB).

• db.wait_event - The event for which the database backend is waiting (all engines except Amazon DocumentDB).

• db.wait_event_type - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).

• db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB).

Optional arguments:

it_dimensions TYPE /AWS1/CL_PIESANITIZEDSTRLIST_W=>TT_SANITIZEDSTRINGLIST TT_SANITIZEDSTRINGLIST

A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.

Valid values for elements in the Dimensions array are:

• db.application.name - The name of the application that is connected to the database. Valid values are as follows:

  • Aurora PostgreSQL

  • Amazon RDS PostgreSQL

  • Amazon DocumentDB

• db.blocking_sql.id - The ID for each of the SQL queries blocking the most DB load.

• db.blocking_sql.sql - The SQL text for each of the SQL queries blocking the most DB load.

• db.blocking_session.id - The ID for each of the sessions blocking the most DB load.

• db.blocking_object.id - The ID for each of the object resources acquired by other sessions that are blocking the most DB load.

• db.blocking_object.type - The object type for each of the object resources acquired by other sessions that are blocking the most DB load.

• db.blocking_object.value - The value for each of the object resources acquired by other sessions that are blocking the most DB load.

• db.host.id - The host ID of the connected client (all engines).

• db.host.name - The host name of the connected client (all engines).

• db.name - The name of the database to which the client is connected. Valid values are as follows:

  • Aurora PostgreSQL

  • Amazon RDS PostgreSQL

  • Aurora MySQL

  • Amazon RDS MySQL

  • Amazon RDS MariaDB

  • Amazon DocumentDB

• db.query.id - The query ID generated by Performance Insights (only Amazon DocumentDB).

• db.query.db_id - The query ID generated by the database (only Amazon DocumentDB).

• db.query.statement - The text of the query that is being run (only Amazon DocumentDB).

• db.query.tokenized_id

• db.query.tokenized.id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).

• db.query.tokenized.db_id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).

• db.query.tokenized.statement - The text of the query digest (only Amazon DocumentDB).

• db.session_type.name - The type of the current session (only Amazon DocumentDB).

• db.sql.id - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).

• db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi- (all engines except Amazon DocumentDB).

• db.sql.statement - The full text of the SQL statement that is running, as in SELECT * FROM employees (all engines except Amazon DocumentDB)

• db.sql.tokenized_id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). The db.sql.tokenized_id dimension fetches the value of the db.sql_tokenized.id dimension. Amazon RDS returns db.sql.tokenized_id from the db.sql dimension group.

• db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.

• db.sql_tokenized.db_id - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as pi-2372568224 that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).

• db.sql_tokenized.statement - The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id = ? (all engines except Amazon DocumentDB)

• db.user.id - The ID of the user logged in to the database (all engines except Amazon DocumentDB).

• db.user.name - The name of the user logged in to the database (all engines except Amazon DocumentDB).

• db.wait_event.name - The event for which the backend is waiting (all engines except Amazon DocumentDB).

• db.wait_event.type - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).

• db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).

• db.wait_state.name - The event for which the backend is waiting (only Amazon DocumentDB).

iv_limit TYPE /AWS1/PIELIMIT /AWS1/PIELIMIT

The maximum number of items to fetch for this dimension group.

---

Queryable Attributes

Group

The name of the dimension group. Valid values are as follows:

• db - The name of the database to which the client is connected. The following values are permitted:

  • Aurora PostgreSQL

  • Amazon RDS PostgreSQL

  • Aurora MySQL

  • Amazon RDS MySQL

  • Amazon RDS MariaDB

  • Amazon DocumentDB

• db.application - The name of the application that is connected to the database. The following values are permitted:

  • Aurora PostgreSQL

  • Amazon RDS PostgreSQL

  • Amazon DocumentDB

• db.blocking_sql - The SQL queries blocking the most DB load.

• db.blocking_session - The sessions blocking the most DB load.

• db.blocking_object - The object resources acquired by other sessions that are blocking the most DB load.

• db.host - The host name of the connected client (all engines).

• db.plans - The execution plans for the query (only Aurora PostgreSQL).

• db.query - The query that is currently running (only Amazon DocumentDB).

• db.query_tokenized - The digest query (only Amazon DocumentDB).

• db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).

• db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).

• db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB).

• db.user - The user logged in to the database (all engines except Amazon DocumentDB).

• db.wait_event - The event for which the database backend is waiting (all engines except Amazon DocumentDB).

• db.wait_event_type - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).

• db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB).

Accessible with the following methods

Method	Description
GET_GROUP()	Getter for GROUP, with configurable default
ASK_GROUP()	Getter for GROUP w/ exceptions if field has no value
HAS_GROUP()	Determine if GROUP has a value

Dimensions

A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.

Valid values for elements in the Dimensions array are:

• db.application.name - The name of the application that is connected to the database. Valid values are as follows:

  • Aurora PostgreSQL

  • Amazon RDS PostgreSQL

  • Amazon DocumentDB

• db.blocking_sql.id - The ID for each of the SQL queries blocking the most DB load.

• db.blocking_sql.sql - The SQL text for each of the SQL queries blocking the most DB load.

• db.blocking_session.id - The ID for each of the sessions blocking the most DB load.

• db.blocking_object.id - The ID for each of the object resources acquired by other sessions that are blocking the most DB load.

• db.blocking_object.type - The object type for each of the object resources acquired by other sessions that are blocking the most DB load.

• db.blocking_object.value - The value for each of the object resources acquired by other sessions that are blocking the most DB load.

• db.host.id - The host ID of the connected client (all engines).

• db.host.name - The host name of the connected client (all engines).

• db.name - The name of the database to which the client is connected. Valid values are as follows:

  • Aurora PostgreSQL

  • Amazon RDS PostgreSQL

  • Aurora MySQL

  • Amazon RDS MySQL

  • Amazon RDS MariaDB

  • Amazon DocumentDB

• db.query.id - The query ID generated by Performance Insights (only Amazon DocumentDB).

• db.query.db_id - The query ID generated by the database (only Amazon DocumentDB).

• db.query.statement - The text of the query that is being run (only Amazon DocumentDB).

• db.query.tokenized_id

• db.query.tokenized.id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).

• db.query.tokenized.db_id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).

• db.query.tokenized.statement - The text of the query digest (only Amazon DocumentDB).

• db.session_type.name - The type of the current session (only Amazon DocumentDB).

• db.sql.id - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).

• db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi- (all engines except Amazon DocumentDB).

• db.sql.statement - The full text of the SQL statement that is running, as in SELECT * FROM employees (all engines except Amazon DocumentDB)

• db.sql.tokenized_id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). The db.sql.tokenized_id dimension fetches the value of the db.sql_tokenized.id dimension. Amazon RDS returns db.sql.tokenized_id from the db.sql dimension group.

• db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.

• db.sql_tokenized.db_id - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as pi-2372568224 that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).

• db.sql_tokenized.statement - The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id = ? (all engines except Amazon DocumentDB)

• db.user.id - The ID of the user logged in to the database (all engines except Amazon DocumentDB).

• db.user.name - The name of the user logged in to the database (all engines except Amazon DocumentDB).

• db.wait_event.name - The event for which the backend is waiting (all engines except Amazon DocumentDB).

• db.wait_event.type - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).

• db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).

• db.wait_state.name - The event for which the backend is waiting (only Amazon DocumentDB).

Accessible with the following methods

Method	Description
GET_DIMENSIONS()	Getter for DIMENSIONS, with configurable default
ASK_DIMENSIONS()	Getter for DIMENSIONS w/ exceptions if field has no value
HAS_DIMENSIONS()	Determine if DIMENSIONS has a value

Limit

The maximum number of items to fetch for this dimension group.

Accessible with the following methods

Method	Description
GET_LIMIT()	Getter for LIMIT, with configurable default
ASK_LIMIT()	Getter for LIMIT w/ exceptions if field has no value
HAS_LIMIT()	Determine if LIMIT has a value