sqldata

package
v1.22.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 25, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const StreamSqlDataRequest_ContinueSession_case case_StreamSqlDataRequest_Message = 6
View Source
const StreamSqlDataRequest_Data_case case_StreamSqlDataRequest_Message = 7
View Source
const StreamSqlDataRequest_Message_not_set_case case_StreamSqlDataRequest_Message = 0
View Source
const StreamSqlDataRequest_StartSession_case case_StreamSqlDataRequest_Message = 5
View Source
const StreamSqlDataRequest_TerminateSession_case case_StreamSqlDataRequest_Message = 8
View Source
const StreamSqlDataResponse_Data_case case_StreamSqlDataResponse_Message = 4
View Source
const StreamSqlDataResponse_Message_not_set_case case_StreamSqlDataResponse_Message = 0
View Source
const StreamSqlDataResponse_SessionMetadata_case case_StreamSqlDataResponse_Message = 3
View Source
const StreamSqlDataResponse_TerminateSession_case case_StreamSqlDataResponse_Message = 5

Variables

View Source
var (
	StreamSqlDataErrorReason_name = map[int32]string{
		0: "STREAM_SQL_DATA_ERROR_REASON_UNKNOWN",
		1: "STREAM_SQL_DATA_ERROR_REASON_UNSUPPORTED_INSTANCE_TYPE",
		3: "STREAM_SQL_DATA_ERROR_REASON_RECONNECT_FAILED",
		4: "STREAM_SQL_DATA_ERROR_REASON_DB_CLIENT_CLOSED",
		5: "STREAM_SQL_DATA_ERROR_REASON_DB_SERVER_CLOSED",
		6: "STREAM_SQL_DATA_ERROR_REASON_INVALID_ACK",
		7: "STREAM_SQL_DATA_ERROR_REASON_DISCONNECTED",
	}
	StreamSqlDataErrorReason_value = map[string]int32{
		"STREAM_SQL_DATA_ERROR_REASON_UNKNOWN":                   0,
		"STREAM_SQL_DATA_ERROR_REASON_UNSUPPORTED_INSTANCE_TYPE": 1,
		"STREAM_SQL_DATA_ERROR_REASON_RECONNECT_FAILED":          3,
		"STREAM_SQL_DATA_ERROR_REASON_DB_CLIENT_CLOSED":          4,
		"STREAM_SQL_DATA_ERROR_REASON_DB_SERVER_CLOSED":          5,
		"STREAM_SQL_DATA_ERROR_REASON_INVALID_ACK":               6,
		"STREAM_SQL_DATA_ERROR_REASON_DISCONNECTED":              7,
	}
)

Enum value maps for StreamSqlDataErrorReason.

View Source
var (
	SqlDataFeature_name = map[int32]string{
		0: "SQL_DATA_FEATURE_UNSPECIFIED",
		1: "SQL_DATA_FEATURE_RECONNECT",
	}
	SqlDataFeature_value = map[string]int32{
		"SQL_DATA_FEATURE_UNSPECIFIED": 0,
		"SQL_DATA_FEATURE_RECONNECT":   1,
	}
)

Enum value maps for SqlDataFeature.

View Source
var File_internal_sqldata_sql_data_service_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Ack

type Ack struct {
	XXX_raceDetectHookData protoimpl.RaceDetectHookData
	XXX_presence           [1]uint32
	// contains filtered or unexported fields
}

Acknowledges data received by the client or server.

func (*Ack) ClearReceivedOffset

func (x *Ack) ClearReceivedOffset()

func (*Ack) GetReceivedOffset

func (x *Ack) GetReceivedOffset() int64

func (*Ack) HasReceivedOffset

func (x *Ack) HasReceivedOffset() bool

func (*Ack) ProtoMessage

func (*Ack) ProtoMessage()

func (*Ack) ProtoReflect

func (x *Ack) ProtoReflect() protoreflect.Message

func (*Ack) Reset

func (x *Ack) Reset()

func (*Ack) SetReceivedOffset

