Class: SparkConnect::SparkConnectClient::ExecuteResult

Inherits:
Struct
  • Object
show all
Defined in:
lib/spark_connect/client.rb

Overview

Accumulated result of an ExecutePlan stream.

Instance Attribute Summary collapse

Instance Attribute Details

#arrow_batches ⇒ Array<String> (readonly)

Returns each element is one Arrow IPC stream chunk.

Returns:

  • (Array<String>) —

    each element is one Arrow IPC stream chunk.



28
29
30
31
32
 
# File 'lib/spark_connect/client.rb', line 28

ExecuteResult = Struct.new(
  :arrow_batches, :schema, :metrics, :observed_metrics, :sql_command_result, :row_count,
  :write_stream_result, :streaming_query_result, :streaming_manager_result, :checkpoint_relation,
  :pipeline_command_result, :pipeline_events
)

#checkpoint_relation ⇒ Object

Returns the value of attribute checkpoint_relation

Returns:

  • (Object) —

    the current value of checkpoint_relation



28
29
30
 
# File 'lib/spark_connect/client.rb', line 28

def checkpoint_relation
  @checkpoint_relation
end

#metrics ⇒ Spark::Connect::ExecutePlanResponse::Metrics? (readonly)

Returns:

  • (Spark::Connect::ExecutePlanResponse::Metrics, nil) 


28
29
30
31
32
 
# File 'lib/spark_connect/client.rb', line 28

ExecuteResult = Struct.new(
  :arrow_batches, :schema, :metrics, :observed_metrics, :sql_command_result, :row_count,
  :write_stream_result, :streaming_query_result, :streaming_manager_result, :checkpoint_relation,
  :pipeline_command_result, :pipeline_events
)

#observed_metrics ⇒ Array (readonly)

Returns observed (named) metrics.

Returns:

  • (Array) —

    observed (named) metrics.



28
29
30
31
32
 
# File 'lib/spark_connect/client.rb', line 28

ExecuteResult = Struct.new(
  :arrow_batches, :schema, :metrics, :observed_metrics, :sql_command_result, :row_count,
  :write_stream_result, :streaming_query_result, :streaming_manager_result, :checkpoint_relation,
  :pipeline_command_result, :pipeline_events
)

#pipeline_command_result ⇒ Object

Returns the value of attribute pipeline_command_result

Returns:

  • (Object) —

    the current value of pipeline_command_result



28
29
30
 
# File 'lib/spark_connect/client.rb', line 28

def pipeline_command_result
  @pipeline_command_result
end

#pipeline_events ⇒ Object

Returns the value of attribute pipeline_events

Returns:

  • (Object) —

    the current value of pipeline_events



28
29
30
 
# File 'lib/spark_connect/client.rb', line 28

def pipeline_events
  @pipeline_events
end

#row_count ⇒ Object

Returns the value of attribute row_count

Returns:

  • (Object) —

    the current value of row_count



28
29
30
 
# File 'lib/spark_connect/client.rb', line 28

def row_count
  @row_count
end

#schema ⇒ Spark::Connect::DataType? (readonly)

Returns result schema, if returned.

Returns:

  • (Spark::Connect::DataType, nil) —

    result schema, if returned.



28
29
30
31
32
 
# File 'lib/spark_connect/client.rb', line 28

ExecuteResult = Struct.new(
  :arrow_batches, :schema, :metrics, :observed_metrics, :sql_command_result, :row_count,
  :write_stream_result, :streaming_query_result, :streaming_manager_result, :checkpoint_relation,
  :pipeline_command_result, :pipeline_events
)

#sql_command_result ⇒ Spark::Connect::Relation? (readonly)

Returns relation produced by a SQL command.

Returns:

  • (Spark::Connect::Relation, nil) —

    relation produced by a SQL command.



28
29
30
31
32
 
# File 'lib/spark_connect/client.rb', line 28

ExecuteResult = Struct.new(
  :arrow_batches, :schema, :metrics, :observed_metrics, :sql_command_result, :row_count,
  :write_stream_result, :streaming_query_result, :streaming_manager_result, :checkpoint_relation,
  :pipeline_command_result, :pipeline_events
)

#streaming_manager_result ⇒ Object

Returns the value of attribute streaming_manager_result

Returns:

  • (Object) —

    the current value of streaming_manager_result



28
29
30
 
# File 'lib/spark_connect/client.rb', line 28

def streaming_manager_result
  @streaming_manager_result
end

#streaming_query_result ⇒ Object

Returns the value of attribute streaming_query_result

Returns:

  • (Object) —

    the current value of streaming_query_result



28
29
30
 
# File 'lib/spark_connect/client.rb', line 28

def streaming_query_result
  @streaming_query_result
end

#write_stream_result ⇒ Object

Returns the value of attribute write_stream_result

Returns:

  • (Object) —

    the current value of write_stream_result



28
29
30
 
# File 'lib/spark_connect/client.rb', line 28

def write_stream_result
  @write_stream_result
end