Ydb_Table_V1

package
v0.0.0-...-ea1f632 Latest Latest
Warning

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

Go to latest
Published: Nov 12, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	TableService_CreateSession_FullMethodName          = "/Ydb.Table.V1.TableService/CreateSession"
	TableService_DeleteSession_FullMethodName          = "/Ydb.Table.V1.TableService/DeleteSession"
	TableService_KeepAlive_FullMethodName              = "/Ydb.Table.V1.TableService/KeepAlive"
	TableService_CreateTable_FullMethodName            = "/Ydb.Table.V1.TableService/CreateTable"
	TableService_DropTable_FullMethodName              = "/Ydb.Table.V1.TableService/DropTable"
	TableService_AlterTable_FullMethodName             = "/Ydb.Table.V1.TableService/AlterTable"
	TableService_CopyTable_FullMethodName              = "/Ydb.Table.V1.TableService/CopyTable"
	TableService_CopyTables_FullMethodName             = "/Ydb.Table.V1.TableService/CopyTables"
	TableService_RenameTables_FullMethodName           = "/Ydb.Table.V1.TableService/RenameTables"
	TableService_DescribeTable_FullMethodName          = "/Ydb.Table.V1.TableService/DescribeTable"
	TableService_ExplainDataQuery_FullMethodName       = "/Ydb.Table.V1.TableService/ExplainDataQuery"
	TableService_PrepareDataQuery_FullMethodName       = "/Ydb.Table.V1.TableService/PrepareDataQuery"
	TableService_ExecuteDataQuery_FullMethodName       = "/Ydb.Table.V1.TableService/ExecuteDataQuery"
	TableService_ExecuteSchemeQuery_FullMethodName     = "/Ydb.Table.V1.TableService/ExecuteSchemeQuery"
	TableService_BeginTransaction_FullMethodName       = "/Ydb.Table.V1.TableService/BeginTransaction"
	TableService_CommitTransaction_FullMethodName      = "/Ydb.Table.V1.TableService/CommitTransaction"
	TableService_RollbackTransaction_FullMethodName    = "/Ydb.Table.V1.TableService/RollbackTransaction"
	TableService_DescribeTableOptions_FullMethodName   = "/Ydb.Table.V1.TableService/DescribeTableOptions"
	TableService_StreamReadTable_FullMethodName        = "/Ydb.Table.V1.TableService/StreamReadTable"
	TableService_ReadRows_FullMethodName               = "/Ydb.Table.V1.TableService/ReadRows"
	TableService_BulkUpsert_FullMethodName             = "/Ydb.Table.V1.TableService/BulkUpsert"
	TableService_StreamExecuteScanQuery_FullMethodName = "/Ydb.Table.V1.TableService/StreamExecuteScanQuery"
)

Variables

View Source
var File_ydb_table_v1_proto protoreflect.FileDescriptor
View Source
var TableService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "Ydb.Table.V1.TableService",
	HandlerType: (*TableServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateSession",
			Handler:    _TableService_CreateSession_Handler,
		},
		{
			MethodName: "DeleteSession",
			Handler:    _TableService_DeleteSession_Handler,
		},
		{
			MethodName: "KeepAlive",
			Handler:    _TableService_KeepAlive_Handler,
		},
		{
			MethodName: "CreateTable",
			Handler:    _TableService_CreateTable_Handler,
		},
		{
			MethodName: "DropTable",
			Handler:    _TableService_DropTable_Handler,
		},
		{
			MethodName: "AlterTable",
			Handler:    _TableService_AlterTable_Handler,
		},
		{
			MethodName: "CopyTable",
			Handler:    _TableService_CopyTable_Handler,
		},
		{
			MethodName: "CopyTables",
			Handler:    _TableService_CopyTables_Handler,
		},
		{
			MethodName: "RenameTables",
			Handler:    _TableService_RenameTables_Handler,
		},
		{
			MethodName: "DescribeTable",
			Handler:    _TableService_DescribeTable_Handler,
		},
		{
			MethodName: "ExplainDataQuery",
			Handler:    _TableService_ExplainDataQuery_Handler,
		},
		{
			MethodName: "PrepareDataQuery",
			Handler:    _TableService_PrepareDataQuery_Handler,
		},
		{
			MethodName: "ExecuteDataQuery",
			Handler:    _TableService_ExecuteDataQuery_Handler,
		},
		{
			MethodName: "ExecuteSchemeQuery",
			Handler:    _TableService_ExecuteSchemeQuery_Handler,
		},
		{
			MethodName: "BeginTransaction",
			Handler:    _TableService_BeginTransaction_Handler,
		},
		{
			MethodName: "CommitTransaction",
			Handler:    _TableService_CommitTransaction_Handler,
		},
		{
			MethodName: "RollbackTransaction",
			Handler:    _TableService_RollbackTransaction_Handler,
		},
		{
			MethodName: "DescribeTableOptions",
			Handler:    _TableService_DescribeTableOptions_Handler,
		},
		{
			MethodName: "ReadRows",
			Handler:    _TableService_ReadRows_Handler,
		},
		{
			MethodName: "BulkUpsert",
			Handler:    _TableService_BulkUpsert_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamReadTable",
			Handler:       _TableService_StreamReadTable_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "StreamExecuteScanQuery",
			Handler:       _TableService_StreamExecuteScanQuery_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "ydb_table_v1.proto",
}

