ExecuteSqlRequest

google.spanner.v1. ExecuteSqlRequest

Represents an ExecuteSqlRequest.

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

QueryOptions

Members

(static) QueryMode :number

QueryMode enum.

Properties:
Name Type Description
NORMAL number

NORMAL value

PLAN number

PLAN value

PROFILE number

PROFILE value

params :google.protobuf.IStruct|null|undefined

ExecuteSqlRequest params.

paramTypes :Object.<string, google.spanner.v1.IType>

ExecuteSqlRequest paramTypes.

partitionToken :Uint8Array

ExecuteSqlRequest partitionToken.

queryMode :google.spanner.v1.ExecuteSqlRequest.QueryMode

ExecuteSqlRequest queryMode.

queryOptions :google.spanner.v1.ExecuteSqlRequest.IQueryOptions|null|undefined

ExecuteSqlRequest queryOptions.

resumeToken :Uint8Array

ExecuteSqlRequest resumeToken.

seqno :number|Long

ExecuteSqlRequest seqno.

session :string

ExecuteSqlRequest session.

sql :string

ExecuteSqlRequest sql.

transaction :google.spanner.v1.ITransactionSelector|null|undefined

ExecuteSqlRequest transaction.

Methods

(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

(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

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

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

(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

(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

(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

(static) verify(message) → {string|null}

Verifies an ExecuteSqlRequest message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this ExecuteSqlRequest to JSON.