Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::GqlQuery (v0.16.3)

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::GqlQuery.

A GQL query.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allow_literals

def allow_literals() -> ::Boolean
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.

#allow_literals=

def allow_literals=(value) -> ::Boolean
Parameter
  • value (::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.
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.

#named_bindings

def named_bindings() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::GqlQueryParameter}
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 "".

#named_bindings=

def named_bindings=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::GqlQueryParameter}
Parameter
  • value (::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 "".

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

#positional_bindings

def positional_bindings() -> ::Array<::Google::Cloud::Datastore::V1::GqlQueryParameter>
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.

#positional_bindings=

def positional_bindings=(value) -> ::Array<::Google::Cloud::Datastore::V1::GqlQueryParameter>
Parameter
  • value (::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.

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.

#query_string

def query_string() -> ::String
Returns
  • (::String) — A string of the format described here.

#query_string=

def query_string=(value) -> ::String
Parameter
  • value (::String) — A string of the format described here.
Returns
  • (::String) — A string of the format described here.