func (x *Ack) SetReceivedOffset(v int64)

func (*Ack) String

func (x *Ack) String() string

type Ack_builder

type Ack_builder struct {

	// The absolute number of bytes processed in the session.
	ReceivedOffset *int64
	// contains filtered or unexported fields
}

func (Ack_builder) Build

func (b0 Ack_builder) Build() *Ack

type ContinueSession

type ContinueSession struct {
	XXX_raceDetectHookData protoimpl.RaceDetectHookData
	XXX_presence           [1]uint32
	// contains filtered or unexported fields
}

Reconnects to an existing session. The client must send this as the first message to the server to reconnect to an existing session. The client may immediately send Data messages without waiting for a reply from the server.

func (*ContinueSession) ClearInstanceId

func (x *ContinueSession) ClearInstanceId()

func (*ContinueSession) ClearLocationId

func (x *ContinueSession) ClearLocationId()

func (*ContinueSession) ClearSessionId

func (x *ContinueSession) ClearSessionId()

func (*ContinueSession) GetInstanceId

func (x *ContinueSession) GetInstanceId() string

func (*ContinueSession) GetLocationId

func (x *ContinueSession) GetLocationId() string

func (*ContinueSession) GetSessionId

func (x *ContinueSession) GetSessionId() string

func (*ContinueSession) HasInstanceId

func (x *ContinueSession) HasInstanceId() bool

func (*ContinueSession) HasLocationId

func (x *ContinueSession) HasLocationId() bool

func (*ContinueSession) HasSessionId

func (x *ContinueSession) HasSessionId() bool

func (*ContinueSession) ProtoMessage

func (*ContinueSession) ProtoMessage()

func (*ContinueSession) ProtoReflect

func (x *ContinueSession) ProtoReflect() protoreflect.Message

func (*ContinueSession) Reset

func (x *ContinueSession) Reset()

func (*ContinueSession) SetInstanceId

func (x *ContinueSession) SetInstanceId(v string)

func (*ContinueSession) SetLocationId

func (x *ContinueSession) SetLocationId(v string)

func (*ContinueSession) SetSessionId

func (x *ContinueSession) SetSessionId(v string)

func (*ContinueSession) String

func (x *ContinueSession) String() string

type ContinueSession_builder

type ContinueSession_builder struct {

	// `location_id` is used to route the
	// request to a specific region. Use the same region which was used to create
	// the instance. Use the format `locations/{location}`, for example:
	// `locations/us-central1`.
	LocationId *string
	// The Cloud SQL instance resource name, for example:
	// projects/example-project/instances/example-instance
	InstanceId *string
	// The id of the session to reconnect.
	SessionId *string
	// contains filtered or unexported fields
}

func (ContinueSession_builder) Build

type DataPacket

type DataPacket struct {
	XXX_raceDetectHookData protoimpl.RaceDetectHookData
	XXX_presence           [1]uint32
	// contains filtered or unexported fields
}

Contains data being sent or received by the database.

func (*DataPacket) ClearData

func (x *DataPacket) ClearData()

func (*DataPacket) ClearFirstByteOffset

func (x *DataPacket) ClearFirstByteOffset()

func (*DataPacket) GetData

func (x *DataPacket) GetData() []byte

func (*DataPacket) GetFirstByteOffset

func (x *DataPacket) GetFirstByteOffset() int64

func (*DataPacket) HasData

func (x *DataPacket) HasData() bool

func (*DataPacket) HasFirstByteOffset

func (x *DataPacket) HasFirstByteOffset() bool

func (*DataPacket) ProtoMessage

func (*DataPacket) ProtoMessage()

func (*DataPacket) ProtoReflect

func (x *DataPacket) ProtoReflect() protoreflect.Message

func (*DataPacket) Reset

func (x *DataPacket) Reset()

func (*DataPacket) SetData

func (x *DataPacket) SetData(v []byte)

func (*DataPacket) SetFirstByteOffset

func (x *DataPacket) SetFirstByteOffset(v int64)

func (*DataPacket) String

func (x *DataPacket) String() string

