Class: Google::Cloud::Datastore::V1::GqlQuery

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/datastore/v1/query.rb

Overview

A GQL query.

Defined Under Namespace

Classes: NamedBindingsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#allow_literals ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/datastore/v1/query.rb', line 428

class GqlQuery
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Datastore::V1::GqlQueryParameter]
  class NamedBindingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#named_bindings ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::GqlQueryParameter}

Returns 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_$][A-Za-z_$0-9]*, must not match regex __.*__, and must not be "".

Returns:

  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::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_$][A-Za-z_$0-9]*, must not match regex __.*__, and must not be "".



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/datastore/v1/query.rb', line 428

class GqlQuery
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Datastore::V1::GqlQueryParameter]
  class NamedBindingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#positional_bindings ⇒ ::Array<::Google::Cloud::Datastore::V1::GqlQueryParameter>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Datastore::V1::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.



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/datastore/v1/query.rb', line 428

class GqlQuery
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Datastore::V1::GqlQueryParameter]
  class NamedBindingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query_string ⇒ ::String

Returns A string of the format described here.

Returns:

  • (::String) —

    A string of the format described here.



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/datastore/v1/query.rb', line 428

class GqlQuery
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Datastore::V1::GqlQueryParameter]
  class NamedBindingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end