Reference documentation and code samples for the Cloud Datastore V1 Client class GqlQuery.
A GQL query.
Generated from protobuf message google.datastore.v1.GqlQuery
Namespace
Google \ Cloud \ Datastore \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ query_string |
string
A string of the format described here. |
↳ allow_literals |
bool
When false, the query string must not contain any literals and instead must bind all values. For example, |
↳ named_bindings |
array|Google\Protobuf\Internal\MapField
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 |
↳ positional_bindings |
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 |
getQueryString
A string of the format described here.
Returns | |
---|---|
Type | Description |
string |
setQueryString
A string of the format described here.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getAllowLiterals
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 | |
---|---|
Type | Description |
bool |
setAllowLiterals
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.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getNamedBindings
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 | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setNamedBindings
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 ""
.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getPositionalBindings
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 | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setPositionalBindings
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.
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Datastore\V1\GqlQueryParameter>
|
Returns | |
---|---|
Type | Description |
$this |