type DataPacket_builder

type DataPacket_builder struct {

	// The absolute byte offset of the first byte in this payload.
	// 0 for new connections or resumed connections that hasn't acked any bytes
	// from server. Non-zero for resumed connections
	FirstByteOffset *int64
	// Raw data being sent or received by the database.
	Data []byte
	// contains filtered or unexported fields
}

func (DataPacket_builder) Build

func (b0 DataPacket_builder) Build() *DataPacket

type SessionMetadata

type SessionMetadata struct {
	// contains filtered or unexported fields
}

Metadata from the server to the client about the session. The server will always send this as the first message

func (*SessionMetadata) GetSupportedFeatures

func (x *SessionMetadata) GetSupportedFeatures() []SqlDataFeature

func (*SessionMetadata) ProtoMessage

func (*SessionMetadata) ProtoMessage()

func (*SessionMetadata) ProtoReflect

func (x *SessionMetadata) ProtoReflect() protoreflect.Message

func (*SessionMetadata) Reset

func (x *SessionMetadata) Reset()

func (*SessionMetadata) SetSupportedFeatures

func (x *SessionMetadata) SetSupportedFeatures(v []SqlDataFeature)

func (*SessionMetadata) String

func (x *SessionMetadata) String() string

type SessionMetadata_builder

type SessionMetadata_builder struct {

	// The features supported by the server for this session. This field is used
	// by the client to determine which features are available on the server.
	// The features supported by the server for this session.
	SupportedFeatures []SqlDataFeature
	// contains filtered or unexported fields
}

func (SessionMetadata_builder) Build

type SqlDataFeature

type SqlDataFeature int32

The session features. The server must send the supported features in its first message to the client.

const (
	// The feature is not specified. This value should not be used.
	SqlDataFeature_SQL_DATA_FEATURE_UNSPECIFIED SqlDataFeature = 0
	// The server supports reconnecting to the session. If this feature is not
	// present, the client should not attempt to reconnect to the session.
	SqlDataFeature_SQL_DATA_FEATURE_RECONNECT SqlDataFeature = 1
)

func (SqlDataFeature) Descriptor

func (SqlDataFeature) Enum

func (x SqlDataFeature) Enum() *SqlDataFeature

func (SqlDataFeature) Number

func (SqlDataFeature) String

func (x SqlDataFeature) String() string

func (SqlDataFeature) Type

type StartSession

type StartSession struct {
	XXX_raceDetectHookData protoimpl.RaceDetectHookData
	XXX_presence           [1]uint32
	// contains filtered or unexported fields
}

Start a new session. The client must send this as the first message to the server to start a new session. The client may immediately send Data messages without waiting for a reply from the server.

func (*StartSession) ClearInstanceId

func (x *StartSession) ClearInstanceId()

func (*StartSession) ClearLocationId

func (x *StartSession) ClearLocationId()

func (*StartSession) ClearSessionId

func (x *StartSession) ClearSessionId()

func (*StartSession) GetInstanceId

func (x *StartSession) GetInstanceId() string

func (*StartSession) GetLocationId

func (x *StartSession) GetLocationId() string

func (*StartSession) GetSessionId

func (x *StartSession) GetSessionId() string

func (*StartSession) HasInstanceId

func (x *StartSession) HasInstanceId() bool

func (*StartSession) HasLocationId

func (x *StartSession) HasLocationId() bool

func (*StartSession) HasSessionId

func (x *StartSession) HasSessionId() bool

func (*StartSession) ProtoMessage

func (*StartSession) ProtoMessage()

func (*StartSession) ProtoReflect

func (x *StartSession) ProtoReflect() protoreflect.Message

func (*StartSession) Reset

func (x *StartSession) Reset()

func (*StartSession) SetInstanceId

func (x *StartSession) SetInstanceId(v string)

func (*StartSession) SetLocationId

func (x *StartSession) SetLocationId(v string)

func (*StartSession) SetSessionId

func (x *StartSession) SetSessionId(v string)

func (*StartSession) String

