Class: Aws::NeptuneGraph::Types::ExecuteQueryInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#explain_mode ⇒ String

The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.

Returns:

  • (String) 


849
850
851
852
853
854
855
856
857
858
859
 
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/types.rb', line 849

class ExecuteQueryInput < Struct.new(
  :graph_identifier,
  :query_string,
  :language,
  :parameters,
  :plan_cache,
  :explain_mode,
  :query_timeout_milliseconds)
  SENSITIVE = []
  include Aws::Structure
end

#graph_identifier ⇒ String

The unique identifier of the Neptune Analytics graph.

Returns:

  • (String) 


849
850
851
852
853
854
855
856
857
858
859
 
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/types.rb', line 849

class ExecuteQueryInput < Struct.new(
  :graph_identifier,
  :query_string,
  :language,
  :parameters,
  :plan_cache,
  :explain_mode,
  :query_timeout_milliseconds)
  SENSITIVE = []
  include Aws::Structure
end

#language ⇒ String

The query language the query is written in. Currently only openCypher is supported.

Returns:

  • (String) 


849
850
851
852
853
854
855
856
857
858
859
 
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/types.rb', line 849

class ExecuteQueryInput < Struct.new(
  :graph_identifier,
  :query_string,
  :language,
  :parameters,
  :plan_cache,
  :explain_mode,
  :query_timeout_milliseconds)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash<String,Hash,Array,String,Numeric,Boolean>

The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20\}. (optional)

Returns:

  • (Hash<String,Hash,Array,String,Numeric,Boolean>) 


849
850
851
852
853
854
855
856
857
858
859
 
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/types.rb', line 849

class ExecuteQueryInput < Struct.new(
  :graph_identifier,
  :query_string,
  :language,
  :parameters,
  :plan_cache,
  :explain_mode,
  :query_timeout_milliseconds)
  SENSITIVE = []
  include Aws::Structure
end

#plan_cache ⇒ String

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.

Returns:

  • (String) 


849
850
851
852
853
854
855
856
857
858
859
 
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/types.rb', line 849

class ExecuteQueryInput < Struct.new(
  :graph_identifier,
  :query_string,
  :language,
  :parameters,
  :plan_cache,
  :explain_mode,
  :query_timeout_milliseconds)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ String

The query string to be executed.

Returns:

  • (String) 


849
850
851
852
853
854
855
856
857
858
859
 
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/types.rb', line 849

class ExecuteQueryInput < Struct.new(
  :graph_identifier,
  :query_string,
  :language,
  :parameters,
  :plan_cache,
  :explain_mode,
  :query_timeout_milliseconds)
  SENSITIVE = []
  include Aws::Structure
end

#query_timeout_milliseconds ⇒ Integer

Specifies the query timeout duration, in milliseconds. (optional)

Returns:

  • (Integer) 


849
850
851
852
853
854
855
856
857
858
859
 
# File 'gems/aws-sdk-neptunegraph/lib/aws-sdk-neptunegraph/types.rb', line 849

class ExecuteQueryInput < Struct.new(
  :graph_identifier,
  :query_string,
  :language,
  :parameters,
  :plan_cache,
  :explain_mode,
  :query_timeout_milliseconds)
  SENSITIVE = []
  include Aws::Structure
end