Class: Google::Apis::DatastoreV1::GqlQuery

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/datastore_v1/classes.rb,
generated/google/apis/datastore_v1/representations.rb,
generated/google/apis/datastore_v1/representations.rb

Overview

A GQL query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GqlQuery

Returns a new instance of GqlQuery.



1025
1026
1027
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1025

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_literals ⇒ Boolean Also known as: allow_literals?

When false, the query string must not contain any literals and instead must bind all values. For example, SELECT * FROM Kind WHERE a = 'string literal' is not allowed, while SELECT * FROM Kind WHERE a = @value is. Corresponds to the JSON property allowLiterals

Returns:

  • (Boolean) 


1014
1015
1016
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1014

def allow_literals
  @allow_literals
end

#named_bindings ⇒ Hash<String,Google::Apis::DatastoreV1::GqlQueryParameter>

For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex A-Za-z_$*, must not match regex __.*__, and must not be "". Corresponds to the JSON property namedBindings

Returns:



1006
1007
1008
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1006

def named_bindings
  @named_bindings
end

#positional_bindings ⇒ Array<Google::Apis::DatastoreV1::GqlQueryParameter>

Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0. For each binding site numbered i in query_string, there must be an i-th numbered parameter. The inverse must also be true. Corresponds to the JSON property positionalBindings

Returns:



1023
1024
1025
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1023

def positional_bindings
  @positional_bindings
end

#query_string ⇒ String

A string of the format described here. Corresponds to the JSON property queryString

Returns:

  • (String) 


998
999
1000
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 998

def query_string
  @query_string
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1030
1031
1032
1033
1034
1035
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1030

def update!(**args)
  @query_string = args[:query_string] if args.key?(:query_string)
  @named_bindings = args[:named_bindings] if args.key?(:named_bindings)
  @allow_literals = args[:allow_literals] if args.key?(:allow_literals)
  @positional_bindings = args[:positional_bindings] if args.key?(:positional_bindings)
end