@ydbjs/api
Version:
TypeScript gRPC service definitions and protobuf types for all YDB APIs. Enables strongly-typed client generation and low-level protocol access.
786 lines • 23.8 kB
TypeScript
import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
import type { Duration } from "../google/protobuf/duration_pb.js";
import type { IssueMessage } from "./ydb_issue_message_pb.js";
import type { OperationParams } from "./ydb_operation_pb.js";
import type { QueryStats } from "./ydb_query_stats_pb.js";
import type { StatusIds_StatusCode } from "./ydb_status_codes_pb.js";
import type { Column, ResultSet, TypedValue } from "./ydb_value_pb.js";
import type { Message } from "@bufbuild/protobuf";
/**
* Describes the file protos/ydb_query.proto.
*/
export declare const file_protos_ydb_query: GenFile;
/**
* @generated from message Ydb.Query.CreateSessionRequest
*/
export type CreateSessionRequest = Message<"Ydb.Query.CreateSessionRequest"> & {};
/**
* Describes the message Ydb.Query.CreateSessionRequest.
* Use `create(CreateSessionRequestSchema)` to create a new message.
*/
export declare const CreateSessionRequestSchema: GenMessage<CreateSessionRequest>;
/**
* @generated from message Ydb.Query.CreateSessionResponse
*/
export type CreateSessionResponse = Message<"Ydb.Query.CreateSessionResponse"> & {
/**
* @generated from field: Ydb.StatusIds.StatusCode status = 1;
*/
status: StatusIds_StatusCode;
/**
* @generated from field: repeated Ydb.Issue.IssueMessage issues = 2;
*/
issues: IssueMessage[];
/**
* Identifier of created session
*
* @generated from field: string session_id = 3;
*/
sessionId: string;
/**
* Identifier node where session was created
*
* @generated from field: int64 node_id = 4;
*/
nodeId: bigint;
};
/**
* Describes the message Ydb.Query.CreateSessionResponse.
* Use `create(CreateSessionResponseSchema)` to create a new message.
*/
export declare const CreateSessionResponseSchema: GenMessage<CreateSessionResponse>;
/**
* @generated from message Ydb.Query.DeleteSessionRequest
*/
export type DeleteSessionRequest = Message<"Ydb.Query.DeleteSessionRequest"> & {
/**
* Identifier of session to delete (required)
*
* @generated from field: string session_id = 1;
*/
sessionId: string;
};
/**
* Describes the message Ydb.Query.DeleteSessionRequest.
* Use `create(DeleteSessionRequestSchema)` to create a new message.
*/
export declare const DeleteSessionRequestSchema: GenMessage<DeleteSessionRequest>;
/**
* @generated from message Ydb.Query.DeleteSessionResponse
*/
export type DeleteSessionResponse = Message<"Ydb.Query.DeleteSessionResponse"> & {
/**
* @generated from field: Ydb.StatusIds.StatusCode status = 1;
*/
status: StatusIds_StatusCode;
/**
* @generated from field: repeated Ydb.Issue.IssueMessage issues = 2;
*/
issues: IssueMessage[];
};
/**
* Describes the message Ydb.Query.DeleteSessionResponse.
* Use `create(DeleteSessionResponseSchema)` to create a new message.
*/
export declare const DeleteSessionResponseSchema: GenMessage<DeleteSessionResponse>;
/**
* @generated from message Ydb.Query.AttachSessionRequest
*/
export type AttachSessionRequest = Message<"Ydb.Query.AttachSessionRequest"> & {
/**
* Identifier of session to attach (required)
*
* @generated from field: string session_id = 1;
*/
sessionId: string;
};
/**
* Describes the message Ydb.Query.AttachSessionRequest.
* Use `create(AttachSessionRequestSchema)` to create a new message.
*/
export declare const AttachSessionRequestSchema: GenMessage<AttachSessionRequest>;
/**
* @generated from message Ydb.Query.SessionState
*/
export type SessionState = Message<"Ydb.Query.SessionState"> & {
/**
* @generated from field: Ydb.StatusIds.StatusCode status = 1;
*/
status: StatusIds_StatusCode;
/**
* @generated from field: repeated Ydb.Issue.IssueMessage issues = 2;
*/
issues: IssueMessage[];
};
/**
* Describes the message Ydb.Query.SessionState.
* Use `create(SessionStateSchema)` to create a new message.
*/
export declare const SessionStateSchema: GenMessage<SessionState>;
/**
* @generated from message Ydb.Query.SerializableModeSettings
*/
export type SerializableModeSettings = Message<"Ydb.Query.SerializableModeSettings"> & {};
/**
* Describes the message Ydb.Query.SerializableModeSettings.
* Use `create(SerializableModeSettingsSchema)` to create a new message.
*/
export declare const SerializableModeSettingsSchema: GenMessage<SerializableModeSettings>;
/**
* @generated from message Ydb.Query.OnlineModeSettings
*/
export type OnlineModeSettings = Message<"Ydb.Query.OnlineModeSettings"> & {
/**
* @generated from field: bool allow_inconsistent_reads = 1;
*/
allowInconsistentReads: boolean;
};
/**
* Describes the message Ydb.Query.OnlineModeSettings.
* Use `create(OnlineModeSettingsSchema)` to create a new message.
*/
export declare const OnlineModeSettingsSchema: GenMessage<OnlineModeSettings>;
/**
* @generated from message Ydb.Query.StaleModeSettings
*/
export type StaleModeSettings = Message<"Ydb.Query.StaleModeSettings"> & {};
/**
* Describes the message Ydb.Query.StaleModeSettings.
* Use `create(StaleModeSettingsSchema)` to create a new message.
*/
export declare const StaleModeSettingsSchema: GenMessage<StaleModeSettings>;
/**
* @generated from message Ydb.Query.SnapshotModeSettings
*/
export type SnapshotModeSettings = Message<"Ydb.Query.SnapshotModeSettings"> & {};
/**
* Describes the message Ydb.Query.SnapshotModeSettings.
* Use `create(SnapshotModeSettingsSchema)` to create a new message.
*/
export declare const SnapshotModeSettingsSchema: GenMessage<SnapshotModeSettings>;
/**
* @generated from message Ydb.Query.TransactionSettings
*/
export type TransactionSettings = Message<"Ydb.Query.TransactionSettings"> & {
/**
* @generated from oneof Ydb.Query.TransactionSettings.tx_mode
*/
txMode: {
/**
* @generated from field: Ydb.Query.SerializableModeSettings serializable_read_write = 1;
*/
value: SerializableModeSettings;
case: "serializableReadWrite";
} | {
/**
* @generated from field: Ydb.Query.OnlineModeSettings online_read_only = 2;
*/
value: OnlineModeSettings;
case: "onlineReadOnly";
} | {
/**
* @generated from field: Ydb.Query.StaleModeSettings stale_read_only = 3;
*/
value: StaleModeSettings;
case: "staleReadOnly";
} | {
/**
* @generated from field: Ydb.Query.SnapshotModeSettings snapshot_read_only = 4;
*/
value: SnapshotModeSettings;
case: "snapshotReadOnly";
} | {
case: undefined;
value?: undefined;
};
};
/**
* Describes the message Ydb.Query.TransactionSettings.
* Use `create(TransactionSettingsSchema)` to create a new message.
*/
export declare const TransactionSettingsSchema: GenMessage<TransactionSettings>;
/**
* @generated from message Ydb.Query.TransactionControl
*/
export type TransactionControl = Message<"Ydb.Query.TransactionControl"> & {
/**
* @generated from oneof Ydb.Query.TransactionControl.tx_selector
*/
txSelector: {
/**
* @generated from field: string tx_id = 1;
*/
value: string;
case: "txId";
} | {
/**
* @generated from field: Ydb.Query.TransactionSettings begin_tx = 2;
*/
value: TransactionSettings;
case: "beginTx";
} | {
case: undefined;
value?: undefined;
};
/**
* @generated from field: bool commit_tx = 10;
*/
commitTx: boolean;
};
/**
* Describes the message Ydb.Query.TransactionControl.
* Use `create(TransactionControlSchema)` to create a new message.
*/
export declare const TransactionControlSchema: GenMessage<TransactionControl>;
/**
* @generated from message Ydb.Query.BeginTransactionRequest
*/
export type BeginTransactionRequest = Message<"Ydb.Query.BeginTransactionRequest"> & {
/**
* Session identifier (required)
*
* @generated from field: string session_id = 1;
*/
sessionId: string;
/**
* @generated from field: Ydb.Query.TransactionSettings tx_settings = 2;
*/
txSettings?: TransactionSettings;
};
/**
* Describes the message Ydb.Query.BeginTransactionRequest.
* Use `create(BeginTransactionRequestSchema)` to create a new message.
*/
export declare const BeginTransactionRequestSchema: GenMessage<BeginTransactionRequest>;
/**
* @generated from message Ydb.Query.TransactionMeta
*/
export type TransactionMeta = Message<"Ydb.Query.TransactionMeta"> & {
/**
* Transaction identifier
*
* @generated from field: string id = 1;
*/
id: string;
};
/**
* Describes the message Ydb.Query.TransactionMeta.
* Use `create(TransactionMetaSchema)` to create a new message.
*/
export declare const TransactionMetaSchema: GenMessage<TransactionMeta>;
/**
* @generated from message Ydb.Query.BeginTransactionResponse
*/
export type BeginTransactionResponse = Message<"Ydb.Query.BeginTransactionResponse"> & {
/**
* @generated from field: Ydb.StatusIds.StatusCode status = 1;
*/
status: StatusIds_StatusCode;
/**
* @generated from field: repeated Ydb.Issue.IssueMessage issues = 2;
*/
issues: IssueMessage[];
/**
* @generated from field: Ydb.Query.TransactionMeta tx_meta = 3;
*/
txMeta?: TransactionMeta;
};
/**
* Describes the message Ydb.Query.BeginTransactionResponse.
* Use `create(BeginTransactionResponseSchema)` to create a new message.
*/
export declare const BeginTransactionResponseSchema: GenMessage<BeginTransactionResponse>;
/**
* @generated from message Ydb.Query.CommitTransactionRequest
*/
export type CommitTransactionRequest = Message<"Ydb.Query.CommitTransactionRequest"> & {
/**
* Session identifier (required)
*
* @generated from field: string session_id = 1;
*/
sessionId: string;
/**
* Transaction identifier (required)
*
* @generated from field: string tx_id = 2;
*/
txId: string;
};
/**
* Describes the message Ydb.Query.CommitTransactionRequest.
* Use `create(CommitTransactionRequestSchema)` to create a new message.
*/
export declare const CommitTransactionRequestSchema: GenMessage<CommitTransactionRequest>;
/**
* @generated from message Ydb.Query.CommitTransactionResponse
*/
export type CommitTransactionResponse = Message<"Ydb.Query.CommitTransactionResponse"> & {
/**
* @generated from field: Ydb.StatusIds.StatusCode status = 1;
*/
status: StatusIds_StatusCode;
/**
* @generated from field: repeated Ydb.Issue.IssueMessage issues = 2;
*/
issues: IssueMessage[];
};
/**
* Describes the message Ydb.Query.CommitTransactionResponse.
* Use `create(CommitTransactionResponseSchema)` to create a new message.
*/
export declare const CommitTransactionResponseSchema: GenMessage<CommitTransactionResponse>;
/**
* @generated from message Ydb.Query.RollbackTransactionRequest
*/
export type RollbackTransactionRequest = Message<"Ydb.Query.RollbackTransactionRequest"> & {
/**
* Session identifier (required)
*
* @generated from field: string session_id = 1;
*/
sessionId: string;
/**
* Transaction identifier (required)
*
* @generated from field: string tx_id = 2;
*/
txId: string;
};
/**
* Describes the message Ydb.Query.RollbackTransactionRequest.
* Use `create(RollbackTransactionRequestSchema)` to create a new message.
*/
export declare const RollbackTransactionRequestSchema: GenMessage<RollbackTransactionRequest>;
/**
* @generated from message Ydb.Query.RollbackTransactionResponse
*/
export type RollbackTransactionResponse = Message<"Ydb.Query.RollbackTransactionResponse"> & {
/**
* @generated from field: Ydb.StatusIds.StatusCode status = 1;
*/
status: StatusIds_StatusCode;
/**
* @generated from field: repeated Ydb.Issue.IssueMessage issues = 2;
*/
issues: IssueMessage[];
};
/**
* Describes the message Ydb.Query.RollbackTransactionResponse.
* Use `create(RollbackTransactionResponseSchema)` to create a new message.
*/
export declare const RollbackTransactionResponseSchema: GenMessage<RollbackTransactionResponse>;
/**
* @generated from message Ydb.Query.QueryContent
*/
export type QueryContent = Message<"Ydb.Query.QueryContent"> & {
/**
* @generated from field: Ydb.Query.Syntax syntax = 1;
*/
syntax: Syntax;
/**
* @generated from field: string text = 2;
*/
text: string;
};
/**
* Describes the message Ydb.Query.QueryContent.
* Use `create(QueryContentSchema)` to create a new message.
*/
export declare const QueryContentSchema: GenMessage<QueryContent>;
/**
* @generated from message Ydb.Query.ExecuteQueryRequest
*/
export type ExecuteQueryRequest = Message<"Ydb.Query.ExecuteQueryRequest"> & {
/**
* Session identifier (required)
*
* @generated from field: string session_id = 1;
*/
sessionId: string;
/**
* @generated from field: Ydb.Query.ExecMode exec_mode = 2;
*/
execMode: ExecMode;
/**
* @generated from field: Ydb.Query.TransactionControl tx_control = 3;
*/
txControl?: TransactionControl;
/**
* @generated from oneof Ydb.Query.ExecuteQueryRequest.query
*/
query: {
/**
* @generated from field: Ydb.Query.QueryContent query_content = 4;
*/
value: QueryContent;
case: "queryContent";
} | {
case: undefined;
value?: undefined;
};
/**
* @generated from field: map<string, Ydb.TypedValue> parameters = 6;
*/
parameters: {
[key: string]: TypedValue;
};
/**
* @generated from field: Ydb.Query.StatsMode stats_mode = 7;
*/
statsMode: StatsMode;
/**
* For queries with multiple result sets, some of them may be computed concurrently.
* If true, parts of different results sets may be interleaved in response stream.
*
* @generated from field: bool concurrent_result_sets = 8;
*/
concurrentResultSets: boolean;
/**
* Allows to set size limitation (in bytes) for one result part
*
* @generated from field: int64 response_part_limit_bytes = 9;
*/
responsePartLimitBytes: bigint;
/**
* Workload manager pool id
*
* @generated from field: string pool_id = 10;
*/
poolId: string;
};
/**
* Describes the message Ydb.Query.ExecuteQueryRequest.
* Use `create(ExecuteQueryRequestSchema)` to create a new message.
*/
export declare const ExecuteQueryRequestSchema: GenMessage<ExecuteQueryRequest>;
/**
* @generated from message Ydb.Query.ResultSetMeta
*/
export type ResultSetMeta = Message<"Ydb.Query.ResultSetMeta"> & {
/**
* @generated from field: repeated Ydb.Column columns = 1;
*/
columns: Column[];
};
/**
* Describes the message Ydb.Query.ResultSetMeta.
* Use `create(ResultSetMetaSchema)` to create a new message.
*/
export declare const ResultSetMetaSchema: GenMessage<ResultSetMeta>;
/**
* @generated from message Ydb.Query.ExecuteQueryResponsePart
*/
export type ExecuteQueryResponsePart = Message<"Ydb.Query.ExecuteQueryResponsePart"> & {
/**
* @generated from field: Ydb.StatusIds.StatusCode status = 1;
*/
status: StatusIds_StatusCode;
/**
* @generated from field: repeated Ydb.Issue.IssueMessage issues = 2;
*/
issues: IssueMessage[];
/**
* Index of current result set
*
* @generated from field: int64 result_set_index = 3;
*/
resultSetIndex: bigint;
/**
* Result set part
*
* @generated from field: Ydb.ResultSet result_set = 4;
*/
resultSet?: ResultSet;
/**
* Execution statistics (last part only)
*
* @generated from field: Ydb.TableStats.QueryStats exec_stats = 5;
*/
execStats?: QueryStats;
/**
* @generated from field: Ydb.Query.TransactionMeta tx_meta = 6;
*/
txMeta?: TransactionMeta;
};
/**
* Describes the message Ydb.Query.ExecuteQueryResponsePart.
* Use `create(ExecuteQueryResponsePartSchema)` to create a new message.
*/
export declare const ExecuteQueryResponsePartSchema: GenMessage<ExecuteQueryResponsePart>;
/**
* @generated from message Ydb.Query.ExecuteScriptRequest
*/
export type ExecuteScriptRequest = Message<"Ydb.Query.ExecuteScriptRequest"> & {
/**
* @generated from field: Ydb.Operations.OperationParams operation_params = 1;
*/
operationParams?: OperationParams;
/**
* @generated from field: Ydb.Query.ExecMode exec_mode = 2;
*/
execMode: ExecMode;
/**
* @generated from field: Ydb.Query.QueryContent script_content = 3;
*/
scriptContent?: QueryContent;
/**
* @generated from field: map<string, Ydb.TypedValue> parameters = 4;
*/
parameters: {
[key: string]: TypedValue;
};
/**
* @generated from field: Ydb.Query.StatsMode stats_mode = 5;
*/
statsMode: StatsMode;
/**
* After script execution operation finishes, TTL will start counting.
* After this TTL the results will be removed from database.
*
* @generated from field: google.protobuf.Duration results_ttl = 6;
*/
resultsTtl?: Duration;
/**
* Workload manager pool id
*
* @generated from field: string pool_id = 7;
*/
poolId: string;
};
/**
* Describes the message Ydb.Query.ExecuteScriptRequest.
* Use `create(ExecuteScriptRequestSchema)` to create a new message.
*/
export declare const ExecuteScriptRequestSchema: GenMessage<ExecuteScriptRequest>;
/**
* @generated from message Ydb.Query.ExecuteScriptMetadata
*/
export type ExecuteScriptMetadata = Message<"Ydb.Query.ExecuteScriptMetadata"> & {
/**
* @generated from field: string execution_id = 1;
*/
executionId: string;
/**
* @generated from field: Ydb.Query.ExecStatus exec_status = 2;
*/
execStatus: ExecStatus;
/**
* @generated from field: Ydb.Query.QueryContent script_content = 3;
*/
scriptContent?: QueryContent;
/**
* @generated from field: repeated Ydb.Query.ResultSetMeta result_sets_meta = 4;
*/
resultSetsMeta: ResultSetMeta[];
/**
* @generated from field: Ydb.Query.ExecMode exec_mode = 5;
*/
execMode: ExecMode;
/**
* Execution statistics
*
* @generated from field: Ydb.TableStats.QueryStats exec_stats = 6;
*/
execStats?: QueryStats;
};
/**
* Describes the message Ydb.Query.ExecuteScriptMetadata.
* Use `create(ExecuteScriptMetadataSchema)` to create a new message.
*/
export declare const ExecuteScriptMetadataSchema: GenMessage<ExecuteScriptMetadata>;
/**
* @generated from message Ydb.Query.FetchScriptResultsRequest
*/
export type FetchScriptResultsRequest = Message<"Ydb.Query.FetchScriptResultsRequest"> & {
/**
* @generated from field: string operation_id = 1;
*/
operationId: string;
/**
* @generated from field: int64 result_set_index = 2;
*/
resultSetIndex: bigint;
/**
* @generated from field: string fetch_token = 3;
*/
fetchToken: string;
/**
* @generated from field: int64 rows_limit = 4;
*/
rowsLimit: bigint;
};
/**
* Describes the message Ydb.Query.FetchScriptResultsRequest.
* Use `create(FetchScriptResultsRequestSchema)` to create a new message.
*/
export declare const FetchScriptResultsRequestSchema: GenMessage<FetchScriptResultsRequest>;
/**
* @generated from message Ydb.Query.FetchScriptResultsResponse
*/
export type FetchScriptResultsResponse = Message<"Ydb.Query.FetchScriptResultsResponse"> & {
/**
* @generated from field: Ydb.StatusIds.StatusCode status = 1;
*/
status: StatusIds_StatusCode;
/**
* @generated from field: repeated Ydb.Issue.IssueMessage issues = 2;
*/
issues: IssueMessage[];
/**
* @generated from field: int64 result_set_index = 3;
*/
resultSetIndex: bigint;
/**
* @generated from field: Ydb.ResultSet result_set = 4;
*/
resultSet?: ResultSet;
/**
* @generated from field: string next_fetch_token = 5;
*/
nextFetchToken: string;
};
/**
* Describes the message Ydb.Query.FetchScriptResultsResponse.
* Use `create(FetchScriptResultsResponseSchema)` to create a new message.
*/
export declare const FetchScriptResultsResponseSchema: GenMessage<FetchScriptResultsResponse>;
/**
* @generated from message Ydb.Query.Script
*/
export type Script = Message<"Ydb.Query.Script"> & {
/**
* @generated from field: Ydb.Query.QueryContent script_content = 1;
*/
scriptContent?: QueryContent;
};
/**
* Describes the message Ydb.Query.Script.
* Use `create(ScriptSchema)` to create a new message.
*/
export declare const ScriptSchema: GenMessage<Script>;
/**
* @generated from enum Ydb.Query.Syntax
*/
export declare enum Syntax {
/**
* @generated from enum value: SYNTAX_UNSPECIFIED = 0;
*/
UNSPECIFIED = 0,
/**
* YQL
*
* @generated from enum value: SYNTAX_YQL_V1 = 1;
*/
YQL_V1 = 1,
/**
* PostgresQL
*
* @generated from enum value: SYNTAX_PG = 2;
*/
PG = 2
}
/**
* Describes the enum Ydb.Query.Syntax.
*/
export declare const SyntaxSchema: GenEnum<Syntax>;
/**
* @generated from enum Ydb.Query.ExecMode
*/
export declare enum ExecMode {
/**
* @generated from enum value: EXEC_MODE_UNSPECIFIED = 0;
*/
UNSPECIFIED = 0,
/**
* @generated from enum value: EXEC_MODE_PARSE = 10;
*/
PARSE = 10,
/**
* @generated from enum value: EXEC_MODE_VALIDATE = 20;
*/
VALIDATE = 20,
/**
* @generated from enum value: EXEC_MODE_EXPLAIN = 30;
*/
EXPLAIN = 30,
/**
* @generated from enum value: EXEC_MODE_EXECUTE = 50;
*/
EXECUTE = 50
}
/**
* Describes the enum Ydb.Query.ExecMode.
*/
export declare const ExecModeSchema: GenEnum<ExecMode>;
/**
* @generated from enum Ydb.Query.StatsMode
*/
export declare enum StatsMode {
/**
* @generated from enum value: STATS_MODE_UNSPECIFIED = 0;
*/
UNSPECIFIED = 0,
/**
* Stats collection is disabled
*
* @generated from enum value: STATS_MODE_NONE = 10;
*/
NONE = 10,
/**
* Aggregated stats of reads, updates and deletes per table
*
* @generated from enum value: STATS_MODE_BASIC = 20;
*/
BASIC = 20,
/**
* Add execution stats and plan on top of STATS_MODE_BASIC
*
* @generated from enum value: STATS_MODE_FULL = 30;
*/
FULL = 30,
/**
* Detailed execution stats including stats for individual tasks and channels
*
* @generated from enum value: STATS_MODE_PROFILE = 40;
*/
PROFILE = 40
}
/**
* Describes the enum Ydb.Query.StatsMode.
*/
export declare const StatsModeSchema: GenEnum<StatsMode>;
/**
* @generated from enum Ydb.Query.ExecStatus
*/
export declare enum ExecStatus {
/**
* @generated from enum value: EXEC_STATUS_UNSPECIFIED = 0;
*/
UNSPECIFIED = 0,
/**
* @generated from enum value: EXEC_STATUS_STARTING = 10;
*/
STARTING = 10,
/**
* @generated from enum value: EXEC_STATUS_ABORTED = 20;
*/
ABORTED = 20,
/**
* @generated from enum value: EXEC_STATUS_CANCELLED = 30;
*/
CANCELLED = 30,
/**
* @generated from enum value: EXEC_STATUS_COMPLETED = 40;
*/
COMPLETED = 40,
/**
* @generated from enum value: EXEC_STATUS_FAILED = 50;
*/
FAILED = 50
}
/**
* Describes the enum Ydb.Query.ExecStatus.
*/
export declare const ExecStatusSchema: GenEnum<ExecStatus>;
//# sourceMappingURL=ydb_query_pb.d.ts.map