Class: Aws::RedshiftDataAPIService::Types::SubStatementData

Inherits:

Struct

• Object
• Struct
• Aws::RedshiftDataAPIService::Types::SubStatementData

Defined in:

gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb

Overview

Information about an SQL statement.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  The date and time (UTC) the statement was created.

• #duration ⇒ Integer

  The amount of time in nanoseconds that the statement ran.

• #error ⇒ String

  The error message from the cluster if the SQL statement encountered an error while running.

• #has_result_set ⇒ Boolean

  A value that indicates whether the statement has a result set.

• #id ⇒ String

  The identifier of the SQL statement.

• #query_string ⇒ String

  The SQL statement text.

• #redshift_query_id ⇒ Integer

  The SQL statement identifier.

• #result_rows ⇒ Integer

  Either the number of rows returned from the SQL statement or the number of rows affected.

• #result_size ⇒ Integer

  The size in bytes of the returned results.

• #status ⇒ String

  The status of the SQL statement.

• #updated_at ⇒ Time

  The date and time (UTC) that the statement metadata was last updated.

Instance Attribute Details

#created_at ⇒ Time

The date and time (UTC) the statement was created.

Returns:

• (Time)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1350

class SubStatementData < Struct.new(
  :created_at,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_string,
  :redshift_query_id,
  :result_rows,
  :result_size,
  :status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#duration ⇒ Integer

The amount of time in nanoseconds that the statement ran.

Returns:

• (Integer)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1350

class SubStatementData < Struct.new(
  :created_at,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_string,
  :redshift_query_id,
  :result_rows,
  :result_size,
  :status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#error ⇒ String

The error message from the cluster if the SQL statement encountered an error while running.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1350

class SubStatementData < Struct.new(
  :created_at,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_string,
  :redshift_query_id,
  :result_rows,
  :result_size,
  :status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#has_result_set ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1350

class SubStatementData < Struct.new(
  :created_at,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_string,
  :redshift_query_id,
  :result_rows,
  :result_size,
  :status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1350

class SubStatementData < Struct.new(
  :created_at,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_string,
  :redshift_query_id,
  :result_rows,
  :result_size,
  :status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ String

The SQL statement text.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1350

class SubStatementData < Struct.new(
  :created_at,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_string,
  :redshift_query_id,
  :result_rows,
  :result_size,
  :status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#redshift_query_id ⇒ Integer

The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

Returns:

• (Integer)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1350

class SubStatementData < Struct.new(
  :created_at,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_string,
  :redshift_query_id,
  :result_rows,
  :result_size,
  :status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#result_rows ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1350

class SubStatementData < Struct.new(
  :created_at,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_string,
  :redshift_query_id,
  :result_rows,
  :result_size,
  :status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#result_size ⇒ Integer

The size in bytes of the returned results. A -1 indicates the value is null.

Returns:

• (Integer)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1350

class SubStatementData < Struct.new(
  :created_at,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_string,
  :redshift_query_id,
  :result_rows,
  :result_size,
  :status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the SQL statement. An example is the that the SQL statement finished.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1350

class SubStatementData < Struct.new(
  :created_at,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_string,
  :redshift_query_id,
  :result_rows,
  :result_size,
  :status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time (UTC) that the statement metadata was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1350

class SubStatementData < Struct.new(
  :created_at,
  :duration,
  :error,
  :has_result_set,
  :id,
  :query_string,
  :redshift_query_id,
  :result_rows,
  :result_size,
  :status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end