/AWS1/CL_RSDBTCEXECUTESTMTOUT¶
BatchExecuteStatementOutput
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_id TYPE /AWS1/RSDUUID /AWS1/RSDUUID¶
The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by
BatchExecuteStatment.
iv_createdat TYPE /AWS1/RSDTIMESTAMP /AWS1/RSDTIMESTAMP¶
The date and time (UTC) the statement was created.
iv_clusteridentifier TYPE /AWS1/RSDCLUSTERIDSTRING /AWS1/RSDCLUSTERIDSTRING¶
The cluster identifier. This element is not returned when connecting to a serverless workgroup.
iv_dbuser TYPE /AWS1/RSDSTRING /AWS1/RSDSTRING¶
The database user name.
it_dbgroups TYPE /AWS1/CL_RSDDBGROUPLIST_W=>TT_DBGROUPLIST TT_DBGROUPLIST¶
A list of colon (:) separated names of database groups.
iv_database TYPE /AWS1/RSDSTRING /AWS1/RSDSTRING¶
The name of the database.
iv_secretarn TYPE /AWS1/RSDSECRETARN /AWS1/RSDSECRETARN¶
The name or ARN of the secret that enables access to the database.
iv_workgroupname TYPE /AWS1/RSDWORKGROUPNAMESTRING /AWS1/RSDWORKGROUPNAMESTRING¶
The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.
iv_sessionid TYPE /AWS1/RSDUUID /AWS1/RSDUUID¶
The session identifier of the query.
iv_status TYPE /AWS1/RSDSTATEMENTSTATUSSTRING /AWS1/RSDSTATEMENTSTATUSSTRING¶
The status of the SQL statement. Status values are defined as follows:
ABORTED - The query run was stopped by the user.
FAILED - The query run failed.
FINISHED - The query has finished running.
PICKED - The query has been chosen to be run.
STARTED - The query run has started.
SUBMITTED - The query was submitted, but not yet processed.
iv_redshiftpid TYPE /AWS1/RSDBOXEDLONG /AWS1/RSDBOXEDLONG¶
The process identifier from Amazon Redshift.
iv_hasresultset TYPE /AWS1/RSDBOXEDBOOLEAN /AWS1/RSDBOXEDBOOLEAN¶
A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.
Queryable Attributes¶
Id¶
The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by
BatchExecuteStatment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
CreatedAt¶
The date and time (UTC) the statement was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
ClusterIdentifier¶
The cluster identifier. This element is not returned when connecting to a serverless workgroup.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLUSTERIDENTIFIER() |
Getter for CLUSTERIDENTIFIER, with configurable default |
ASK_CLUSTERIDENTIFIER() |
Getter for CLUSTERIDENTIFIER w/ exceptions if field has no v |
HAS_CLUSTERIDENTIFIER() |
Determine if CLUSTERIDENTIFIER has a value |
DbUser¶
The database user name.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DBUSER() |
Getter for DBUSER, with configurable default |
ASK_DBUSER() |
Getter for DBUSER w/ exceptions if field has no value |
HAS_DBUSER() |
Determine if DBUSER has a value |
DbGroups¶
A list of colon (:) separated names of database groups.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DBGROUPS() |
Getter for DBGROUPS, with configurable default |
ASK_DBGROUPS() |
Getter for DBGROUPS w/ exceptions if field has no value |
HAS_DBGROUPS() |
Determine if DBGROUPS has a value |
Database¶
The name of the database.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATABASE() |
Getter for DATABASE, with configurable default |
ASK_DATABASE() |
Getter for DATABASE w/ exceptions if field has no value |
HAS_DATABASE() |
Determine if DATABASE has a value |
SecretArn¶
The name or ARN of the secret that enables access to the database.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECRETARN() |
Getter for SECRETARN, with configurable default |
ASK_SECRETARN() |
Getter for SECRETARN w/ exceptions if field has no value |
HAS_SECRETARN() |
Determine if SECRETARN has a value |
WorkgroupName¶
The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WORKGROUPNAME() |
Getter for WORKGROUPNAME, with configurable default |
ASK_WORKGROUPNAME() |
Getter for WORKGROUPNAME w/ exceptions if field has no value |
HAS_WORKGROUPNAME() |
Determine if WORKGROUPNAME has a value |
SessionId¶
The session identifier of the query.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SESSIONID() |
Getter for SESSIONID, with configurable default |
ASK_SESSIONID() |
Getter for SESSIONID w/ exceptions if field has no value |
HAS_SESSIONID() |
Determine if SESSIONID has a value |
Status¶
The status of the SQL statement. Status values are defined as follows:
ABORTED - The query run was stopped by the user.
FAILED - The query run failed.
FINISHED - The query has finished running.
PICKED - The query has been chosen to be run.
STARTED - The query run has started.
SUBMITTED - The query was submitted, but not yet processed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
RedshiftPid¶
The process identifier from Amazon Redshift.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REDSHIFTPID() |
Getter for REDSHIFTPID, with configurable default |
ASK_REDSHIFTPID() |
Getter for REDSHIFTPID w/ exceptions if field has no value |
HAS_REDSHIFTPID() |
Determine if REDSHIFTPID has a value |
HasResultSet¶
A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HASRESULTSET() |
Getter for HASRESULTSET, with configurable default |
ASK_HASRESULTSET() |
Getter for HASRESULTSET w/ exceptions if field has no value |
HAS_HASRESULTSET() |
Determine if HASRESULTSET has a value |