Constructor
new ExecuteSqlRequest(propertiesopt)
Constructs a new ExecuteSqlRequest.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.spanner.v1.IExecuteSqlRequest |
<optional> |
Properties to set |
- Implements:
-
- IExecuteSqlRequest
Classes
Members
dataBoostEnabled
ExecuteSqlRequest dataBoostEnabled.
directedReadOptions
ExecuteSqlRequest directedReadOptions.
paramTypes
ExecuteSqlRequest paramTypes.
params
ExecuteSqlRequest params.
partitionToken
ExecuteSqlRequest partitionToken.
queryMode
ExecuteSqlRequest queryMode.
queryOptions
ExecuteSqlRequest queryOptions.
requestOptions
ExecuteSqlRequest requestOptions.
resumeToken
ExecuteSqlRequest resumeToken.
seqno
ExecuteSqlRequest seqno.
session
ExecuteSqlRequest session.
sql
ExecuteSqlRequest sql.
transaction
ExecuteSqlRequest transaction.
QueryMode
QueryMode enum.
Properties:
| Name | Type | Description |
|---|---|---|
NORMAL |
number |
NORMAL value |
PLAN |
number |
PLAN value |
PROFILE |
number |
PROFILE value |
WITH_STATS |
number |
WITH_STATS value |
WITH_PLAN_AND_STATS |
number |
WITH_PLAN_AND_STATS value |
Methods
toJSON() → {Object.<string, *>}
Converts this ExecuteSqlRequest to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.spanner.v1.ExecuteSqlRequest}
Creates a new ExecuteSqlRequest instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.spanner.v1.IExecuteSqlRequest |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.spanner.v1.ExecuteSqlRequest |
ExecuteSqlRequest instance |
(static) decode(reader, lengthopt) → {google.spanner.v1.ExecuteSqlRequest}
Decodes an ExecuteSqlRequest message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.spanner.v1.ExecuteSqlRequest |
ExecuteSqlRequest |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.spanner.v1.ExecuteSqlRequest}
Decodes an ExecuteSqlRequest message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.spanner.v1.ExecuteSqlRequest |
ExecuteSqlRequest |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified ExecuteSqlRequest message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.v1.IExecuteSqlRequest |
ExecuteSqlRequest message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified ExecuteSqlRequest message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.v1.IExecuteSqlRequest |
ExecuteSqlRequest message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.spanner.v1.ExecuteSqlRequest}
Creates an ExecuteSqlRequest message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.spanner.v1.ExecuteSqlRequest |
ExecuteSqlRequest |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for ExecuteSqlRequest
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from an ExecuteSqlRequest message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.v1.ExecuteSqlRequest |
ExecuteSqlRequest |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies an ExecuteSqlRequest message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|