func (x *StartSession) String() string

type StartSession_builder

type StartSession_builder struct {

	// `location_id` is used to route the
	// request to a specific region. Use the same region which was used to create
	// the instance. Use the format `locations/{location}`, for example:
	// `locations/us-central1`.
	LocationId *string
	// The Cloud SQL instance resource name, for example:
	// projects/example-project/instances/example-instance
	InstanceId *string
	// The session id, chosen by the client. This should be an unguessable string.
	// If the client does not intend to reconnect to this session, the client may
	// leave session_id unset.
	SessionId *string
	// contains filtered or unexported fields
}

func (StartSession_builder) Build

func (b0 StartSession_builder) Build() *StartSession

type StreamSqlDataErrorReason

type StreamSqlDataErrorReason int32

Error reasons for `StreamSqlData`. Typically used with standard error codes, with the error info/reason field set to the string representation of the enum value.

const (
	// Indicates that the error reason is unknown.
	StreamSqlDataErrorReason_STREAM_SQL_DATA_ERROR_REASON_UNKNOWN StreamSqlDataErrorReason = 0
	// Indicates that the operation is not supported for given instance type.
	// Used with status code `google.rpc.Code.FAILED_PRECONDITION`.
	StreamSqlDataErrorReason_STREAM_SQL_DATA_ERROR_REASON_UNSUPPORTED_INSTANCE_TYPE StreamSqlDataErrorReason = 1
	// Indicates that reconnect failed and should not be retried.
	// Used with status code `google.rpc.Code.INTERNAL`.
	StreamSqlDataErrorReason_STREAM_SQL_DATA_ERROR_REASON_RECONNECT_FAILED StreamSqlDataErrorReason = 3
	// Indicates that the database client closed its connection normally.
	// Used with status code `google.rpc.Code.CANCELED`.
	StreamSqlDataErrorReason_STREAM_SQL_DATA_ERROR_REASON_DB_CLIENT_CLOSED StreamSqlDataErrorReason = 4
	// Indicates that the database server closed its connection normally.
	// Used with status code `google.rpc.Code.CANCELED`.
	StreamSqlDataErrorReason_STREAM_SQL_DATA_ERROR_REASON_DB_SERVER_CLOSED StreamSqlDataErrorReason = 5
	// Indicates that the peer sent an ACK message that was not within an
	// acceptable range. Used with the status code
	// `google.rpc.Code.FAILED_PRECONDITION`.
	StreamSqlDataErrorReason_STREAM_SQL_DATA_ERROR_REASON_INVALID_ACK StreamSqlDataErrorReason = 6
	// Indicates that the SqlDataService lost its connection to the
	// database instance. This is a retryable error.
	// Used with status code `google.rpc.Code.ABORTED`.
	StreamSqlDataErrorReason_STREAM_SQL_DATA_ERROR_REASON_DISCONNECTED StreamSqlDataErrorReason = 7
)

func (StreamSqlDataErrorReason) Descriptor

func (StreamSqlDataErrorReason) Enum

func (StreamSqlDataErrorReason) Number

func (StreamSqlDataErrorReason) String

func (x StreamSqlDataErrorReason) String() string

func (StreamSqlDataErrorReason) Type

type StreamSqlDataRequest

type StreamSqlDataRequest struct {
	// contains filtered or unexported fields
}

Message sent from the client to `SqlDataService`.

func (*StreamSqlDataRequest) ClearAck

func (x *StreamSqlDataRequest) ClearAck()

func (*StreamSqlDataRequest) ClearContinueSession

func (x *StreamSqlDataRequest) ClearContinueSession()

func (*StreamSqlDataRequest) ClearData

func (x *StreamSqlDataRequest) ClearData()

func (*StreamSqlDataRequest) ClearMessage

func (x *StreamSqlDataRequest) ClearMessage()

func (*StreamSqlDataRequest) ClearStartSession

func (x *StreamSqlDataRequest) ClearStartSession()

func (*StreamSqlDataRequest) ClearTerminateSession

