Represents an ExecuteSqlRequest.
Package
@google-cloud/spanner!Constructors
(constructor)(properties)
constructor(properties?: google.spanner.v1.IExecuteSqlRequest);Constructs a new ExecuteSqlRequest.
| Type | Name | Description |
|---|---|---|
| IExecuteSqlRequest | properties |
Properties to set |
Properties
params
public params?: (google.protobuf.IStruct|null);ExecuteSqlRequest params.
| Type | Description |
|---|---|
| (google.protobuf.IStruct|null) |
paramTypes
public paramTypes: { [k: string]: google.spanner.v1.IType };ExecuteSqlRequest paramTypes.
| Type | Description |
|---|---|
| { [k: string]: google.spanner.v1.IType } |
partitionToken
public partitionToken: (Uint8Array|string);ExecuteSqlRequest partitionToken.
| Type | Description |
|---|---|
| (Uint8Array|string) |
queryMode
public queryMode: (google.spanner.v1.ExecuteSqlRequest.QueryMode|keyof typeof google.spanner.v1.ExecuteSqlRequest.QueryMode);ExecuteSqlRequest queryMode.
| Type | Description |
|---|---|
| (google.spanner.v1.ExecuteSqlRequest.QueryMode|keyof typeof google.spanner.v1.ExecuteSqlRequest.QueryMode) |
queryOptions
public queryOptions?: (google.spanner.v1.ExecuteSqlRequest.IQueryOptions|null);ExecuteSqlRequest queryOptions.
| Type | Description |
|---|---|
| (google.spanner.v1.ExecuteSqlRequest.IQueryOptions|null) |
requestOptions
public requestOptions?: (google.spanner.v1.IRequestOptions|null);ExecuteSqlRequest requestOptions.
| Type | Description |
|---|---|
| (google.spanner.v1.IRequestOptions|null) |
resumeToken
public resumeToken: (Uint8Array|string);ExecuteSqlRequest resumeToken.
| Type | Description |
|---|---|
| (Uint8Array|string) |
seqno
public seqno: (number|Long|string);ExecuteSqlRequest seqno.
| Type | Description |
|---|---|
| (number|Long|string) |
session
public session: string;ExecuteSqlRequest session.
| Type | Description |
|---|---|
| string |
sql
public sql: string;ExecuteSqlRequest sql.
| Type | Description |
|---|---|
| string |
transaction
public transaction?: (google.spanner.v1.ITransactionSelector|null);ExecuteSqlRequest transaction.
| Type | Description |
|---|---|
| (google.spanner.v1.ITransactionSelector|null) |
Methods
create(properties)
public static create(properties?: google.spanner.v1.IExecuteSqlRequest): google.spanner.v1.ExecuteSqlRequest;Creates a new ExecuteSqlRequest instance using the specified properties.
| Type | Name | Description |
|---|---|---|
| IExecuteSqlRequest | properties |
Properties to set |
| Type | Description |
|---|---|
| google.spanner.v1.ExecuteSqlRequest | ExecuteSqlRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.spanner.v1.ExecuteSqlRequest;Decodes an ExecuteSqlRequest message from the specified reader or buffer.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| number | length |
Message length if known beforehand |
| Type | Description |
|---|---|
| google.spanner.v1.ExecuteSqlRequest | ExecuteSqlRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.spanner.v1.ExecuteSqlRequest;Decodes an ExecuteSqlRequest message from the specified reader or buffer, length delimited.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| Type | Description |
|---|---|
| google.spanner.v1.ExecuteSqlRequest | ExecuteSqlRequest |
encode(message, writer)
public static encode(message: google.spanner.v1.IExecuteSqlRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ExecuteSqlRequest message. Does not implicitly messages.
| Type | Name | Description |
|---|---|---|
| IExecuteSqlRequest | message |
ExecuteSqlRequest message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.spanner.v1.IExecuteSqlRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ExecuteSqlRequest message, length delimited. Does not implicitly messages.
| Type | Name | Description |
|---|---|---|
| IExecuteSqlRequest | message |
ExecuteSqlRequest message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.spanner.v1.ExecuteSqlRequest;Creates an ExecuteSqlRequest message from a plain object. Also converts values to their respective internal types.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | object |
Plain object |
| Type | Description |
|---|---|
| google.spanner.v1.ExecuteSqlRequest | ExecuteSqlRequest |
toJSON()
public toJSON(): { [k: string]: any };Converts this ExecuteSqlRequest to JSON.
| Type | Description |
|---|---|
| { [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.spanner.v1.ExecuteSqlRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an ExecuteSqlRequest message. Also converts values to other types if specified.
| Type | Name | Description |
|---|---|---|
| google.spanner.v1.ExecuteSqlRequest | message |
ExecuteSqlRequest |
| $protobuf.IConversionOptions | options |
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an ExecuteSqlRequest message.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | message |
Plain object to verify |
| Type | Description |
|---|---|
| (string|null) |
|