#[non_exhaustive]pub struct DescribeStatementOutput {Show 21 fields
pub id: String,
pub secret_arn: Option<String>,
pub db_user: Option<String>,
pub database: Option<String>,
pub cluster_identifier: Option<String>,
pub duration: i64,
pub error: Option<String>,
pub status: Option<StatusString>,
pub created_at: Option<DateTime>,
pub updated_at: Option<DateTime>,
pub redshift_pid: i64,
pub has_result_set: Option<bool>,
pub query_string: Option<String>,
pub result_rows: i64,
pub result_size: i64,
pub redshift_query_id: i64,
pub query_parameters: Option<Vec<SqlParameter>>,
pub sub_statements: Option<Vec<SubStatementData>>,
pub workgroup_name: Option<String>,
pub session_id: Option<String>,
pub result_format: Option<ResultFormatString>,
/* private fields */
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.id: StringThe identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
secret_arn: Option<String>The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
db_user: Option<String>The database user name.
database: Option<String>The name of the database.
cluster_identifier: Option<String>The cluster identifier.
duration: i64The amount of time in nanoseconds that the statement ran.
error: Option<String>The error message from the cluster if the SQL statement encountered an error while running.
status: Option<StatusString>The status of the SQL statement being described. Status values are defined as follows:
-
ABORTED - The query run was stopped by the user.
-
ALL - A status value that includes all query statuses. This value can be used to filter results.
-
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.
created_at: Option<DateTime>The date and time (UTC) when the SQL statement was submitted to run.
updated_at: Option<DateTime>The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.
redshift_pid: i64The process identifier from Amazon Redshift.
has_result_set: Option<bool>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.
query_string: Option<String>The SQL statement text.
result_rows: i64Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.
result_size: i64The size in bytes of the returned results. A -1 indicates the value is null.
redshift_query_id: i64The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.
query_parameters: Option<Vec<SqlParameter>>The parameters for the SQL statement.
sub_statements: Option<Vec<SubStatementData>>The SQL statements from a multiple statement run.
workgroup_name: Option<String>The serverless workgroup name or Amazon Resource Name (ARN).
session_id: Option<String>The session identifier of the query.
result_format: Option<ResultFormatString>The data format of the result of the SQL statement.
Implementations§
Source§impl DescribeStatementOutput
impl DescribeStatementOutput
Sourcepub fn id(&self) -> &str
pub fn id(&self) -> &str
The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
Sourcepub fn secret_arn(&self) -> Option<&str>
pub fn secret_arn(&self) -> Option<&str>
The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
Sourcepub fn cluster_identifier(&self) -> Option<&str>
pub fn cluster_identifier(&self) -> Option<&str>
The cluster identifier.
Sourcepub fn error(&self) -> Option<&str>
pub fn error(&self) -> Option<&str>
The error message from the cluster if the SQL statement encountered an error while running.
Sourcepub fn status(&self) -> Option<&StatusString>
pub fn status(&self) -> Option<&StatusString>
The status of the SQL statement being described. Status values are defined as follows:
-
ABORTED - The query run was stopped by the user.
-
ALL - A status value that includes all query statuses. This value can be used to filter results.
-
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.
Sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The date and time (UTC) when the SQL statement was submitted to run.
Sourcepub fn updated_at(&self) -> Option<&DateTime>
pub fn updated_at(&self) -> Option<&DateTime>
The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.
Sourcepub fn redshift_pid(&self) -> i64
pub fn redshift_pid(&self) -> i64
The process identifier from Amazon Redshift.
Sourcepub fn has_result_set(&self) -> Option<bool>
pub fn has_result_set(&self) -> Option<bool>
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.
Sourcepub fn query_string(&self) -> Option<&str>
pub fn query_string(&self) -> Option<&str>
The SQL statement text.
Sourcepub fn result_rows(&self) -> i64
pub fn result_rows(&self) -> i64
Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.
Sourcepub fn result_size(&self) -> i64
pub fn result_size(&self) -> i64
The size in bytes of the returned results. A -1 indicates the value is null.
Sourcepub fn redshift_query_id(&self) -> i64
pub fn redshift_query_id(&self) -> i64
The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.
Sourcepub fn query_parameters(&self) -> &[SqlParameter]
pub fn query_parameters(&self) -> &[SqlParameter]
The parameters for the SQL statement.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .query_parameters.is_none().
Sourcepub fn sub_statements(&self) -> &[SubStatementData]
pub fn sub_statements(&self) -> &[SubStatementData]
The SQL statements from a multiple statement run.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sub_statements.is_none().
Sourcepub fn workgroup_name(&self) -> Option<&str>
pub fn workgroup_name(&self) -> Option<&str>
The serverless workgroup name or Amazon Resource Name (ARN).
Sourcepub fn session_id(&self) -> Option<&str>
pub fn session_id(&self) -> Option<&str>
The session identifier of the query.
Sourcepub fn result_format(&self) -> Option<&ResultFormatString>
pub fn result_format(&self) -> Option<&ResultFormatString>
The data format of the result of the SQL statement.
Source§impl DescribeStatementOutput
impl DescribeStatementOutput
Sourcepub fn builder() -> DescribeStatementOutputBuilder
pub fn builder() -> DescribeStatementOutputBuilder
Creates a new builder-style object to manufacture DescribeStatementOutput.
Trait Implementations§
Source§impl Clone for DescribeStatementOutput
impl Clone for DescribeStatementOutput
Source§fn clone(&self) -> DescribeStatementOutput
fn clone(&self) -> DescribeStatementOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for DescribeStatementOutput
impl Debug for DescribeStatementOutput
Source§impl PartialEq for DescribeStatementOutput
impl PartialEq for DescribeStatementOutput
Source§impl RequestId for DescribeStatementOutput
impl RequestId for DescribeStatementOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.impl StructuralPartialEq for DescribeStatementOutput
Auto Trait Implementations§
impl Freeze for DescribeStatementOutput
impl RefUnwindSafe for DescribeStatementOutput
impl Send for DescribeStatementOutput
impl Sync for DescribeStatementOutput
impl Unpin for DescribeStatementOutput
impl UnwindSafe for DescribeStatementOutput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);