func (x *StreamSqlDataRequest) ClearTerminateSession()

func (*StreamSqlDataRequest) GetAck

func (x *StreamSqlDataRequest) GetAck() *Ack

func (*StreamSqlDataRequest) GetContinueSession

func (x *StreamSqlDataRequest) GetContinueSession() *ContinueSession

func (*StreamSqlDataRequest) GetData

func (x *StreamSqlDataRequest) GetData() *DataPacket

func (*StreamSqlDataRequest) GetStartSession

func (x *StreamSqlDataRequest) GetStartSession() *StartSession

func (*StreamSqlDataRequest) GetTerminateSession

func (x *StreamSqlDataRequest) GetTerminateSession() *TerminateSession

func (*StreamSqlDataRequest) HasAck

func (x *StreamSqlDataRequest) HasAck() bool

func (*StreamSqlDataRequest) HasContinueSession

func (x *StreamSqlDataRequest) HasContinueSession() bool

func (*StreamSqlDataRequest) HasData

func (x *StreamSqlDataRequest) HasData() bool

func (*StreamSqlDataRequest) HasMessage

func (x *StreamSqlDataRequest) HasMessage() bool

func (*StreamSqlDataRequest) HasStartSession

func (x *StreamSqlDataRequest) HasStartSession() bool

func (*StreamSqlDataRequest) HasTerminateSession

func (x *StreamSqlDataRequest) HasTerminateSession() bool

func (*StreamSqlDataRequest) ProtoMessage

func (*StreamSqlDataRequest) ProtoMessage()

func (*StreamSqlDataRequest) ProtoReflect

func (x *StreamSqlDataRequest) ProtoReflect() protoreflect.Message

func (*StreamSqlDataRequest) Reset

func (x *StreamSqlDataRequest) Reset()

func (*StreamSqlDataRequest) SetAck

func (x *StreamSqlDataRequest) SetAck(v *Ack)

func (*StreamSqlDataRequest) SetContinueSession

func (x *StreamSqlDataRequest) SetContinueSession(v *ContinueSession)

func (*StreamSqlDataRequest) SetData

func (x *StreamSqlDataRequest) SetData(v *DataPacket)

func (*StreamSqlDataRequest) SetStartSession

func (x *StreamSqlDataRequest) SetStartSession(v *StartSession)

func (*StreamSqlDataRequest) SetTerminateSession

func (x *StreamSqlDataRequest) SetTerminateSession(v *TerminateSession)

func (*StreamSqlDataRequest) String

func (x *StreamSqlDataRequest) String() string

func (*StreamSqlDataRequest) WhichMessage

func (x *StreamSqlDataRequest) WhichMessage() case_StreamSqlDataRequest_Message

type StreamSqlDataRequest_builder

type StreamSqlDataRequest_builder struct {

	// Acknowledges data received by the client.
	Ack *Ack

	// Fields of oneof xxx_hidden_Message:
	// Starts a new session. When starting a new session, this is the first
	// message the client sends.
	StartSession *StartSession
	// Continues an existing session. When starting a new session, this is the
	// first message the client sends.
	ContinueSession *ContinueSession
	// Database data.
	Data *DataPacket
	// Terminates the session. This closes the connection to the database.
	TerminateSession *TerminateSession
	// contains filtered or unexported fields
}

func (StreamSqlDataRequest_builder) Build

type StreamSqlDataResponse

type StreamSqlDataResponse struct {
	// contains filtered or unexported fields
}

Message sent from SqlDataService back to the client.

func (*StreamSqlDataResponse) ClearAck

func (x *StreamSqlDataResponse) ClearAck()

func (*StreamSqlDataResponse) ClearData

func (x *StreamSqlDataResponse) ClearData()

func (*StreamSqlDataResponse) ClearMessage

func (x *StreamSqlDataResponse) ClearMessage()

func (*StreamSqlDataResponse) ClearSessionMetadata

func (x *StreamSqlDataResponse) ClearSessionMetadata()

func (*StreamSqlDataResponse) ClearTerminateSession