TableService_ServiceDesc is the grpc.ServiceDesc for TableService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterTableServiceServer

func RegisterTableServiceServer(s grpc.ServiceRegistrar, srv TableServiceServer)

Types

type TableServiceClient

type TableServiceClient interface {
	// Create new session. Implicit session creation is forbidden,
	// so user must create new session before execute any query,
	// otherwise BAD_SESSION status will be returned.
	// Simultaneous execution of requests are forbiden.
	// Sessions are volatile, can be invalidated by server, for example in case
	// of fatal errors. All requests with this session will fail with BAD_SESSION status.
	// So, client must be able to handle BAD_SESSION status.
	CreateSession(ctx context.Context, in *Ydb_Table.CreateSessionRequest, opts ...grpc.CallOption) (*Ydb_Table.CreateSessionResponse, error)
	// Ends a session, releasing server resources associated with it.
	DeleteSession(ctx context.Context, in *Ydb_Table.DeleteSessionRequest, opts ...grpc.CallOption) (*Ydb_Table.DeleteSessionResponse, error)
	// Idle sessions can be kept alive by calling KeepAlive periodically.
	KeepAlive(ctx context.Context, in *Ydb_Table.KeepAliveRequest, opts ...grpc.CallOption) (*Ydb_Table.KeepAliveResponse, error)
	// Creates new table.
	CreateTable(ctx context.Context, in *Ydb_Table.CreateTableRequest, opts ...grpc.CallOption) (*Ydb_Table.CreateTableResponse, error)
	// Drop table.
	DropTable(ctx context.Context, in *Ydb_Table.DropTableRequest, opts ...grpc.CallOption) (*Ydb_Table.DropTableResponse, error)
	// Modifies schema of given table.
	AlterTable(ctx context.Context, in *Ydb_Table.AlterTableRequest, opts ...grpc.CallOption) (*Ydb_Table.AlterTableResponse, error)
	// Creates copy of given table.
	CopyTable(ctx context.Context, in *Ydb_Table.CopyTableRequest, opts ...grpc.CallOption) (*Ydb_Table.CopyTableResponse, error)
	// Creates consistent copy of given tables.
	CopyTables(ctx context.Context, in *Ydb_Table.CopyTablesRequest, opts ...grpc.CallOption) (*Ydb_Table.CopyTablesResponse, error)
	// Creates consistent move of given tables.
	RenameTables(ctx context.Context, in *Ydb_Table.RenameTablesRequest, opts ...grpc.CallOption) (*Ydb_Table.RenameTablesResponse, error)
	// Returns information about given table (metadata).
	DescribeTable(ctx context.Context, in *Ydb_Table.DescribeTableRequest, opts ...grpc.CallOption) (*Ydb_Table.DescribeTableResponse, error)
	// Explains data query.
	// SessionId of previously created session must be provided.
	ExplainDataQuery(ctx context.Context, in *Ydb_Table.ExplainDataQueryRequest, opts ...grpc.CallOption) (*Ydb_Table.ExplainDataQueryResponse, error)
	// Prepares data query, returns query id.
	// SessionId of previously created session must be provided.
	PrepareDataQuery(ctx context.Context, in *Ydb_Table.PrepareDataQueryRequest, opts ...grpc.CallOption) (*Ydb_Table.PrepareDataQueryResponse, error)
	// Executes data query.
	// SessionId of previously created session must be provided.
	ExecuteDataQuery(ctx context.Context, in *Ydb_Table.ExecuteDataQueryRequest, opts ...grpc.CallOption) (*Ydb_Table.ExecuteDataQueryResponse, error)
	// Executes scheme query.
	// SessionId of previously created session must be provided.
	ExecuteSchemeQuery(ctx context.Context, in *Ydb_Table.ExecuteSchemeQueryRequest, opts ...grpc.CallOption) (*Ydb_Table.ExecuteSchemeQueryResponse, error)
	// Begins new transaction.
	BeginTransaction(ctx context.Context, in *Ydb_Table.BeginTransactionRequest, opts ...grpc.CallOption) (*Ydb_Table.BeginTransactionResponse, error)
	// Commits specified active transaction.
	CommitTransaction(ctx context.Context, in *Ydb_Table.CommitTransactionRequest, opts ...grpc.CallOption) (*Ydb_Table.CommitTransactionResponse, error)
	// Performs a rollback of the specified active transaction.
	RollbackTransaction(ctx context.Context, in *Ydb_Table.RollbackTransactionRequest, opts ...grpc.CallOption) (*Ydb_Table.RollbackTransactionResponse, error)
	// Describe supported table options.
	DescribeTableOptions(ctx context.Context, in *Ydb_Table.DescribeTableOptionsRequest, opts ...grpc.CallOption) (*Ydb_Table.DescribeTableOptionsResponse, error)
	// Streaming read table
	StreamReadTable(ctx context.Context, in *Ydb_Table.ReadTableRequest, opts ...grpc.CallOption) (TableService_StreamReadTableClient, error)
	// Reads specified keys non-transactionally from a single table
	ReadRows(ctx context.Context, in *Ydb_Table.ReadRowsRequest, opts ...grpc.CallOption) (*Ydb_Table.ReadRowsResponse, error)
	// Upserts a batch of rows non-transactionally.
	// Returns success only when all rows were successfully upserted. In case of an error some rows might
	// be upserted and some might not.
	BulkUpsert(ctx context.Context, in *Ydb_Table.BulkUpsertRequest, opts ...grpc.CallOption) (*Ydb_Table.BulkUpsertResponse, error)
	// Executes scan query with streaming result.
	StreamExecuteScanQuery(ctx context.Context, in *Ydb_Table.ExecuteScanQueryRequest, opts ...grpc.CallOption) (TableService_StreamExecuteScanQueryClient, error)
}

