ydb-embedded-ui 3.4.5 → 4.0.0

package/dist/types/api/schema.ts

@@ -229,19 +229,539 @@ interface DatabaseQuotas {
     ttl_min_run_internal_seconds: number;
 }
 
-// FIXME: incomplete
 export interface TTableDescription {
+    Name?: string;
+    /**
+     * @deprecated LocalPathId
+     *
+     * uint64
+     */
+    Id_Deprecated?: string;
+    Columns?: TColumnDescription[];
+    KeyColumnNames?: string[];
+    KeyColumnIds?: number[];
+    /**
+     * Describes uniform partitioning on first key column int on ranges.
+     * The first key column must be of integer type
+     */
+    UniformPartitionsCount?: number;
+
     PartitionConfig?: TPartitionConfig;
+    DropColumns?: TColumnDescription[];
+    Path?: string;
+
+    /** bytes */
+    PartitionRangeBegin?: unknown;
+    /** bytes */
+    PartitionRangeEnd?: unknown;
+    PartitionRangeBeginIsInclusive?: boolean;
+    PartitionRangeEndIsInclusive?: boolean;
+
+    CopyFromTable?: string;
+    /** Boundaries for non-uniform split */
+    SplitBoundary?: TSplitBoundary[];
+
+    TableIndexes?: TIndexDescription[];
+    /** uint64 */
+    TableSchemaVersion?: string;
+
+    PathId?: TPathID;
+
+    TTLSettings?: TTTLSettings;
+
+    /**
+     * used with CopyFromTable
+     *
+     * default false
+     */
+    OmitFollowers?: boolean;
+    /** default false */
+    IsBackup?: boolean;
+
+    CdcStreams?: TCdcStreamDescription[];
+    Sequences?: TSequenceDescription[];
+}
+
+interface TColumnDescription {
+    Name?: string;
+    Type?: string;
+    TypeId?: number;
+    TypeInfo?: TTypeInfo;
+    Id?: number;
+    Family?: number;
+    FamilyName?: string;
+    /** Path to sequence for default values */
+    DefaultFromSequence?: string;
+    NotNull?: boolean;
+}
+
+interface TSplitBoundary {
+    /** A tuple representing full key or key prefix */
+    KeyPrefix?: unknown;
+    /**
+     * Or same as KeyPrefix but already serialized
+     *
+     * bytes
+     */
+    SerializedKeyPrefix?: unknown;
+}
+
+export interface TTTLSettings {
+    Enabled?: TEnabled;
+    Disabled?: {};
+    UseTiering?: string;
+}
+
+interface TEnabled {
+    ColumnName?: string;
+    ExpireAfterSeconds?: number;
+    ColumnUnit?: EUnit;
+    SysSettings?: TSysSettings;
+}
+
+interface TSysSettings {
+    /**
+     * default 3600000000 (1 hour)
+     *
+     * uint64
+     */
+    RunInterval?: string;
+    /**
+     * default 300000000 (5 minutes)
+     *
+     * uint64
+     */
+    RetryInterval?: string;
+    /** default 512000 */
+    BatchMaxBytes?: number;
+    /** default 1 */
+    BatchMinKeys?: number;
+    /** default 256 */
+    BatchMaxKeys?: number;
+    /**
+     * zero means no limit
+     *
+     * default 0
+     */
+    MaxShardsInFlight?: number;
+}
+
+interface TSequenceDescription {
+    Name?: string;
+    /** sequence path id, assigned by schemeshard */
+    PathId?: TPathID;
+    /**
+     * incremented every time sequence is altered
+     *
+     * uint64
+     */
+    Version?: string;
+    /**
+     * current sequenceshard, assigned by schemeshard
+     *
+     * uint64
+     */
+    SequenceShard?: string;
+    /**
+     * minimum value, defaults to 1 or Min<i64>
+     *
+     * sint64
+     */
+    MinValue?: string;
+    /**
+     * maximum value, defaults to Max<i64> or -1
+     *
+     * sint64
+     */
+    MaxValue?: string;
+    /**
+     * start value, defaults to MinValue
+     *
+     * sint64
+     */
+    StartValue?: string;
+    /**
+     * number of items to cache, defaults to 1
+     *
+     * uint64
+     */
+    Cache?: string;
+    /**
+     * increment at each call, defaults to 1
+     *
+     * sint64
+     */
+    Increment?: string;
+    /** true when cycle on overflow is allowed */
+    Cycle?: boolean;
 }
 
