ydb_table_v1.proto

syntax = "proto3";

package Ydb.Table.V1;

option go_package = "github.com/ydb-platform/ydb-go-genproto/Ydb_Table_V1";
option java_package = "tech.ydb.proto.table.v1";

import "protos/ydb_table.proto";

service TableService {

    // 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.
    rpc CreateSession(Table.CreateSessionRequest) returns (Table.CreateSessionResponse);

    // Ends a session, releasing server resources associated with it.
    rpc DeleteSession(Table.DeleteSessionRequest) returns (Table.DeleteSessionResponse);

    // Idle sessions can be kept alive by calling KeepAlive periodically.
    rpc KeepAlive(Table.KeepAliveRequest) returns (Table.KeepAliveResponse);

    // Creates new table.
    rpc CreateTable(Table.CreateTableRequest) returns (Table.CreateTableResponse);

    // Drop table.
    rpc DropTable(Table.DropTableRequest) returns (Table.DropTableResponse);

    // Modifies schema of given table.
    rpc AlterTable(Table.AlterTableRequest) returns (Table.AlterTableResponse);

    // Creates copy of given table.
    rpc CopyTable(Table.CopyTableRequest) returns (Table.CopyTableResponse);

    // Creates consistent copy of given tables.
    rpc CopyTables(Table.CopyTablesRequest) returns (Table.CopyTablesResponse);

    // Creates consistent move of given tables.
    rpc RenameTables(Table.RenameTablesRequest) returns (Table.RenameTablesResponse);

    // Returns information about given table (metadata).
    rpc DescribeTable(Table.DescribeTableRequest) returns (Table.DescribeTableResponse);

    // Explains data query.
    // SessionId of previously created session must be provided.
    rpc ExplainDataQuery(Table.ExplainDataQueryRequest) returns (Table.ExplainDataQueryResponse);

    // Prepares data query, returns query id.
    // SessionId of previously created session must be provided.
    rpc PrepareDataQuery(Table.PrepareDataQueryRequest) returns (Table.PrepareDataQueryResponse);

    // Executes data query.
    // SessionId of previously created session must be provided.
    rpc ExecuteDataQuery(Table.ExecuteDataQueryRequest) returns (Table.ExecuteDataQueryResponse);

    // Executes scheme query.
    // SessionId of previously created session must be provided.
    rpc ExecuteSchemeQuery(Table.ExecuteSchemeQueryRequest) returns (Table.ExecuteSchemeQueryResponse);

    // Begins new transaction.
    rpc BeginTransaction(Table.BeginTransactionRequest) returns (Table.BeginTransactionResponse);

    // Commits specified active transaction.
    rpc CommitTransaction(Table.CommitTransactionRequest) returns (Table.CommitTransactionResponse);

    // Performs a rollback of the specified active transaction.
    rpc RollbackTransaction(Table.RollbackTransactionRequest) returns (Table.RollbackTransactionResponse);

    // Describe supported table options.
    rpc DescribeTableOptions(Table.DescribeTableOptionsRequest) returns (Table.DescribeTableOptionsResponse);

    // Streaming read table
    rpc StreamReadTable(Table.ReadTableRequest) returns (stream Table.ReadTableResponse);

    // Reads specified keys non-transactionally from a single table
    rpc ReadRows(Table.ReadRowsRequest) returns (Table.ReadRowsResponse);

    // 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.
    rpc BulkUpsert(Table.BulkUpsertRequest) returns (Table.BulkUpsertResponse);

    // Executes scan query with streaming result.
    rpc StreamExecuteScanQuery(Table.ExecuteScanQueryRequest) returns (stream Table.ExecuteScanQueryPartialResponse);
}