-
Notifications
You must be signed in to change notification settings - Fork 18
/
Copy pathtable.h
2270 lines (1730 loc) · 75.1 KB
/
table.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#pragma once
#include "fwd.h"
#include "table_enum.h"
#include <ydb-cpp-sdk/client/driver/driver.h>
#include <ydb-cpp-sdk/client/params/params.h>
#include <ydb-cpp-sdk/client/result/result.h>
#include <ydb-cpp-sdk/client/retry/retry.h>
#include <ydb-cpp-sdk/client/scheme/scheme.h>
#include <ydb-cpp-sdk/client/table/query_stats/stats.h>
#include <ydb-cpp-sdk/client/types/operation/operation.h>
#include <variant>
namespace Ydb {
namespace Table {
class StorageSettings;
class ColumnFamily;
class CreateTableRequest;
class Changefeed;
class ChangefeedDescription;
class DescribeExternalDataSourceResult;
class DescribeExternalTableResult;
class DescribeTableResult;
class ExplicitPartitions;
class GlobalIndexSettings;
class VectorIndexSettings;
class KMeansTreeSettings;
class PartitioningSettings;
class DateTypeColumnModeSettings;
class TtlSettings;
class TtlTier;
class TableIndex;
class TableIndexDescription;
class ValueSinceUnixEpochModeSettings;
class EvictionToExternalStorageSettings;
} // namespace Table
} // namespace Ydb
namespace NYdb::inline V3 {
namespace NRetry::Async {
template <typename TClient, typename TStatusType>
class TRetryContext;
} // namespace NRetry::Async
namespace NRetry::Sync {
template <typename TClient, typename TStatusType>
class TRetryContext;
} // namespace NRetry::Sync
namespace NScheme {
struct TPermissions;
} // namespace NScheme
namespace NTable {
////////////////////////////////////////////////////////////////////////////////
class TKeyBound {
public:
static TKeyBound Inclusive(const TValue& value) {
return TKeyBound(value, true);
}
static TKeyBound Exclusive(const TValue& value) {
return TKeyBound(value, false);
}
bool IsInclusive() const {
return Equal_;
}
const TValue& GetValue() const {
return Value_;
}
private:
TKeyBound(const TValue& value, bool equal = false)
: Value_(value)
, Equal_(equal)
{}
TValue Value_;
bool Equal_;
};
class TKeyRange {
public:
TKeyRange(const std::optional<TKeyBound>& from, const std::optional<TKeyBound>& to)
: From_(from)
, To_(to) {}
const std::optional<TKeyBound>& From() const {
return From_;
}
const std::optional<TKeyBound>& To() const {
return To_;
}
private:
std::optional<TKeyBound> From_;
std::optional<TKeyBound> To_;
};
struct TSequenceDescription {
struct TSetVal {
int64_t NextValue;
bool NextUsed;
};
std::optional<TSetVal> SetVal;
};
struct TTableColumn {
std::string Name;
TType Type;
std::string Family;
std::optional<bool> NotNull;
std::optional<TSequenceDescription> SequenceDescription;
TTableColumn() = default;
TTableColumn(std::string name,
TType type,
std::string family = std::string(),
std::optional<bool> notNull = std::nullopt,
std::optional<TSequenceDescription> sequenceDescription = std::nullopt)
: Name(std::move(name))
, Type(std::move(type))
, Family(std::move(family))
, NotNull(std::move(notNull))
, SequenceDescription(std::move(sequenceDescription))
{ }
// Conversion from TColumn for API compatibility
TTableColumn(const TColumn& column)
: Name(column.Name)
, Type(column.Type)
{ }
// Conversion from TColumn for API compatibility
TTableColumn(TColumn&& column)
: Name(std::move(column.Name))
, Type(std::move(column.Type))
{ }
// Conversion to TColumn for API compatibility
operator TColumn() const {
return TColumn(Name, Type);
}
};
struct TAlterTableColumn {
std::string Name;
std::string Family;
TAlterTableColumn() = default;
explicit TAlterTableColumn(std::string name)
: Name(std::move(name))
{ }
TAlterTableColumn(std::string name, std::string family)
: Name(std::move(name))
, Family(std::move(family))
{ }
};
////////////////////////////////////////////////////////////////////////////////
//! Represents table partitioning settings
class TPartitioningSettings {
public:
TPartitioningSettings();
explicit TPartitioningSettings(const Ydb::Table::PartitioningSettings& proto);
const Ydb::Table::PartitioningSettings& GetProto() const;
std::optional<bool> GetPartitioningBySize() const;
std::optional<bool> GetPartitioningByLoad() const;
uint64_t GetPartitionSizeMb() const;
uint64_t GetMinPartitionsCount() const;
uint64_t GetMaxPartitionsCount() const;
private:
class TImpl;
std::shared_ptr<TImpl> Impl_;
};
struct TExplicitPartitions {
using TSelf = TExplicitPartitions;
FLUENT_SETTING_VECTOR(TValue, SplitPoints);
static TExplicitPartitions FromProto(const Ydb::Table::ExplicitPartitions& proto);
void SerializeTo(Ydb::Table::ExplicitPartitions& proto) const;
};
struct TGlobalIndexSettings {
using TUniformOrExplicitPartitions = std::variant<std::monostate, uint64_t, TExplicitPartitions>;
TPartitioningSettings PartitioningSettings;
TUniformOrExplicitPartitions Partitions;
static TGlobalIndexSettings FromProto(const Ydb::Table::GlobalIndexSettings& proto);
void SerializeTo(Ydb::Table::GlobalIndexSettings& proto) const;
};
struct TVectorIndexSettings {
public:
enum class EMetric {
Unspecified = 0,
InnerProduct,
CosineSimilarity,
CosineDistance,
Manhattan,
Euclidean,
};
enum class EVectorType {
Unspecified = 0,
Float,
Uint8,
Int8,
Bit,
};
EMetric Metric = EMetric::Unspecified;
EVectorType VectorType = EVectorType::Unspecified;
uint32_t VectorDimension = 0;
static TVectorIndexSettings FromProto(const Ydb::Table::VectorIndexSettings& proto);
void SerializeTo(Ydb::Table::VectorIndexSettings& settings) const;
void Out(IOutputStream &o) const;
};
struct TKMeansTreeSettings {
public:
enum class EMetric {
Unspecified = 0,
InnerProduct,
CosineSimilarity,
CosineDistance,
Manhattan,
Euclidean,
};
enum class EVectorType {
Unspecified = 0,
Float,
Uint8,
Int8,
Bit,
};
TVectorIndexSettings Settings;
uint32_t Clusters = 0;
uint32_t Levels = 0;
static TKMeansTreeSettings FromProto(const Ydb::Table::KMeansTreeSettings& proto);
void SerializeTo(Ydb::Table::KMeansTreeSettings& settings) const;
void Out(IOutputStream &o) const;
};
//! Represents index description
class TIndexDescription {
friend class NYdb::TProtoAccessor;
public:
TIndexDescription(
const std::string& name,
EIndexType type,
const std::vector<std::string>& indexColumns,
const std::vector<std::string>& dataColumns = {},
const std::vector<TGlobalIndexSettings>& globalIndexSettings = {},
const std::variant<std::monostate, TKMeansTreeSettings>& specializedIndexSettings = {}
);
TIndexDescription(
const std::string& name,
const std::vector<std::string>& indexColumns,
const std::vector<std::string>& dataColumns = {},
const std::vector<TGlobalIndexSettings>& globalIndexSettings = {}
);
const std::string& GetIndexName() const;
EIndexType GetIndexType() const;
const std::vector<std::string>& GetIndexColumns() const;
const std::vector<std::string>& GetDataColumns() const;
const std::variant<std::monostate, TKMeansTreeSettings>& GetIndexSettings() const;
uint64_t GetSizeBytes() const;
void SerializeTo(Ydb::Table::TableIndex& proto) const;
std::string ToString() const;
void Out(IOutputStream& o) const;
private:
explicit TIndexDescription(const Ydb::Table::TableIndex& tableIndex);
explicit TIndexDescription(const Ydb::Table::TableIndexDescription& tableIndexDesc);
template <typename TProto>
static TIndexDescription FromProto(const TProto& proto);
private:
std::string IndexName_;
EIndexType IndexType_;
std::vector<std::string> IndexColumns_;
std::vector<std::string> DataColumns_;
std::vector<TGlobalIndexSettings> GlobalIndexSettings_;
std::variant<std::monostate, TKMeansTreeSettings> SpecializedIndexSettings_;
uint64_t SizeBytes_ = 0;
};
struct TRenameIndex {
std::string SourceName_;
std::string DestinationName_;
bool ReplaceDestination_ = false;
};
bool operator==(const TIndexDescription& lhs, const TIndexDescription& rhs);
bool operator!=(const TIndexDescription& lhs, const TIndexDescription& rhs);
class TBuildIndexOperation : public TOperation {
public:
using TOperation::TOperation;
TBuildIndexOperation(TStatus&& status, Ydb::Operations::Operation&& operation);
struct TMetadata {
EBuildIndexState State;
float Progress;
std::string Path;
std::optional<TIndexDescription> Desctiption;
};
const TMetadata& Metadata() const;
private:
TMetadata Metadata_;
};
////////////////////////////////////////////////////////////////////////////////
//! Represents changefeed description
class TChangefeedDescription {
friend class NYdb::TProtoAccessor;
public:
class TInitialScanProgress {
public:
TInitialScanProgress();
explicit TInitialScanProgress(uint32_t total, uint32_t completed);
TInitialScanProgress& operator+=(const TInitialScanProgress& other);
uint32_t GetPartsTotal() const;
uint32_t GetPartsCompleted() const;
float GetProgress() const; // percentage
private:
uint32_t PartsTotal;
uint32_t PartsCompleted;
};
public:
TChangefeedDescription(const std::string& name, EChangefeedMode mode, EChangefeedFormat format);
// Enable virtual timestamps
TChangefeedDescription& WithVirtualTimestamps();
// Enable resolved timestamps
TChangefeedDescription& WithResolvedTimestamps(const TDuration& interval);
// Customise retention period of underlying topic (24h by default).
TChangefeedDescription& WithRetentionPeriod(const TDuration& value);
// Initial scan will output the current state of the table first
TChangefeedDescription& WithInitialScan();
// Attributes
TChangefeedDescription& AddAttribute(const std::string& key, const std::string& value);
TChangefeedDescription& SetAttributes(const std::unordered_map<std::string, std::string>& attrs);
TChangefeedDescription& SetAttributes(std::unordered_map<std::string, std::string>&& attrs);
// Value that will be emitted in the `awsRegion` field of the record in DynamoDBStreamsJson format
TChangefeedDescription& WithAwsRegion(const std::string& value);
const std::string& GetName() const;
EChangefeedMode GetMode() const;
EChangefeedFormat GetFormat() const;
EChangefeedState GetState() const;
bool GetVirtualTimestamps() const;
const std::optional<TDuration>& GetResolvedTimestamps() const;
bool GetInitialScan() const;
const std::unordered_map<std::string, std::string>& GetAttributes() const;
const std::string& GetAwsRegion() const;
const std::optional<TInitialScanProgress>& GetInitialScanProgress() const;
void SerializeTo(Ydb::Table::Changefeed& proto) const;
void SerializeTo(Ydb::Table::ChangefeedDescription& proto) const;
std::string ToString() const;
void Out(IOutputStream& o) const;
template <typename TProto>
void SerializeCommonFields(TProto& proto) const;
private:
explicit TChangefeedDescription(const Ydb::Table::Changefeed& proto);
explicit TChangefeedDescription(const Ydb::Table::ChangefeedDescription& proto);
template <typename TProto>
static TChangefeedDescription FromProto(const TProto& proto);
private:
std::string Name_;
EChangefeedMode Mode_;
EChangefeedFormat Format_;
EChangefeedState State_ = EChangefeedState::Unknown;
bool VirtualTimestamps_ = false;
std::optional<TDuration> ResolvedTimestamps_;
std::optional<TDuration> RetentionPeriod_;
bool InitialScan_ = false;
std::unordered_map<std::string, std::string> Attributes_;
std::string AwsRegion_;
std::optional<TInitialScanProgress> InitialScanProgress_;
};
bool operator==(const TChangefeedDescription& lhs, const TChangefeedDescription& rhs);
bool operator!=(const TChangefeedDescription& lhs, const TChangefeedDescription& rhs);
////////////////////////////////////////////////////////////////////////////////
struct TPartitionStats {
uint64_t Rows = 0;
uint64_t Size = 0;
uint32_t LeaderNodeId = 0;
};
class TDateTypeColumnModeSettings {
public:
explicit TDateTypeColumnModeSettings(const std::string& columnName, const TDuration& applyAfter);
void SerializeTo(Ydb::Table::DateTypeColumnModeSettings& proto) const;
const std::string& GetColumnName() const;
const TDuration& GetExpireAfter() const;
private:
std::string ColumnName_;
TDuration ApplyAfter_;
};
class TValueSinceUnixEpochModeSettings {
public:
enum class EUnit {
Seconds,
MilliSeconds,
MicroSeconds,
NanoSeconds,
Unknown = std::numeric_limits<int>::max()
};
public:
explicit TValueSinceUnixEpochModeSettings(const std::string& columnName, EUnit columnUnit, const TDuration& applyAfter);
void SerializeTo(Ydb::Table::ValueSinceUnixEpochModeSettings& proto) const;
const std::string& GetColumnName() const;
EUnit GetColumnUnit() const;
const TDuration& GetExpireAfter() const;
static void Out(IOutputStream& o, EUnit unit);
static std::string ToString(EUnit unit);
static EUnit UnitFromString(const std::string& value);
private:
std::string ColumnName_;
EUnit ColumnUnit_;
TDuration ApplyAfter_;
};
class TTtlDeleteAction {};
class TTtlEvictToExternalStorageAction {
public:
TTtlEvictToExternalStorageAction(const std::string& storageName);
void SerializeTo(Ydb::Table::EvictionToExternalStorageSettings& proto) const;
std::string GetStorage() const;
private:
std::string Storage_;
};
class TTtlTierSettings {
public:
using TExpression = std::variant<
TDateTypeColumnModeSettings,
TValueSinceUnixEpochModeSettings
>;
using TAction = std::variant<
TTtlDeleteAction,
TTtlEvictToExternalStorageAction
>;
public:
explicit TTtlTierSettings(const TExpression& expression, const TAction& action);
static std::optional<TTtlTierSettings> FromProto(const Ydb::Table::TtlTier& tier);
void SerializeTo(Ydb::Table::TtlTier& proto) const;
const TExpression& GetExpression() const;
const TAction& GetAction() const;
private:
TExpression Expression_;
TAction Action_;
};
//! Represents ttl settings
class TTtlSettings {
private:
using TMode = std::variant<
TDateTypeColumnModeSettings,
TValueSinceUnixEpochModeSettings
>;
public:
using EUnit = TValueSinceUnixEpochModeSettings::EUnit;
enum class EMode {
DateTypeColumn = 0,
ValueSinceUnixEpoch = 1,
};
explicit TTtlSettings(const std::vector<TTtlTierSettings>& tiers);
explicit TTtlSettings(const std::string& columnName, const TDuration& expireAfter);
const TDateTypeColumnModeSettings& GetDateTypeColumn() const;
explicit TTtlSettings(const Ydb::Table::DateTypeColumnModeSettings& mode, uint32_t runIntervalSeconds);
explicit TTtlSettings(const std::string& columnName, EUnit columnUnit, const TDuration& expireAfter);
const TValueSinceUnixEpochModeSettings& GetValueSinceUnixEpoch() const;
explicit TTtlSettings(const Ydb::Table::ValueSinceUnixEpochModeSettings& mode, uint32_t runIntervalSeconds);
static std::optional<TTtlSettings> FromProto(const Ydb::Table::TtlSettings& proto);
void SerializeTo(Ydb::Table::TtlSettings& proto) const;
EMode GetMode() const;
TTtlSettings& SetRunInterval(const TDuration& value);
const TDuration& GetRunInterval() const;
const std::vector<TTtlTierSettings>& GetTiers() const;
private:
std::vector<TTtlTierSettings> Tiers_;
TDuration RunInterval_ = TDuration::Zero();
};
class TAlterTtlSettings {
using EUnit = TValueSinceUnixEpochModeSettings::EUnit;
TAlterTtlSettings()
: Action_(true)
{}
template <typename... Args>
explicit TAlterTtlSettings(Args&&... args)
: Action_(TTtlSettings(std::forward<Args>(args)...))
{}
public:
enum class EAction {
Drop = 0,
Set = 1,
};
static TAlterTtlSettings Drop() {
return TAlterTtlSettings();
}
template <typename... Args>
static TAlterTtlSettings Set(Args&&... args) {
return TAlterTtlSettings(std::forward<Args>(args)...);
}
EAction GetAction() const;
const TTtlSettings& GetTtlSettings() const;
private:
std::variant<
bool, // EAction::Drop
TTtlSettings // EAction::Set
> Action_;
};
//! Represents table storage settings
class TStorageSettings {
public:
TStorageSettings();
explicit TStorageSettings(const Ydb::Table::StorageSettings& proto);
const Ydb::Table::StorageSettings& GetProto() const;
std::optional<std::string> GetTabletCommitLog0() const;
std::optional<std::string> GetTabletCommitLog1() const;
std::optional<std::string> GetExternal() const;
std::optional<bool> GetStoreExternalBlobs() const;
private:
class TImpl;
std::shared_ptr<TImpl> Impl_;
};
//! Represents column family description
class TColumnFamilyDescription {
public:
explicit TColumnFamilyDescription(const Ydb::Table::ColumnFamily& desc);
const Ydb::Table::ColumnFamily& GetProto() const;
const std::string& GetName() const;
std::optional<std::string> GetData() const;
std::optional<EColumnFamilyCompression> GetCompression() const;
std::optional<bool> GetKeepInMemory() const;
private:
class TImpl;
std::shared_ptr<TImpl> Impl_;
};
//! Represents table read replicas settings
class TReadReplicasSettings {
public:
enum class EMode {
PerAz = 0,
AnyAz = 1
};
TReadReplicasSettings(EMode mode, uint64_t readReplicasCount);
EMode GetMode() const;
uint64_t GetReadReplicasCount() const;
private:
EMode Mode_;
uint64_t ReadReplicasCount_;
};
enum class EStoreType {
Row = 0,
Column = 1
};
//! Represents table description
class TTableDescription {
friend class TTableBuilder;
friend class NYdb::TProtoAccessor;
using EUnit = TValueSinceUnixEpochModeSettings::EUnit;
public:
TTableDescription(Ydb::Table::DescribeTableResult&& desc, const TDescribeTableSettings& describeSettings);
const std::vector<std::string>& GetPrimaryKeyColumns() const;
// DEPRECATED: use GetTableColumns()
std::vector<TColumn> GetColumns() const;
std::vector<TTableColumn> GetTableColumns() const;
std::vector<TIndexDescription> GetIndexDescriptions() const;
std::vector<TChangefeedDescription> GetChangefeedDescriptions() const;
std::optional<TTtlSettings> GetTtlSettings() const;
// Deprecated. Use GetTtlSettings() instead
std::optional<std::string> GetTiering() const;
EStoreType GetStoreType() const;
// Deprecated. Use GetEntry() of TDescribeTableResult instead
const std::string& GetOwner() const;
const std::vector<NScheme::TPermissions>& GetPermissions() const;
const std::vector<NScheme::TPermissions>& GetEffectivePermissions() const;
const std::vector<TKeyRange>& GetKeyRanges() const;
// Folow options related to table statistics
// flag WithTableStatistics must be set
// Number of partition
uint64_t GetPartitionsCount() const;
// Approximate number of rows
uint64_t GetTableRows() const;
// Approximate size of table (bytes)
uint64_t GetTableSize() const;
// Timestamp of last modification
TInstant GetModificationTime() const;
// Timestamp of table creation
TInstant GetCreationTime() const;
// Returns partition statistics for table
// flag WithTableStatistics and WithPartitionStatistics must be set
const std::vector<TPartitionStats>& GetPartitionStats() const;
// Returns storage settings of the table
const TStorageSettings& GetStorageSettings() const;
// Returns column families of the table
const std::vector<TColumnFamilyDescription>& GetColumnFamilies() const;
// Attributes
const std::unordered_map<std::string, std::string>& GetAttributes() const;
// Returns partitioning settings of the table
const TPartitioningSettings& GetPartitioningSettings() const;
// Bloom filter by key
std::optional<bool> GetKeyBloomFilter() const;
// Returns read replicas settings of the table
std::optional<TReadReplicasSettings> GetReadReplicasSettings() const;
// Fills CreateTableRequest proto from this description
void SerializeTo(Ydb::Table::CreateTableRequest& request) const;
private:
TTableDescription();
explicit TTableDescription(const Ydb::Table::CreateTableRequest& request);
void AddColumn(const std::string& name, const Ydb::Type& type, const std::string& family, std::optional<bool> notNull, std::optional<TSequenceDescription> sequenceDescription);
void SetPrimaryKeyColumns(const std::vector<std::string>& primaryKeyColumns);
// common
void AddSecondaryIndex(const std::string& indexName, EIndexType type, const std::vector<std::string>& indexColumns);
void AddSecondaryIndex(const std::string& indexName, EIndexType type, const std::vector<std::string>& indexColumns, const std::vector<std::string>& dataColumns);
void AddSecondaryIndex(const TIndexDescription& indexDescription);
// sync
void AddSyncSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns);
void AddSyncSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns, const std::vector<std::string>& dataColumns);
// async
void AddAsyncSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns);
void AddAsyncSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns, const std::vector<std::string>& dataColumns);
// unique
void AddUniqueSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns);
void AddUniqueSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns, const std::vector<std::string>& dataColumns);
// vector KMeansTree
void AddVectorKMeansTreeIndex(const std::string& indexName, const std::vector<std::string>& indexColumns, const TKMeansTreeSettings& indexSettings);
void AddVectorKMeansTreeIndex(const std::string& indexName, const std::vector<std::string>& indexColumns, const std::vector<std::string>& dataColumns, const TKMeansTreeSettings& indexSettings);
// default
void AddSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns);
void AddSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns, const std::vector<std::string>& dataColumns);
void SetTtlSettings(TTtlSettings&& settings);
void SetTtlSettings(const TTtlSettings& settings);
void SetStorageSettings(const TStorageSettings& settings);
void AddColumnFamily(const TColumnFamilyDescription& desc);
void AddAttribute(const std::string& key, const std::string& value);
void SetAttributes(const std::unordered_map<std::string, std::string>& attrs);
void SetAttributes(std::unordered_map<std::string, std::string>&& attrs);
void SetCompactionPolicy(const std::string& name);
void SetUniformPartitions(uint64_t partitionsCount);
void SetPartitionAtKeys(const TExplicitPartitions& keys);
void SetPartitioningSettings(const TPartitioningSettings& settings);
void SetKeyBloomFilter(bool enabled);
void SetReadReplicasSettings(TReadReplicasSettings::EMode mode, uint64_t readReplicasCount);
void SetStoreType(EStoreType type);
const Ydb::Table::DescribeTableResult& GetProto() const;
class TImpl;
std::shared_ptr<TImpl> Impl_;
};
////////////////////////////////////////////////////////////////////////////////
class TStorageSettingsBuilder {
public:
TStorageSettingsBuilder();
~TStorageSettingsBuilder();
TStorageSettingsBuilder& SetTabletCommitLog0(const std::string& media);
TStorageSettingsBuilder& SetTabletCommitLog1(const std::string& media);
TStorageSettingsBuilder& SetExternal(const std::string& media);
TStorageSettingsBuilder& SetStoreExternalBlobs(bool enabled);
TStorageSettings Build() const;
private:
class TImpl;
std::unique_ptr<TImpl> Impl_;
};
////////////////////////////////////////////////////////////////////////////////
class TPartitioningSettingsBuilder {
public:
TPartitioningSettingsBuilder();
~TPartitioningSettingsBuilder();
TPartitioningSettingsBuilder& SetPartitioningBySize(bool enabled);
TPartitioningSettingsBuilder& SetPartitioningByLoad(bool enabled);
TPartitioningSettingsBuilder& SetPartitionSizeMb(uint64_t sizeMb);
TPartitioningSettingsBuilder& SetMinPartitionsCount(uint64_t count);
TPartitioningSettingsBuilder& SetMaxPartitionsCount(uint64_t count);
TPartitioningSettings Build() const;
private:
class TImpl;
std::unique_ptr<TImpl> Impl_;
};
////////////////////////////////////////////////////////////////////////////////
class TColumnFamilyBuilder {
public:
explicit TColumnFamilyBuilder(const std::string& name);
~TColumnFamilyBuilder();
TColumnFamilyBuilder& SetData(const std::string& media);
TColumnFamilyBuilder& SetCompression(EColumnFamilyCompression compression);
TColumnFamilyBuilder& SetKeepInMemory(bool enabled);
TColumnFamilyDescription Build() const;
private:
class TImpl;
std::unique_ptr<TImpl> Impl_;
};
////////////////////////////////////////////////////////////////////////////////
class TTableStorageSettingsBuilder {
public:
explicit TTableStorageSettingsBuilder(TTableBuilder& parent)
: Parent_(parent)
{ }
TTableStorageSettingsBuilder& SetTabletCommitLog0(const std::string& media) {
Builder_.SetTabletCommitLog0(media);
return *this;
}
TTableStorageSettingsBuilder& SetTabletCommitLog1(const std::string& media) {
Builder_.SetTabletCommitLog1(media);
return *this;
}
TTableStorageSettingsBuilder& SetExternal(const std::string& media) {
Builder_.SetExternal(media);
return *this;
}
TTableStorageSettingsBuilder& SetStoreExternalBlobs(bool enabled) {
Builder_.SetStoreExternalBlobs(enabled);
return *this;
}
TTableBuilder& EndStorageSettings();
private:
TTableBuilder& Parent_;
TStorageSettingsBuilder Builder_;
};
class TTableColumnFamilyBuilder {
public:
TTableColumnFamilyBuilder(TTableBuilder& parent, const std::string& name)
: Parent_(parent)
, Builder_(name)
{ }
TTableColumnFamilyBuilder& SetData(const std::string& media) {
Builder_.SetData(media);
return *this;
}
TTableColumnFamilyBuilder& SetCompression(EColumnFamilyCompression compression) {
Builder_.SetCompression(compression);
return *this;
}
TTableColumnFamilyBuilder& SetKeepInMemory(bool enabled) {
Builder_.SetKeepInMemory(enabled);
return *this;
}
TTableBuilder& EndColumnFamily();
private:
TTableBuilder& Parent_;
TColumnFamilyBuilder Builder_;
};
class TTablePartitioningSettingsBuilder {
public:
explicit TTablePartitioningSettingsBuilder(TTableBuilder& parent)
: Parent_(parent)
{ }
TTablePartitioningSettingsBuilder& SetPartitioningBySize(bool enabled) {
Builder_.SetPartitioningBySize(enabled);
return *this;
}
TTablePartitioningSettingsBuilder& SetPartitioningByLoad(bool enabled) {
Builder_.SetPartitioningByLoad(enabled);
return *this;
}
TTablePartitioningSettingsBuilder& SetPartitionSizeMb(uint64_t sizeMb) {
Builder_.SetPartitionSizeMb(sizeMb);
return *this;
}
TTablePartitioningSettingsBuilder& SetMinPartitionsCount(uint64_t count) {
Builder_.SetMinPartitionsCount(count);
return *this;
}
TTablePartitioningSettingsBuilder& SetMaxPartitionsCount(uint64_t count) {
Builder_.SetMaxPartitionsCount(count);
return *this;
}
TTableBuilder& EndPartitioningSettings();
private:
TTableBuilder& Parent_;
TPartitioningSettingsBuilder Builder_;
};
////////////////////////////////////////////////////////////////////////////////
class TTableBuilder {
using EUnit = TValueSinceUnixEpochModeSettings::EUnit;
public:
TTableBuilder() = default;
TTableBuilder& SetStoreType(EStoreType type);
TTableBuilder& AddNullableColumn(const std::string& name, const EPrimitiveType& type, const std::string& family = std::string());
TTableBuilder& AddNullableColumn(const std::string& name, const TDecimalType& type, const std::string& family = std::string());
TTableBuilder& AddNullableColumn(const std::string& name, const TPgType& type, const std::string& family = std::string());
TTableBuilder& AddNonNullableColumn(const std::string& name, const EPrimitiveType& type, const std::string& family = std::string());
TTableBuilder& AddNonNullableColumn(const std::string& name, const TDecimalType& type, const std::string& family = std::string());
TTableBuilder& AddNonNullableColumn(const std::string& name, const TPgType& type, const std::string& family = std::string());
TTableBuilder& SetPrimaryKeyColumns(const std::vector<std::string>& primaryKeyColumns);
TTableBuilder& SetPrimaryKeyColumn(const std::string& primaryKeyColumn);
TTableBuilder& AddSerialColumn(const std::string& name, const EPrimitiveType& type, TSequenceDescription sequenceDescription, const std::string& family = std::string());
// common
TTableBuilder& AddSecondaryIndex(const TIndexDescription& indexDescription);
TTableBuilder& AddSecondaryIndex(const std::string& indexName, EIndexType type, const std::vector<std::string>& indexColumns, const std::vector<std::string>& dataColumns);
TTableBuilder& AddSecondaryIndex(const std::string& indexName, EIndexType type, const std::vector<std::string>& indexColumns);
TTableBuilder& AddSecondaryIndex(const std::string& indexName, EIndexType type, const std::string& indexColumn);
// sync
TTableBuilder& AddSyncSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns, const std::vector<std::string>& dataColumns);
TTableBuilder& AddSyncSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns);
TTableBuilder& AddSyncSecondaryIndex(const std::string& indexName, const std::string& indexColumn);
// async
TTableBuilder& AddAsyncSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns, const std::vector<std::string>& dataColumns);
TTableBuilder& AddAsyncSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns);
TTableBuilder& AddAsyncSecondaryIndex(const std::string& indexName, const std::string& indexColumn);
// unique
TTableBuilder& AddUniqueSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns);
TTableBuilder& AddUniqueSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns, const std::vector<std::string>& dataColumns);
// vector KMeansTree
TTableBuilder& AddVectorKMeansTreeIndex(const std::string& indexName, const std::vector<std::string>& indexColumns, const TKMeansTreeSettings& indexSettings);
TTableBuilder& AddVectorKMeansTreeIndex(const std::string& indexName, const std::vector<std::string>& indexColumns, const std::vector<std::string>& dataColumns, const TKMeansTreeSettings& indexSettings);
// default
TTableBuilder& AddSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns, const std::vector<std::string>& dataColumns);
TTableBuilder& AddSecondaryIndex(const std::string& indexName, const std::vector<std::string>& indexColumns);
TTableBuilder& AddSecondaryIndex(const std::string& indexName, const std::string& indexColumn);
TTableBuilder& SetTtlSettings(TTtlSettings&& settings);
TTableBuilder& SetTtlSettings(const TTtlSettings& settings);
TTableBuilder& SetTtlSettings(const std::string& columnName, const TDuration& expireAfter = TDuration::Zero());
TTableBuilder& SetTtlSettings(const std::string& columnName, EUnit columnUnit, const TDuration& expireAfter = TDuration::Zero());
TTableBuilder& SetStorageSettings(const TStorageSettings& settings);
TTableBuilder& AddColumnFamily(const TColumnFamilyDescription& desc);
TTableBuilder& AddAttribute(const std::string& key, const std::string& value);
TTableBuilder& SetAttributes(const std::unordered_map<std::string, std::string>& attrs);
TTableBuilder& SetAttributes(std::unordered_map<std::string, std::string>&& attrs);
TTableBuilder& SetCompactionPolicy(const std::string& name);
// UniformPartitions and PartitionAtKeys are mutually exclusive
TTableBuilder& SetUniformPartitions(uint64_t partitionsCount);
TTableBuilder& SetPartitionAtKeys(const TExplicitPartitions& keys);
TTableBuilder& SetPartitioningSettings(const TPartitioningSettings& settings);
TTableBuilder& SetKeyBloomFilter(bool enabled);