TableServiceClient is the client API for TableService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type TableServiceServer

type TableServiceServer interface {
	// Create new session. Implicit session creation is forbidden,
	// so user must create new session before execute any query,
	// otherwise BAD_SESSION status will be returned.
	// Simultaneous execution of requests are forbiden.
	// Sessions are volatile, can be invalidated by server, for example in case
	// of fatal errors. All requests with this session will fail with BAD_SESSION status.
	// So, client must be able to handle BAD_SESSION status.
	CreateSession(context.Context, *Ydb_Table.CreateSessionRequest) (*Ydb_Table.CreateSessionResponse, error)
	// Ends a session, releasing server resources associated with it.
	DeleteSession(context.Context, *Ydb_Table.DeleteSessionRequest) (*Ydb_Table.DeleteSessionResponse, error)
	// Idle sessions can be kept alive by calling KeepAlive periodically.
	KeepAlive(context.Context, *Ydb_Table.KeepAliveRequest) (*Ydb_Table.KeepAliveResponse, error)
	// Creates new table.
	CreateTable(context.Context, *Ydb_Table.CreateTableRequest) (*Ydb_Table.CreateTableResponse, error)
	// Drop table.
	DropTable(context.Context, *Ydb_Table.DropTableRequest) (*Ydb_Table.DropTableResponse, error)
	// Modifies schema of given table.
	AlterTable(context.Context, *Ydb_Table.AlterTableRequest) (*Ydb_Table.AlterTableResponse, error)
	// Creates copy of given table.
	CopyTable(context.Context, *Ydb_Table.CopyTableRequest) (*Ydb_Table.CopyTableResponse, error)
	// Creates consistent copy of given tables.
	CopyTables(context.Context, *Ydb_Table.CopyTablesRequest) (*Ydb_Table.CopyTablesResponse, error)
	// Creates consistent move of given tables.
	RenameTables(context.Context, *Ydb_Table.RenameTablesRequest) (*Ydb_Table.RenameTablesResponse, error)
	// Returns information about given table (metadata).
	DescribeTable(context.Context, *Ydb_Table.DescribeTableRequest) (*Ydb_Table.DescribeTableResponse, error)
	// Explains data query.
	// SessionId of previously created session must be provided.
	ExplainDataQuery(context.Context, *Ydb_Table.ExplainDataQueryRequest) (*Ydb_Table.ExplainDataQueryResponse, error)
	// Prepares data query, returns query id.
	// SessionId of previously created session must be provided.
	PrepareDataQuery(context.Context, *Ydb_Table.PrepareDataQueryRequest) (*Ydb_Table.PrepareDataQueryResponse, error)
	// Executes data query.
	// SessionId of previously created session must be provided.
	ExecuteDataQuery(context.Context, *Ydb_Table.ExecuteDataQueryRequest) (*Ydb_Table.ExecuteDataQueryResponse, error)
	// Executes scheme query.
	// SessionId of previously created session must be provided.
	ExecuteSchemeQuery(context.Context, *Ydb_Table.ExecuteSchemeQueryRequest) (*Ydb_Table.ExecuteSchemeQueryResponse, error)
	// Begins new transaction.
	BeginTransaction(context.Context, *Ydb_Table.BeginTransactionRequest) (*Ydb_Table.BeginTransactionResponse, error)
	// Commits specified active transaction.
	CommitTransaction(context.Context, *Ydb_Table.CommitTransactionRequest) (*Ydb_Table.CommitTransactionResponse, error)
	// Performs a rollback of the specified active transaction.
	RollbackTransaction(context.Context, *Ydb_Table.RollbackTransactionRequest) (*Ydb_Table.RollbackTransactionResponse, error)
	// Describe supported table options.
	DescribeTableOptions(context.Context, *Ydb_Table.DescribeTableOptionsRequest) (*Ydb_Table.DescribeTableOptionsResponse, error)
	// Streaming read table
	StreamReadTable(*Ydb_Table.ReadTableRequest, TableService_StreamReadTableServer) error
	// Reads specified keys non-transactionally from a single table
	ReadRows(context.Context, *Ydb_Table.ReadRowsRequest) (*Ydb_Table.ReadRowsResponse, error)
	// Upserts a batch of rows non-transactionally.
	// Returns success only when all rows were successfully upserted. In case of an error some rows might
	// be upserted and some might not.
	BulkUpsert(context.Context, *Ydb_Table.BulkUpsertRequest) (*Ydb_Table.BulkUpsertResponse, error)
	// Executes scan query with streaming result.
	StreamExecuteScanQuery(*Ydb_Table.ExecuteScanQueryRequest, TableService_StreamExecuteScanQueryServer) error
	// contains filtered or unexported methods
}

TableServiceServer is the server API for TableService service. All implementations must embed UnimplementedTableServiceServer for forward compatibility

type TableService_StreamExecuteScanQueryClient

type TableService_StreamExecuteScanQueryClient interface {
	Recv() (*Ydb_Table.ExecuteScanQueryPartialResponse, error)
	grpc.ClientStream
}

type TableService_StreamExecuteScanQueryServer

type TableService_StreamExecuteScanQueryServer interface {
	Send(*Ydb_Table.ExecuteScanQueryPartialResponse) error
	grpc.ServerStream
}

type TableService_StreamReadTableClient

type TableService_StreamReadTableClient interface {
	Recv() (*Ydb_Table.ReadTableResponse, error)
	grpc.ClientStream
}

type TableService_StreamReadTableServer

type TableService_StreamReadTableServer interface {
	Send(*Ydb_Table.ReadTableResponse) error
	grpc.ServerStream
}

type UnimplementedTableServiceServer

type UnimplementedTableServiceServer struct {
}

UnimplementedTableServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedTableServiceServer) ReadRows

type UnsafeTableServiceServer

type UnsafeTableServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeTableServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to TableServiceServer will result in compilation errors.

Jump to

Keyboard shortcuts

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