-// FIXME: incomplete
 export interface TPartitionConfig {
+    /** One of the predefined policies*/
+    NamedCompactionPolicy?: string;
+    /** Customized policy */
+    CompactionPolicy?: TCompactionPolicy;
     /** uint64 */
     FollowerCount?: string;
+    /**
+     * Cache size for the whole tablet including all user and system tables
+     *
+     * uint64
+     */
+    ExecutorCacheSize?: string;
+    /**
+     * if true followers can upgrade to leader, if false followers only handle reads
+     *
+     * default true
+     */
+    AllowFollowerPromotion?: boolean;
+    /**
+     * Maximum size in bytes that is allowed to be read by a single Tx
+     *
+     * uint64
+     */
+    TxReadSizeLimit?: string;
     /** @deprecated use FollowerGroups */
     CrossDataCenterFollowerCount?: number;
+    /** for configuring erasure and disk categories */
+    ChannelProfileId?: number;
+    PartitioningPolicy?: TPartitioningPolicy;
+    PipelineConfig?: TPipelineConfig;
+    ColumnFamilies?: TFamilyDescription[];
+    ResourceProfile?: string;
+    DisableStatisticsCalculation?: boolean;
+    /**
+     * Build and use per-part bloom filter for fast key non-existence check
+     *
+     * default false
+     */
+    EnableFilterByKey?: boolean;
+    /**
+     * Commit log faster at the expense of bandwidth for cross-DC
+     *
+     * default true
+     */
+    ExecutorFastLogPolicy?: boolean;
+    StorageRooms?: TStorageRoom[];
+    /**
+     * Use erase cache for faster iteration over erased rows
+     *
+     * default true
+     */
+    EnableEraseCache?: boolean;
+    /**
+     * Minimum number of erased rows worth caching
+     *
+     * default 16
+     */
+    EraseCacheMinRows?: number;
+    /**
+     * Maximum number of bytes to use for cached rows
+     *
+     * default 1MB
+     */
+    EraseCacheMaxBytes?: number;
+    FreezeState?: EFreezeState;
+    ShadowData?: boolean;
     /** 0 or 1 items */
     FollowerGroups?: TFollowerGroup[];
+    /** uint64 milliseconds */
+    KeepSnapshotTimeout?: string;
+}
+
+enum EPurpose {
+    SysLog,
+    Log,
+    Data,
+    External,
+}
+
+interface TChannelPurpose {
+    Purpose?: EPurpose;
+    Channel?: number;
+}
+
+interface TStorageRoom {
+    RoomId?: number;
+    Explanation?: TChannelPurpose[];
+}
+
+interface TPipelineConfig {
+    /** default 8 */
+    NumActiveTx?: number;
+    DataTxCacheSize?: number;
+    /** default true */
+    EnableOutOfOrder?: boolean;
+    DisableImmediate?: boolean;
+    EnableSoftUpdates?: boolean;
+}
+interface TFamilyDescription {
+    Id?: number;
+    Room?: number;
+    /** @deprecated use ColumnCodec */
+    Codec?: number;
+    /** @deprecated use ColumnCache */
+    InMemory?: boolean;
+    Name?: string;
+    ColumnCodec?: EColumnCodec;
+    ColumnCache?: EColumnCache;
+    /** @deprecated use StorageConfig */
+    Storage?: EColumnStorage;
+    StorageConfig?: TStorageConfig;
+}
+
+interface TStorageConfig {
+    SysLog?: TStorageSettings;
+    Log?: TStorageSettings;
+    Data?: TStorageSettings;
+    External?: TStorageSettings;
+    DataThreshold?: number;
+    ExternalThreshold?: number;
+}
+
+enum EColumnCache {
+    ColumnCacheNone,
+    ColumnCacheOnce,
+    ColumnCacheEver,
+}
+
+enum EColumnStorage {
+    ColumnStorage1,
+    ColumnStorage2,
+    ColumnStorage1Ext1,
+    ColumnStorage1Ext2,
+    ColumnStorage2Ext1,
+    ColumnStorage2Ext2,
+    ColumnStorage1Med2Ext2,
+    ColumnStorage2Med2Ext2,
+    ColumnStorageTest_1_2_1k,
+}
+
+enum EFreezeState {
+    Unspecified,
+    Freeze,
+    Unfreeze,
+}
+
+interface TPartitioningPolicy {
+    /**
+     * Partition gets split when this threshold is exceeded
+     *
+     * uint64
+     */
+    SizeToSplit?: string;
+
+    MinPartitionsCount?: number;
+    MaxPartitionsCount?: number;
+
+    FastSplitSettings?: TFastSplitSettings;
+    SplitByLoadSettings?: TSplitByLoadSettings;
+}
+
+interface TFastSplitSettings {
+    /** uint64 */
+    SizeThreshold?: string;
+    /** uint64 */
+    RowCountThreshold?: string;
+    CpuPercentageThreshold?: number;
+}
+
+interface TSplitByLoadSettings {
+    Enabled?: boolean;
+    CpuPercentageThreshold?: number;
+}
+
+interface TCompactionPolicy {
+    /** uint64 */
+    InMemSizeToSnapshot?: string;
+    /** snapshot inmem state when size AND steps from last snapshot passed */
+    InMemStepsToSnapshot?: number;
+    InMemForceStepsToSnapshot?: number;
+    /** uint64 */
+    InMemForceSizeToSnapshot?: string;
+    /** @deprecated default 0 */
+    InMemCompactionBrokerQueue?: number;
+    /** uint64 default 67108864 */
+    ReadAheadHiThreshold?: string;
+    /** uint64 default 16777216 */
+    ReadAheadLoThreshold?: string;
+    /** default 7168 */
+    MinDataPageSize?: number;
+    /** @deprecated default 0*/
+    SnapBrokerQueue?: number;
+    /** @deprecated default 1*/
+    BackupBrokerQueue?: number;
+    /** default 5 */
+    DefaultTaskPriority?: number;
+    BackgroundSnapshotPolicy?: TBackgroundPolicy;
+    InMemResourceBrokerTask?: string;
+    SnapshotResourceBrokerTask?: string;
+    BackupResourceBrokerTask?: string;
+    /** uint64 */
+    LogOverheadSizeToSnapshot?: string;
+    LogOverheadCountToSnapshot?: number;
+    DroppedRowsPercentToCompact?: number;
+    /** default CompactionStrategyUnset */
+    CompactionStrategy?: ECompactionStrategy;
+    ShardPolicy?: TShardPolicy;
+    KeepEraseMarkers?: boolean;
+    Generation?: TGenerationPolicy[];
+}
+
+enum ECompactionStrategy {
+    CompactionStrategyUnset,
+    CompactionStrategyGenerational,
+    CompactionStrategySharded,
+}
+
+interface TShardPolicy {
+    /**
+     * Adjacent shards smaller than this will be merged
+     *
+     * default 33554432
+     *
+     * uint64
+     */
+    MinShardSize?: string;
+    /**
+     * Shards bigger than this will split in two or more pieces
+     *
+     * default 134217728
+     *
+     * uint64
+     */
+    MaxShardSize?: string;
+    /**
+     * Slices smaller than this will get prioritized compaction
+     *
+     * default 2097152
+     *
+     * uint64
+     */
+    MinSliceSize?: string;
+    /**
+     * Level will be compacted when there are more than this number of slices
+     *
+     * default 256
+     */
+    MaxSlicesPerLevel?: number;
+    /**
+     * Shard will be compacted when there are more than this number of levels
+     *
+     * default 16
+     */
+    MaxTotalLevels?: number;
+    /**
+     * Shard will avoid compacting less than this number of levels
+     *
+     * default 2
+     */
+    MinLevelsToCompact?: number;
+    /**
+     * Level will be compacted when it has X% of its data in upper levels
+     *
+     * default 100
+     */
+    NewDataPercentToCompact?: number;
+    /**
+     * Level will be compacted when it has X% of its rows in upper levels
+     *
+     * default 0
+     */
+    NewRowsPercentToCompact?: number;
+    /**
+     * Resource broker task type for compactions
+     *
+     * default 'compaction_gen1'
+     */
+    ResourceBrokerTask?: string;
+    /**
+     * Base priority for compaction tasks
+     *
+     * default 1000
+     */
+    TaskPriorityBase?: number;
+    /**
+     * Task priority will be increased for every N levels over the minimum
+     *
+     * default 1
+     */
+    TaskPriorityLevelsBoost?: number;
+    /**
+     * Task priority will be decreased for every N bytes of input
+     *
+     * default 4194304
+     *
+     * uint64
+     */
+    TaskPrioritySizePenalty?: string;
+    /**
+     * Part data may be reused, unless it would leave this much garbage
+     *
+     * default 20
+     */
+    MaxGarbagePercentToReuse?: number;
+    /**
+     * Minimum slice that that may be reused
+     *
+     * default 524288
+     *
+     * uint64
+     */
+    MinSliceSizeToReuse?: string;
+}
+
+interface TGenerationPolicy {
+    GenerationId?: number;
+    /** uint64 */
+    SizeToCompact?: string;
+    CountToCompact?: number;
+    ForceCountToCompact?: number;
+    /** uint64 */
+    ForceSizeToCompact?: string;
+    /** @deprecated */
+    CompactionBrokerQueue?: number;
+    KeepInCache?: boolean;
+    BackgroundCompactionPolicy?: TBackgroundPolicy;
+    ResourceBrokerTask?: string;
+    ExtraCompactionPercent?: number;
+    /** uint64 */
+    ExtraCompactionMinSize?: string;
+    ExtraCompactionExpPercent?: number;
+    /** uint64 */
+    ExtraCompactionExpMaxSize?: string;
+    /** uint64 */
+    UpliftPartSize?: string;
+}
+
+interface TBackgroundPolicy {
+    /**
+     * How much (in %) of forced compaction criteria should be met to submit background task.
+     *
+     * default 101 - no background compaction by default
+     */
+    Threshold?: number;
+    /**
+     * Base background compaction priority value (less priority means more important task).
+     * Value is used to compute real task priority basing on compaction criteria, time in queue etc.
+     *
+     * default 100
+     */
+    PriorityBase?: number;
+
+    /**
+     * Submitted background task may become more prioritized over time.
+     * New priority is computed as priority /= max(log(elapsed_seconds) * factor, 1);
+     *
+     * default 1.0
+     *
+     * double
+     */
+    TimeFactor?: number;
+
+    /** @deprecated default 5*/
+    TaskType?: number;
+    ResourceBrokerTask?: string;
 }
 
 export interface TFollowerGroup {
@@ -704,7 +1224,7 @@ enum EColumnCodec {
     ColumnCodecZSTD = 'ColumnCodecZSTD',
 }
 
-interface TColumnDataLifeCycle {
+export interface TColumnDataLifeCycle {
     Enabled?: TTtl;
     Disabled?: {};
     Tiering?: TStorageTiering;

package/dist/types/common.ts

@@ -0,0 +1 @@
+export type ValueOf<T extends Object> = T[keyof T];

package/dist/types/store/executeQuery.ts

@@ -0,0 +1,38 @@
+import {
+    SEND_QUERY,
+    changeUserInput,
+    saveQueryToHistory,
+    goToPreviousQuery,
+    setMonacoHotKey,
+    goToNextQuery,
+    MONACO_HOT_KEY_ACTIONS,
+} from '../../store/reducers/executeQuery';
+import type {ApiRequestAction} from '../../store/utils';
+import type {ErrorResponse} from '../api/query';
+import type {ValueOf} from '../common';
+import type {IQueryResult, QueryError} from './query';
+
+export type MonacoHotKeyAction = ValueOf<typeof MONACO_HOT_KEY_ACTIONS>;
+
+export interface ExecuteQueryState {
+    loading: boolean;
+    input: string;
+    history: {
+        queries: string[];
+        currentIndex: number;
+    };
+    monacoHotKey: null | MonacoHotKeyAction;
+    data?: IQueryResult;
+    stats?: IQueryResult['stats'];
+    error?: string | ErrorResponse;
+}
+
+type SendQueryAction = ApiRequestAction<typeof SEND_QUERY, IQueryResult, QueryError>;
+
+export type ExecuteQueryAction =
+    | SendQueryAction
+    | ReturnType<typeof goToNextQuery>
+    | ReturnType<typeof goToPreviousQuery>
+    | ReturnType<typeof changeUserInput>
+    | ReturnType<typeof saveQueryToHistory>
+    | ReturnType<typeof setMonacoHotKey>;

package/dist/types/store/explainQuery.ts

@@ -0,0 +1,38 @@
+import type {ExplainPlanNodeData, GraphNode, Link} from '@gravity-ui/paranoid';
+
+import {GET_EXPLAIN_QUERY, GET_EXPLAIN_QUERY_AST} from '../../store/reducers/explainQuery';
+import type {ApiRequestAction} from '../../store/utils';
+import type {PlanTable, ErrorResponse, ScanPlan, ScriptPlan} from '../api/query';
+import type {IQueryResult, QueryError} from './query';
+
+export interface PreparedExplainResponse {
+    plan?: {
+        links?: Link[];
+        nodes?: GraphNode<ExplainPlanNodeData>[];
+        tables?: PlanTable[];
+        version?: string;
+        pristine?: ScanPlan | ScriptPlan;
+    };
+    ast?: string;
+}
+
+export interface ExplainQueryState {
+    loading: boolean;
+    data?: PreparedExplainResponse['plan'];
+    dataAst?: PreparedExplainResponse['ast'];
+    error?: string | ErrorResponse;
+    errorAst?: string | ErrorResponse;
+}
+
+type GetExplainQueryAstAction = ApiRequestAction<
+    typeof GET_EXPLAIN_QUERY_AST,
+    IQueryResult,
+    QueryError
+>;
+type GetExplainQueryAction = ApiRequestAction<
+    typeof GET_EXPLAIN_QUERY,
+    PreparedExplainResponse,
+    QueryError
+>;
+
+export type ExplainQueryAction = GetExplainQueryAstAction | GetExplainQueryAction;

package/dist/types/store/olapStats.ts

@@ -0,0 +1,14 @@
+import {FETCH_OLAP_STATS, resetLoadingState} from '../../store/reducers/olapStats';
+import type {ApiRequestAction} from '../../store/utils';
+import type {IQueryResult} from './query';
+
+export interface OlapStatsState {
+    loading: boolean;
+    wasLoaded: boolean;
+    data?: IQueryResult;
+    error?: unknown;
+}
+
+export type OlapStatsAction =
+    | ApiRequestAction<typeof FETCH_OLAP_STATS, IQueryResult, unknown>
+    | ReturnType<typeof resetLoadingState>;

package/dist/types/store/query.ts

@@ -1,9 +1,29 @@
-import type {KeyValueRow, ColumnType} from '../api/query';
+import type {NetworkError} from '../api/error';
+import type {
+    KeyValueRow,
+    ColumnType,
+    ErrorResponse,
+    ScriptPlan,
+    ScanPlan,
+    TKqpStatsQuery,
+} from '../api/query';
 
 export interface IQueryResult {
     result?: KeyValueRow[];
     columns?: ColumnType[];
-    stats?: any;
-    plan?: any;
+    stats?: TKqpStatsQuery;
+    plan?: ScriptPlan | ScanPlan;
     ast?: string;
 }
+
+export interface QueryRequestParams {
+    database: string;
+    query: string;
+}
+
+export type QueryError = NetworkError | ErrorResponse;
+
+export enum QueryModes {
+    scan = 'scan',
+    script = 'script',
+}

package/dist/utils/constants.ts

@@ -94,6 +94,7 @@ export type IProblemFilterValues = typeof ALL | typeof PROBLEMS;
 export const THEME_KEY = 'theme';
 export const INVERTED_DISKS_KEY = 'invertedDisks';
 export const USE_NODES_ENDPOINT_IN_DIAGNOSTICS_KEY = 'useNodesEndpointInDiagnostics';
+export const ENABLE_QUERY_MODES_FOR_EXPLAIN = 'enableQueryModesForExplain';
 export const SAVED_QUERIES_KEY = 'saved_queries';
 export const ASIDE_HEADER_COMPACT_KEY = 'asideHeaderCompact';
 export const QUERIES_HISTORY_KEY = 'queries_history';
@@ -118,6 +119,6 @@ export const DEFAULT_TABLE_SETTINGS = {
 } as const;
 
 export const TENANT_INITIAL_TAB_KEY = 'saved_tenant_initial_tab';
-export const QUERY_INITIAL_RUN_ACTION_KEY = 'query_initial_run_action';
+export const QUERY_INITIAL_MODE_KEY = 'query_initial_mode';
 
 export const PARTITIONS_SELECTED_COLUMNS_KEY = 'partitionsSelectedColumns';