func (x *StreamSqlDataResponse) ClearTerminateSession()

func (*StreamSqlDataResponse) GetAck

func (x *StreamSqlDataResponse) GetAck() *Ack

func (*StreamSqlDataResponse) GetData

func (x *StreamSqlDataResponse) GetData() *DataPacket

func (*StreamSqlDataResponse) GetSessionMetadata

func (x *StreamSqlDataResponse) GetSessionMetadata() *SessionMetadata

func (*StreamSqlDataResponse) GetTerminateSession

func (x *StreamSqlDataResponse) GetTerminateSession() *TerminateSession

func (*StreamSqlDataResponse) HasAck

func (x *StreamSqlDataResponse) HasAck() bool

func (*StreamSqlDataResponse) HasData

func (x *StreamSqlDataResponse) HasData() bool

func (*StreamSqlDataResponse) HasMessage

func (x *StreamSqlDataResponse) HasMessage() bool

func (*StreamSqlDataResponse) HasSessionMetadata

func (x *StreamSqlDataResponse) HasSessionMetadata() bool

func (*StreamSqlDataResponse) HasTerminateSession

func (x *StreamSqlDataResponse) HasTerminateSession() bool

func (*StreamSqlDataResponse) ProtoMessage

func (*StreamSqlDataResponse) ProtoMessage()

func (*StreamSqlDataResponse) ProtoReflect

func (x *StreamSqlDataResponse) ProtoReflect() protoreflect.Message

func (*StreamSqlDataResponse) Reset

func (x *StreamSqlDataResponse) Reset()

func (*StreamSqlDataResponse) SetAck

func (x *StreamSqlDataResponse) SetAck(v *Ack)

func (*StreamSqlDataResponse) SetData

func (x *StreamSqlDataResponse) SetData(v *DataPacket)

func (*StreamSqlDataResponse) SetSessionMetadata

func (x *StreamSqlDataResponse) SetSessionMetadata(v *SessionMetadata)

func (*StreamSqlDataResponse) SetTerminateSession

func (x *StreamSqlDataResponse) SetTerminateSession(v *TerminateSession)

func (*StreamSqlDataResponse) String

func (x *StreamSqlDataResponse) String() string

func (*StreamSqlDataResponse) WhichMessage

func (x *StreamSqlDataResponse) WhichMessage() case_StreamSqlDataResponse_Message

type StreamSqlDataResponse_builder

type StreamSqlDataResponse_builder struct {

	// Acknowledges data received by the server.
	Ack *Ack

	// Fields of oneof xxx_hidden_Message:
	// The first message from the server to the client, containing metadata
	// about this session.
	SessionMetadata *SessionMetadata
	// Data from the database.
	Data *DataPacket
	// Terminates the session. This indicates that the database connection
	// is closed. When the client receives this message, it should not
	// attempt to reconnect.
	TerminateSession *TerminateSession
	// contains filtered or unexported fields
}

func (StreamSqlDataResponse_builder) Build

type TerminateSession

type TerminateSession struct {
	// contains filtered or unexported fields
}

Indicates that the session is permanently ended.

func (*TerminateSession) ClearStatus

func (x *TerminateSession) ClearStatus()

func (*TerminateSession) GetStatus

func (x *TerminateSession) GetStatus() *status.Status

func (*TerminateSession) HasStatus

func (x *TerminateSession) HasStatus() bool

func (*TerminateSession) ProtoMessage

func (*TerminateSession) ProtoMessage()

func (*TerminateSession) ProtoReflect

func (x *TerminateSession) ProtoReflect() protoreflect.Message

func (*TerminateSession) Reset

func (x *TerminateSession) Reset()

func (*TerminateSession) SetStatus

func (x *TerminateSession) SetStatus(v *status.Status)

func (*TerminateSession) String

func (x *TerminateSession) String() string

type TerminateSession_builder

type TerminateSession_builder struct {

	// The session termination status.
	Status *status.Status
	// contains filtered or unexported fields
}

func (TerminateSession_builder) Build

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL