@ydbjs/api
Version:
TypeScript gRPC service definitions and protobuf types for all YDB APIs. Enables strongly-typed client generation and low-level protocol access.
353 lines • 18.6 kB
JavaScript
// @generated by protoc-gen-nice-grpc v1 with parameter "target=ts,import_extension=js"
// @generated from file ydb_table_v1.proto (package Ydb.Table.V1, syntax proto3)
/* eslint-disable */
import { create, fromBinary, toBinary } from "@bufbuild/protobuf";
import { AlterTableRequestSchema, AlterTableResponseSchema, BeginTransactionRequestSchema, BeginTransactionResponseSchema, BulkUpsertRequestSchema, BulkUpsertResponseSchema, CommitTransactionRequestSchema, CommitTransactionResponseSchema, CopyTableRequestSchema, CopyTableResponseSchema, CopyTablesRequestSchema, CopyTablesResponseSchema, CreateSessionRequestSchema, CreateSessionResponseSchema, CreateTableRequestSchema, CreateTableResponseSchema, DeleteSessionRequestSchema, DeleteSessionResponseSchema, DescribeTableOptionsRequestSchema, DescribeTableOptionsResponseSchema, DescribeTableRequestSchema, DescribeTableResponseSchema, DropTableRequestSchema, DropTableResponseSchema, ExecuteDataQueryRequestSchema, ExecuteDataQueryResponseSchema, ExecuteScanQueryPartialResponseSchema, ExecuteScanQueryRequestSchema, ExecuteSchemeQueryRequestSchema, ExecuteSchemeQueryResponseSchema, ExplainDataQueryRequestSchema, ExplainDataQueryResponseSchema, KeepAliveRequestSchema, KeepAliveResponseSchema, PrepareDataQueryRequestSchema, PrepareDataQueryResponseSchema, ReadRowsRequestSchema, ReadRowsResponseSchema, ReadTableRequestSchema, ReadTableResponseSchema, RenameTablesRequestSchema, RenameTablesResponseSchema, RollbackTransactionRequestSchema, RollbackTransactionResponseSchema } from "./protos/ydb_table_pb.js";
/**
* @generated from service Ydb.Table.V1.TableService
*/
export const TableServiceDefinition = {
/**
* 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.
*
* @generated from rpc Ydb.Table.V1.TableService.CreateSession
*/
createSession: {
path: "/Ydb.Table.V1.TableService/CreateSession",
requestStream: false,
requestSerialize: (message) => toBinary(CreateSessionRequestSchema, create(CreateSessionRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(CreateSessionRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(CreateSessionResponseSchema, create(CreateSessionResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(CreateSessionResponseSchema, bytes),
options: {},
},
/**
* Ends a session, releasing server resources associated with it.
*
* @generated from rpc Ydb.Table.V1.TableService.DeleteSession
*/
deleteSession: {
path: "/Ydb.Table.V1.TableService/DeleteSession",
requestStream: false,
requestSerialize: (message) => toBinary(DeleteSessionRequestSchema, create(DeleteSessionRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(DeleteSessionRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(DeleteSessionResponseSchema, create(DeleteSessionResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(DeleteSessionResponseSchema, bytes),
options: {},
},
/**
* Idle sessions can be kept alive by calling KeepAlive periodically.
*
* @generated from rpc Ydb.Table.V1.TableService.KeepAlive
*/
keepAlive: {
path: "/Ydb.Table.V1.TableService/KeepAlive",
requestStream: false,
requestSerialize: (message) => toBinary(KeepAliveRequestSchema, create(KeepAliveRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(KeepAliveRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(KeepAliveResponseSchema, create(KeepAliveResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(KeepAliveResponseSchema, bytes),
options: {},
},
/**
* Creates new table.
*
* @generated from rpc Ydb.Table.V1.TableService.CreateTable
*/
createTable: {
path: "/Ydb.Table.V1.TableService/CreateTable",
requestStream: false,
requestSerialize: (message) => toBinary(CreateTableRequestSchema, create(CreateTableRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(CreateTableRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(CreateTableResponseSchema, create(CreateTableResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(CreateTableResponseSchema, bytes),
options: {},
},
/**
* Drop table.
*
* @generated from rpc Ydb.Table.V1.TableService.DropTable
*/
dropTable: {
path: "/Ydb.Table.V1.TableService/DropTable",
requestStream: false,
requestSerialize: (message) => toBinary(DropTableRequestSchema, create(DropTableRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(DropTableRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(DropTableResponseSchema, create(DropTableResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(DropTableResponseSchema, bytes),
options: {},
},
/**
* Modifies schema of given table.
*
* @generated from rpc Ydb.Table.V1.TableService.AlterTable
*/
alterTable: {
path: "/Ydb.Table.V1.TableService/AlterTable",
requestStream: false,
requestSerialize: (message) => toBinary(AlterTableRequestSchema, create(AlterTableRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(AlterTableRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(AlterTableResponseSchema, create(AlterTableResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(AlterTableResponseSchema, bytes),
options: {},
},
/**
* Creates copy of given table.
*
* @generated from rpc Ydb.Table.V1.TableService.CopyTable
*/
copyTable: {
path: "/Ydb.Table.V1.TableService/CopyTable",
requestStream: false,
requestSerialize: (message) => toBinary(CopyTableRequestSchema, create(CopyTableRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(CopyTableRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(CopyTableResponseSchema, create(CopyTableResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(CopyTableResponseSchema, bytes),
options: {},
},
/**
* Creates consistent copy of given tables.
*
* @generated from rpc Ydb.Table.V1.TableService.CopyTables
*/
copyTables: {
path: "/Ydb.Table.V1.TableService/CopyTables",
requestStream: false,
requestSerialize: (message) => toBinary(CopyTablesRequestSchema, create(CopyTablesRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(CopyTablesRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(CopyTablesResponseSchema, create(CopyTablesResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(CopyTablesResponseSchema, bytes),
options: {},
},
/**
* Creates consistent move of given tables.
*
* @generated from rpc Ydb.Table.V1.TableService.RenameTables
*/
renameTables: {
path: "/Ydb.Table.V1.TableService/RenameTables",
requestStream: false,
requestSerialize: (message) => toBinary(RenameTablesRequestSchema, create(RenameTablesRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(RenameTablesRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(RenameTablesResponseSchema, create(RenameTablesResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(RenameTablesResponseSchema, bytes),
options: {},
},
/**
* Returns information about given table (metadata).
*
* @generated from rpc Ydb.Table.V1.TableService.DescribeTable
*/
describeTable: {
path: "/Ydb.Table.V1.TableService/DescribeTable",
requestStream: false,
requestSerialize: (message) => toBinary(DescribeTableRequestSchema, create(DescribeTableRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(DescribeTableRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(DescribeTableResponseSchema, create(DescribeTableResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(DescribeTableResponseSchema, bytes),
options: {},
},
/**
* Explains data query.
* SessionId of previously created session must be provided.
*
* @generated from rpc Ydb.Table.V1.TableService.ExplainDataQuery
*/
explainDataQuery: {
path: "/Ydb.Table.V1.TableService/ExplainDataQuery",
requestStream: false,
requestSerialize: (message) => toBinary(ExplainDataQueryRequestSchema, create(ExplainDataQueryRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(ExplainDataQueryRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(ExplainDataQueryResponseSchema, create(ExplainDataQueryResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(ExplainDataQueryResponseSchema, bytes),
options: {},
},
/**
* Prepares data query, returns query id.
* SessionId of previously created session must be provided.
*
* @generated from rpc Ydb.Table.V1.TableService.PrepareDataQuery
*/
prepareDataQuery: {
path: "/Ydb.Table.V1.TableService/PrepareDataQuery",
requestStream: false,
requestSerialize: (message) => toBinary(PrepareDataQueryRequestSchema, create(PrepareDataQueryRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(PrepareDataQueryRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(PrepareDataQueryResponseSchema, create(PrepareDataQueryResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(PrepareDataQueryResponseSchema, bytes),
options: {},
},
/**
* Executes data query.
* SessionId of previously created session must be provided.
*
* @generated from rpc Ydb.Table.V1.TableService.ExecuteDataQuery
*/
executeDataQuery: {
path: "/Ydb.Table.V1.TableService/ExecuteDataQuery",
requestStream: false,
requestSerialize: (message) => toBinary(ExecuteDataQueryRequestSchema, create(ExecuteDataQueryRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(ExecuteDataQueryRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(ExecuteDataQueryResponseSchema, create(ExecuteDataQueryResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(ExecuteDataQueryResponseSchema, bytes),
options: {},
},
/**
* Executes scheme query.
* SessionId of previously created session must be provided.
*
* @generated from rpc Ydb.Table.V1.TableService.ExecuteSchemeQuery
*/
executeSchemeQuery: {
path: "/Ydb.Table.V1.TableService/ExecuteSchemeQuery",
requestStream: false,
requestSerialize: (message) => toBinary(ExecuteSchemeQueryRequestSchema, create(ExecuteSchemeQueryRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(ExecuteSchemeQueryRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(ExecuteSchemeQueryResponseSchema, create(ExecuteSchemeQueryResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(ExecuteSchemeQueryResponseSchema, bytes),
options: {},
},
/**
* Begins new transaction.
*
* @generated from rpc Ydb.Table.V1.TableService.BeginTransaction
*/
beginTransaction: {
path: "/Ydb.Table.V1.TableService/BeginTransaction",
requestStream: false,
requestSerialize: (message) => toBinary(BeginTransactionRequestSchema, create(BeginTransactionRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(BeginTransactionRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(BeginTransactionResponseSchema, create(BeginTransactionResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(BeginTransactionResponseSchema, bytes),
options: {},
},
/**
* Commits specified active transaction.
*
* @generated from rpc Ydb.Table.V1.TableService.CommitTransaction
*/
commitTransaction: {
path: "/Ydb.Table.V1.TableService/CommitTransaction",
requestStream: false,
requestSerialize: (message) => toBinary(CommitTransactionRequestSchema, create(CommitTransactionRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(CommitTransactionRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(CommitTransactionResponseSchema, create(CommitTransactionResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(CommitTransactionResponseSchema, bytes),
options: {},
},
/**
* Performs a rollback of the specified active transaction.
*
* @generated from rpc Ydb.Table.V1.TableService.RollbackTransaction
*/
rollbackTransaction: {
path: "/Ydb.Table.V1.TableService/RollbackTransaction",
requestStream: false,
requestSerialize: (message) => toBinary(RollbackTransactionRequestSchema, create(RollbackTransactionRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(RollbackTransactionRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(RollbackTransactionResponseSchema, create(RollbackTransactionResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(RollbackTransactionResponseSchema, bytes),
options: {},
},
/**
* Describe supported table options.
*
* @generated from rpc Ydb.Table.V1.TableService.DescribeTableOptions
*/
describeTableOptions: {
path: "/Ydb.Table.V1.TableService/DescribeTableOptions",
requestStream: false,
requestSerialize: (message) => toBinary(DescribeTableOptionsRequestSchema, create(DescribeTableOptionsRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(DescribeTableOptionsRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(DescribeTableOptionsResponseSchema, create(DescribeTableOptionsResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(DescribeTableOptionsResponseSchema, bytes),
options: {},
},
/**
* Streaming read table
*
* @generated from rpc Ydb.Table.V1.TableService.StreamReadTable
*/
streamReadTable: {
path: "/Ydb.Table.V1.TableService/StreamReadTable",
requestStream: false,
requestSerialize: (message) => toBinary(ReadTableRequestSchema, create(ReadTableRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(ReadTableRequestSchema, bytes),
responseStream: true,
responseSerialize: (message) => toBinary(ReadTableResponseSchema, create(ReadTableResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(ReadTableResponseSchema, bytes),
options: {},
},
/**
* Reads specified keys non-transactionally from a single table
*
* @generated from rpc Ydb.Table.V1.TableService.ReadRows
*/
readRows: {
path: "/Ydb.Table.V1.TableService/ReadRows",
requestStream: false,
requestSerialize: (message) => toBinary(ReadRowsRequestSchema, create(ReadRowsRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(ReadRowsRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(ReadRowsResponseSchema, create(ReadRowsResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(ReadRowsResponseSchema, bytes),
options: {},
},
/**
* 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.
*
* @generated from rpc Ydb.Table.V1.TableService.BulkUpsert
*/
bulkUpsert: {
path: "/Ydb.Table.V1.TableService/BulkUpsert",
requestStream: false,
requestSerialize: (message) => toBinary(BulkUpsertRequestSchema, create(BulkUpsertRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(BulkUpsertRequestSchema, bytes),
responseStream: false,
responseSerialize: (message) => toBinary(BulkUpsertResponseSchema, create(BulkUpsertResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(BulkUpsertResponseSchema, bytes),
options: {},
},
/**
* Executes scan query with streaming result.
*
* @generated from rpc Ydb.Table.V1.TableService.StreamExecuteScanQuery
*/
streamExecuteScanQuery: {
path: "/Ydb.Table.V1.TableService/StreamExecuteScanQuery",
requestStream: false,
requestSerialize: (message) => toBinary(ExecuteScanQueryRequestSchema, create(ExecuteScanQueryRequestSchema, message)),
requestDeserialize: (bytes) => fromBinary(ExecuteScanQueryRequestSchema, bytes),
responseStream: true,
responseSerialize: (message) => toBinary(ExecuteScanQueryPartialResponseSchema, create(ExecuteScanQueryPartialResponseSchema, message)),
responseDeserialize: (bytes) => fromBinary(ExecuteScanQueryPartialResponseSchema, bytes),
options: {},
},
};
//# sourceMappingURL=ydb_table_v1_grpc_pb.js.map