-
Notifications
You must be signed in to change notification settings - Fork 73
/
options.go
1186 lines (961 loc) · 32 KB
/
options.go
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
package options
import (
"github.com/ydb-platform/ydb-go-genproto/protos/Ydb"
"github.com/ydb-platform/ydb-go-genproto/protos/Ydb_Table"
"google.golang.org/grpc"
"github.com/ydb-platform/ydb-go-sdk/v3/internal/allocator"
"github.com/ydb-platform/ydb-go-sdk/v3/internal/types"
"github.com/ydb-platform/ydb-go-sdk/v3/internal/value"
)
func WithShardKeyBounds() DescribeTableOption {
return func(d *DescribeTableDesc) {
d.IncludeShardKeyBounds = true
}
}
func WithTableStats() DescribeTableOption {
return func(d *DescribeTableDesc) {
d.IncludeTableStats = true
}
}
func WithPartitionStats() DescribeTableOption {
return func(d *DescribeTableDesc) {
d.IncludePartitionStats = true
}
}
type (
CreateTableDesc Ydb_Table.CreateTableRequest
CreateTableOption interface {
ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator)
}
)
type (
profile Ydb_Table.TableProfile
ProfileOption interface {
ApplyProfileOption(p *profile, a *allocator.Allocator)
}
)
type (
storagePolicy Ydb_Table.StoragePolicy
compactionPolicy Ydb_Table.CompactionPolicy
partitioningPolicy Ydb_Table.PartitioningPolicy
executionPolicy Ydb_Table.ExecutionPolicy
replicationPolicy Ydb_Table.ReplicationPolicy
cachingPolicy Ydb_Table.CachingPolicy
)
type column struct {
name string
typ types.Type
}
func (c column) ApplyAlterTableOption(d *AlterTableDesc, a *allocator.Allocator) {
d.AddColumns = append(d.AddColumns, &Ydb_Table.ColumnMeta{
Name: c.name,
Type: types.TypeToYDB(c.typ, a),
})
}
func (c column) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
d.Columns = append(d.Columns, &Ydb_Table.ColumnMeta{
Name: c.name,
Type: types.TypeToYDB(c.typ, a),
})
}
func WithColumn(name string, typ types.Type) CreateTableOption {
return column{
name: name,
typ: typ,
}
}
type columnMeta Column
func (c columnMeta) ApplyAlterTableOption(d *AlterTableDesc, a *allocator.Allocator) {
d.AddColumns = append(d.AddColumns, Column(c).toYDB(a))
}
func (c columnMeta) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
d.Columns = append(d.Columns, Column(c).toYDB(a))
}
func WithColumnMeta(column Column) CreateTableOption {
return columnMeta(column)
}
type primaryKeyColumn []string
func (columns primaryKeyColumn) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
d.PrimaryKey = append(d.PrimaryKey, columns...)
}
func WithPrimaryKeyColumn(columns ...string) CreateTableOption {
return primaryKeyColumn(columns)
}
type timeToLiveSettings TimeToLiveSettings
func (settings timeToLiveSettings) ApplyAlterTableOption(d *AlterTableDesc, a *allocator.Allocator) {
d.TtlAction = &Ydb_Table.AlterTableRequest_SetTtlSettings{
SetTtlSettings: (*TimeToLiveSettings)(&settings).ToYDB(),
}
}
func (settings timeToLiveSettings) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
d.TtlSettings = (*TimeToLiveSettings)(&settings).ToYDB()
}
// WithTimeToLiveSettings defines TTL settings in CreateTable request
func WithTimeToLiveSettings(settings TimeToLiveSettings) CreateTableOption {
return timeToLiveSettings(settings)
}
type attribute struct {
key string
value string
}
func (a attribute) ApplyAlterTableOption(d *AlterTableDesc, _ *allocator.Allocator) {
if d.AlterAttributes == nil {
d.AlterAttributes = make(map[string]string)
}
d.AlterAttributes[a.key] = a.value
}
func (a attribute) ApplyCreateTableOption(d *CreateTableDesc, _ *allocator.Allocator) {
if d.Attributes == nil {
d.Attributes = make(map[string]string)
}
d.Attributes[a.key] = a.value
}
func WithAttribute(key, value string) CreateTableOption {
return attribute{
key: key,
value: value,
}
}
type (
indexDesc Ydb_Table.TableIndex
IndexOption interface {
ApplyIndexOption(d *indexDesc)
}
)
type index struct {
name string
opts []IndexOption
}
func (i index) ApplyAlterTableOption(d *AlterTableDesc, a *allocator.Allocator) {
x := &Ydb_Table.TableIndex{
Name: i.name,
}
for _, opt := range i.opts {
if opt != nil {
opt.ApplyIndexOption((*indexDesc)(x))
}
}
d.AddIndexes = append(d.AddIndexes, x)
}
func (i index) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
x := &Ydb_Table.TableIndex{
Name: i.name,
}
for _, opt := range i.opts {
if opt != nil {
opt.ApplyIndexOption((*indexDesc)(x))
}
}
d.Indexes = append(d.Indexes, x)
}
func WithIndex(name string, opts ...IndexOption) CreateTableOption {
return index{
name: name,
opts: opts,
}
}
func WithAddIndex(name string, opts ...IndexOption) AlterTableOption {
return index{
name: name,
opts: opts,
}
}
type dropIndex string
func (i dropIndex) ApplyAlterTableOption(d *AlterTableDesc, a *allocator.Allocator) {
d.DropIndexes = append(d.DropIndexes, string(i))
}
func WithDropIndex(name string) AlterTableOption {
return dropIndex(name)
}
type indexColumns []string
func (columns indexColumns) ApplyIndexOption(d *indexDesc) {
d.IndexColumns = append(d.IndexColumns, columns...)
}
func WithIndexColumns(columns ...string) IndexOption {
return indexColumns(columns)
}
type dataColumns []string
func (columns dataColumns) ApplyIndexOption(d *indexDesc) {
d.DataColumns = append(d.DataColumns, columns...)
}
func WithDataColumns(columns ...string) IndexOption {
return dataColumns(columns)
}
func WithIndexType(t IndexType) IndexOption {
return t
}
type columnFamilies []ColumnFamily
func (cf columnFamilies) ApplyAlterTableOption(d *AlterTableDesc, a *allocator.Allocator) {
d.AddColumnFamilies = make([]*Ydb_Table.ColumnFamily, len(cf))
for i := range cf {
d.AddColumnFamilies[i] = cf[i].toYDB()
}
}
func (cf columnFamilies) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
d.ColumnFamilies = make([]*Ydb_Table.ColumnFamily, len(cf))
for i := range cf {
d.ColumnFamilies[i] = cf[i].toYDB()
}
}
func WithColumnFamilies(cf ...ColumnFamily) CreateTableOption {
return columnFamilies(cf)
}
type readReplicasSettings ReadReplicasSettings
func (rr readReplicasSettings) ApplyAlterTableOption(d *AlterTableDesc, a *allocator.Allocator) {
d.SetReadReplicasSettings = ReadReplicasSettings(rr).ToYDB()
}
func (rr readReplicasSettings) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
d.ReadReplicasSettings = ReadReplicasSettings(rr).ToYDB()
}
func WithReadReplicasSettings(rr ReadReplicasSettings) CreateTableOption {
return readReplicasSettings(rr)
}
type storageSettings StorageSettings
func (ss storageSettings) ApplyAlterTableOption(d *AlterTableDesc, a *allocator.Allocator) {
d.AlterStorageSettings = StorageSettings(ss).ToYDB()
}
func (ss storageSettings) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
d.StorageSettings = StorageSettings(ss).ToYDB()
}
func WithStorageSettings(ss StorageSettings) CreateTableOption {
return storageSettings(ss)
}
type keyBloomFilter FeatureFlag
func (f keyBloomFilter) ApplyAlterTableOption(d *AlterTableDesc, a *allocator.Allocator) {
d.SetKeyBloomFilter = FeatureFlag(f).ToYDB()
}
func (f keyBloomFilter) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
d.KeyBloomFilter = FeatureFlag(f).ToYDB()
}
func WithKeyBloomFilter(f FeatureFlag) CreateTableOption {
return keyBloomFilter(f)
}
func WithPartitions(p Partitions) CreateTableOption {
return p
}
type uniformPartitions uint64
func (u uniformPartitions) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
d.Partitions = &Ydb_Table.CreateTableRequest_UniformPartitions{
UniformPartitions: uint64(u),
}
}
func (u uniformPartitions) isPartitions() {}
func WithUniformPartitions(n uint64) Partitions {
return uniformPartitions(n)
}
type explicitPartitions []value.Value
func (e explicitPartitions) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
values := make([]*Ydb.TypedValue, len(e))
for i := range values {
values[i] = value.ToYDB(e[i], a)
}
d.Partitions = &Ydb_Table.CreateTableRequest_PartitionAtKeys{
PartitionAtKeys: &Ydb_Table.ExplicitPartitions{
SplitPoints: values,
},
}
}
func (e explicitPartitions) isPartitions() {}
func WithExplicitPartitions(splitPoints ...value.Value) Partitions {
return explicitPartitions(splitPoints)
}
type profileOption []ProfileOption
func (opts profileOption) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
if d.Profile == nil {
d.Profile = new(Ydb_Table.TableProfile)
}
for _, opt := range opts {
if opt != nil {
opt.ApplyProfileOption((*profile)(d.Profile), a)
}
}
}
func WithProfile(opts ...ProfileOption) CreateTableOption {
return profileOption(opts)
}
type profilePresetProfileOption string
func (preset profilePresetProfileOption) ApplyProfileOption(p *profile, a *allocator.Allocator) {
p.PresetName = string(preset)
}
func WithProfilePreset(name string) ProfileOption {
return profilePresetProfileOption(name)
}
type storagePolicyProfileOption []StoragePolicyOption
func (opts storagePolicyProfileOption) ApplyProfileOption(p *profile, a *allocator.Allocator) {
if p.StoragePolicy == nil {
p.StoragePolicy = new(Ydb_Table.StoragePolicy)
}
for _, opt := range opts {
if opt != nil {
opt((*storagePolicy)(p.StoragePolicy))
}
}
}
func WithStoragePolicy(opts ...StoragePolicyOption) ProfileOption {
return storagePolicyProfileOption(opts)
}
type compactionPolicyProfileOption []CompactionPolicyOption
func (opts compactionPolicyProfileOption) ApplyProfileOption(p *profile, a *allocator.Allocator) {
if p.CompactionPolicy == nil {
p.CompactionPolicy = new(Ydb_Table.CompactionPolicy)
}
for _, opt := range opts {
if opt != nil {
opt((*compactionPolicy)(p.CompactionPolicy))
}
}
}
func WithCompactionPolicy(opts ...CompactionPolicyOption) ProfileOption {
return compactionPolicyProfileOption(opts)
}
type partitioningPolicyProfileOption []PartitioningPolicyOption
func (opts partitioningPolicyProfileOption) ApplyProfileOption(p *profile, a *allocator.Allocator) {
if p.PartitioningPolicy == nil {
p.PartitioningPolicy = new(Ydb_Table.PartitioningPolicy)
}
for _, opt := range opts {
if opt != nil {
opt((*partitioningPolicy)(p.PartitioningPolicy), a)
}
}
}
func WithPartitioningPolicy(opts ...PartitioningPolicyOption) ProfileOption {
return partitioningPolicyProfileOption(opts)
}
type executionPolicyProfileOption []ExecutionPolicyOption
func (opts executionPolicyProfileOption) ApplyProfileOption(p *profile, a *allocator.Allocator) {
if p.ExecutionPolicy == nil {
p.ExecutionPolicy = new(Ydb_Table.ExecutionPolicy)
}
for _, opt := range opts {
if opt != nil {
opt((*executionPolicy)(p.ExecutionPolicy))
}
}
}
func WithExecutionPolicy(opts ...ExecutionPolicyOption) ProfileOption {
return executionPolicyProfileOption(opts)
}
type replicationPolicyProfileOption []ReplicationPolicyOption
func (opts replicationPolicyProfileOption) ApplyProfileOption(p *profile, a *allocator.Allocator) {
if p.ReplicationPolicy == nil {
p.ReplicationPolicy = new(Ydb_Table.ReplicationPolicy)
}
for _, opt := range opts {
if opt != nil {
opt((*replicationPolicy)(p.ReplicationPolicy))
}
}
}
func WithReplicationPolicy(opts ...ReplicationPolicyOption) ProfileOption {
return replicationPolicyProfileOption(opts)
}
type cachingPolicyProfileOption []CachingPolicyOption
func (opts cachingPolicyProfileOption) ApplyProfileOption(p *profile, a *allocator.Allocator) {
if p.CachingPolicy == nil {
p.CachingPolicy = new(Ydb_Table.CachingPolicy)
}
for _, opt := range opts {
if opt != nil {
opt((*cachingPolicy)(p.CachingPolicy))
}
}
}
func WithCachingPolicy(opts ...CachingPolicyOption) ProfileOption {
return cachingPolicyProfileOption(opts)
}
type (
StoragePolicyOption func(*storagePolicy)
CompactionPolicyOption func(*compactionPolicy)
PartitioningPolicyOption func(*partitioningPolicy, *allocator.Allocator)
ExecutionPolicyOption func(*executionPolicy)
ReplicationPolicyOption func(*replicationPolicy)
CachingPolicyOption func(*cachingPolicy)
)
func WithStoragePolicyPreset(name string) StoragePolicyOption {
return func(s *storagePolicy) {
s.PresetName = name
}
}
func WithStoragePolicySyslog(kind string) StoragePolicyOption {
return func(s *storagePolicy) {
s.Syslog = &Ydb_Table.StoragePool{Media: kind}
}
}
func WithStoragePolicyLog(kind string) StoragePolicyOption {
return func(s *storagePolicy) {
s.Log = &Ydb_Table.StoragePool{Media: kind}
}
}
func WithStoragePolicyData(kind string) StoragePolicyOption {
return func(s *storagePolicy) {
s.Data = &Ydb_Table.StoragePool{Media: kind}
}
}
func WithStoragePolicyExternal(kind string) StoragePolicyOption {
return func(s *storagePolicy) {
s.External = &Ydb_Table.StoragePool{Media: kind}
}
}
func WithStoragePolicyKeepInMemory(flag FeatureFlag) StoragePolicyOption {
return func(s *storagePolicy) {
s.KeepInMemory = flag.ToYDB()
}
}
func WithCompactionPolicyPreset(name string) CompactionPolicyOption {
return func(c *compactionPolicy) { c.PresetName = name }
}
func WithPartitioningPolicyPreset(name string) PartitioningPolicyOption {
return func(p *partitioningPolicy, a *allocator.Allocator) {
p.PresetName = name
}
}
func WithPartitioningPolicyMode(mode PartitioningMode) PartitioningPolicyOption {
return func(p *partitioningPolicy, a *allocator.Allocator) {
p.AutoPartitioning = mode.toYDB()
}
}
// Deprecated: use WithUniformPartitions instead.
// Will be removed after Oct 2024.
// Read about versioning policy: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
func WithPartitioningPolicyUniformPartitions(n uint64) PartitioningPolicyOption {
return func(p *partitioningPolicy, a *allocator.Allocator) {
p.Partitions = &Ydb_Table.PartitioningPolicy_UniformPartitions{
UniformPartitions: n,
}
}
}
// Deprecated: use WithExplicitPartitions instead.
// Will be removed after Oct 2024.
// Read about versioning policy: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
func WithPartitioningPolicyExplicitPartitions(splitPoints ...value.Value) PartitioningPolicyOption {
return func(p *partitioningPolicy, a *allocator.Allocator) {
values := make([]*Ydb.TypedValue, len(splitPoints))
for i := range values {
values[i] = value.ToYDB(splitPoints[i], a)
}
p.Partitions = &Ydb_Table.PartitioningPolicy_ExplicitPartitions{
ExplicitPartitions: &Ydb_Table.ExplicitPartitions{
SplitPoints: values,
},
}
}
}
func WithReplicationPolicyPreset(name string) ReplicationPolicyOption {
return func(e *replicationPolicy) {
e.PresetName = name
}
}
func WithReplicationPolicyReplicasCount(n uint32) ReplicationPolicyOption {
return func(e *replicationPolicy) {
e.ReplicasCount = n
}
}
func WithReplicationPolicyCreatePerAZ(flag FeatureFlag) ReplicationPolicyOption {
return func(e *replicationPolicy) {
e.CreatePerAvailabilityZone = flag.ToYDB()
}
}
func WithReplicationPolicyAllowPromotion(flag FeatureFlag) ReplicationPolicyOption {
return func(e *replicationPolicy) {
e.AllowPromotion = flag.ToYDB()
}
}
func WithExecutionPolicyPreset(name string) ExecutionPolicyOption {
return func(e *executionPolicy) {
e.PresetName = name
}
}
func WithCachingPolicyPreset(name string) CachingPolicyOption {
return func(e *cachingPolicy) {
e.PresetName = name
}
}
type partitioningSettingsObject PartitioningSettings
func (ps partitioningSettingsObject) ApplyAlterTableOption(d *AlterTableDesc, a *allocator.Allocator) {
d.AlterPartitioningSettings = PartitioningSettings(ps).toYDB()
}
func (ps partitioningSettingsObject) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
d.PartitioningSettings = PartitioningSettings(ps).toYDB()
}
func WithPartitioningSettingsObject(ps PartitioningSettings) CreateTableOption {
return partitioningSettingsObject(ps)
}
type partitioningSettings []PartitioningSettingsOption
func (opts partitioningSettings) ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator) {
settings := &ydbPartitioningSettings{}
for _, opt := range opts {
if opt != nil {
opt.ApplyPartitioningSettingsOption(settings)
}
}
d.PartitioningSettings = (*Ydb_Table.PartitioningSettings)(settings)
}
func WithPartitioningSettings(opts ...PartitioningSettingsOption) CreateTableOption {
return partitioningSettings(opts)
}
type (
ydbPartitioningSettings Ydb_Table.PartitioningSettings
PartitioningSettingsOption interface {
ApplyPartitioningSettingsOption(settings *ydbPartitioningSettings)
}
)
type partitioningBySizePartitioningSettingsOption FeatureFlag
func (flag partitioningBySizePartitioningSettingsOption) ApplyPartitioningSettingsOption(
settings *ydbPartitioningSettings,
) {
settings.PartitioningBySize = FeatureFlag(flag).ToYDB()
}
func WithPartitioningBySize(flag FeatureFlag) PartitioningSettingsOption {
return partitioningBySizePartitioningSettingsOption(flag)
}
type partitionSizeMbPartitioningSettingsOption uint64
func (partitionSizeMb partitionSizeMbPartitioningSettingsOption) ApplyPartitioningSettingsOption(
settings *ydbPartitioningSettings,
) {
settings.PartitionSizeMb = uint64(partitionSizeMb)
}
func WithPartitionSizeMb(partitionSizeMb uint64) PartitioningSettingsOption {
return partitionSizeMbPartitioningSettingsOption(partitionSizeMb)
}
type partitioningByLoadPartitioningSettingsOption FeatureFlag
func (flag partitioningByLoadPartitioningSettingsOption) ApplyPartitioningSettingsOption(
settings *ydbPartitioningSettings,
) {
settings.PartitioningByLoad = FeatureFlag(flag).ToYDB()
}
func WithPartitioningByLoad(flag FeatureFlag) PartitioningSettingsOption {
return partitioningByLoadPartitioningSettingsOption(flag)
}
type partitioningByPartitioningSettingsOption []string
func (columns partitioningByPartitioningSettingsOption) ApplyPartitioningSettingsOption(
settings *ydbPartitioningSettings,
) {
settings.PartitionBy = columns
}
func WithPartitioningBy(columns []string) PartitioningSettingsOption {
return partitioningByPartitioningSettingsOption(columns)
}
type minPartitionsCountPartitioningSettingsOption uint64
func (minPartitionsCount minPartitionsCountPartitioningSettingsOption) ApplyPartitioningSettingsOption(
settings *ydbPartitioningSettings,
) {
settings.MinPartitionsCount = uint64(minPartitionsCount)
}
func WithMinPartitionsCount(minPartitionsCount uint64) PartitioningSettingsOption {
return minPartitionsCountPartitioningSettingsOption(minPartitionsCount)
}
type maxPartitionsCountPartitioningSettingsOption uint64
func (maxPartitionsCount maxPartitionsCountPartitioningSettingsOption) ApplyPartitioningSettingsOption(
settings *ydbPartitioningSettings,
) {
settings.MaxPartitionsCount = uint64(maxPartitionsCount)
}
func WithMaxPartitionsCount(maxPartitionsCount uint64) PartitioningSettingsOption {
return maxPartitionsCountPartitioningSettingsOption(maxPartitionsCount)
}
type (
DropTableDesc Ydb_Table.DropTableRequest
DropTableOption interface {
ApplyDropTableOption(desc *DropTableDesc)
}
)
type (
AlterTableDesc Ydb_Table.AlterTableRequest
AlterTableOption interface {
ApplyAlterTableOption(desc *AlterTableDesc, a *allocator.Allocator)
}
)
// WithAddColumn adds column in AlterTable request
func WithAddColumn(name string, typ types.Type) AlterTableOption {
return column{
name: name,
typ: typ,
}
}
// WithAlterAttribute changes attribute in AlterTable request
func WithAlterAttribute(key, value string) AlterTableOption {
return attribute{
key: key,
value: value,
}
}
// WithAddAttribute adds attribute to table in AlterTable request
func WithAddAttribute(key, value string) AlterTableOption {
return attribute{
key: key,
value: value,
}
}
// WithDropAttribute drops attribute from table in AlterTable request
func WithDropAttribute(key string) AlterTableOption {
return attribute{
key: key,
}
}
func WithAddColumnMeta(column Column) AlterTableOption {
return columnMeta(column)
}
type dropColumn string
func (name dropColumn) ApplyAlterTableOption(d *AlterTableDesc, a *allocator.Allocator) {
d.DropColumns = append(d.DropColumns, string(name))
}
func WithDropColumn(name string) AlterTableOption {
return dropColumn(name)
}
func WithAddColumnFamilies(cf ...ColumnFamily) AlterTableOption {
return columnFamilies(cf)
}
func WithAlterColumnFamilies(cf ...ColumnFamily) AlterTableOption {
return columnFamilies(cf)
}
func WithAlterReadReplicasSettings(rr ReadReplicasSettings) AlterTableOption {
return readReplicasSettings(rr)
}
func WithAlterStorageSettings(ss StorageSettings) AlterTableOption {
return storageSettings(ss)
}
func WithAlterKeyBloomFilter(f FeatureFlag) AlterTableOption {
return keyBloomFilter(f)
}
func WithAlterPartitionSettingsObject(ps PartitioningSettings) AlterTableOption {
return partitioningSettingsObject(ps)
}
// WithSetTimeToLiveSettings appends TTL settings in AlterTable request
func WithSetTimeToLiveSettings(settings TimeToLiveSettings) AlterTableOption {
return timeToLiveSettings(settings)
}
type dropTimeToLive struct{}
func (dropTimeToLive) ApplyAlterTableOption(d *AlterTableDesc, a *allocator.Allocator) {
d.TtlAction = &Ydb_Table.AlterTableRequest_DropTtlSettings{}
}
// WithDropTimeToLive drops TTL settings in AlterTable request
func WithDropTimeToLive() AlterTableOption {
return dropTimeToLive{}
}
type (
CopyTableDesc Ydb_Table.CopyTableRequest
CopyTableOption func(*CopyTableDesc)
)
type (
CopyTablesDesc Ydb_Table.CopyTablesRequest
CopyTablesOption func(*CopyTablesDesc)
)
func CopyTablesItem(src, dst string, omitIndexes bool) CopyTablesOption {
return func(desc *CopyTablesDesc) {
desc.Tables = append(desc.Tables, &Ydb_Table.CopyTableItem{
SourcePath: src,
DestinationPath: dst,
OmitIndexes: omitIndexes,
})
}
}
type (
RenameTablesDesc Ydb_Table.RenameTablesRequest
RenameTablesOption func(desc *RenameTablesDesc)
)
func RenameTablesItem(src, dst string, replaceDestination bool) RenameTablesOption {
return func(desc *RenameTablesDesc) {
desc.Tables = append(desc.Tables, &Ydb_Table.RenameTableItem{
SourcePath: src,
DestinationPath: dst,
ReplaceDestination: replaceDestination,
})
}
}
type (
ExecuteSchemeQueryDesc Ydb_Table.ExecuteSchemeQueryRequest
ExecuteSchemeQueryOption func(*ExecuteSchemeQueryDesc)
)
type (
ExecuteDataQueryDesc struct {
*Ydb_Table.ExecuteDataQueryRequest
IgnoreTruncated bool
}
ExecuteDataQueryOption interface {
ApplyExecuteDataQueryOption(d *ExecuteDataQueryDesc, a *allocator.Allocator) []grpc.CallOption
}
executeDataQueryOptionFunc func(d *ExecuteDataQueryDesc, a *allocator.Allocator) []grpc.CallOption
)
func (f executeDataQueryOptionFunc) ApplyExecuteDataQueryOption(
d *ExecuteDataQueryDesc, a *allocator.Allocator,
) []grpc.CallOption {
return f(d, a)
}
var _ ExecuteDataQueryOption = executeDataQueryOptionFunc(nil)
type (
CommitTransactionDesc Ydb_Table.CommitTransactionRequest
CommitTransactionOption func(*CommitTransactionDesc)
)
type (
queryCachePolicy Ydb_Table.QueryCachePolicy
QueryCachePolicyOption func(*queryCachePolicy, *allocator.Allocator)
)
// WithKeepInCache manages keep-in-cache flag in query cache policy
//
// By default all data queries executes with keep-in-cache policy
func WithKeepInCache(keepInCache bool) ExecuteDataQueryOption {
return withQueryCachePolicy(
withQueryCachePolicyKeepInCache(keepInCache),
)
}
type withCallOptions []grpc.CallOption
func (opts withCallOptions) ApplyExecuteScanQueryOption(d *ExecuteScanQueryDesc) []grpc.CallOption {
return opts
}
func (opts withCallOptions) ApplyBulkUpsertOption() []grpc.CallOption {
return opts
}
func (opts withCallOptions) ApplyExecuteDataQueryOption(
d *ExecuteDataQueryDesc, a *allocator.Allocator,
) []grpc.CallOption {
return opts
}
// WithCallOptions appends flag of commit transaction with executing query
func WithCallOptions(opts ...grpc.CallOption) withCallOptions {
return opts
}
// WithCommit appends flag of commit transaction with executing query
func WithCommit() ExecuteDataQueryOption {
return executeDataQueryOptionFunc(func(desc *ExecuteDataQueryDesc, a *allocator.Allocator) []grpc.CallOption {
desc.TxControl.CommitTx = true
return nil
})
}
// WithIgnoreTruncated mark truncated result as good (without error)
func WithIgnoreTruncated() ExecuteDataQueryOption {
return executeDataQueryOptionFunc(func(desc *ExecuteDataQueryDesc, a *allocator.Allocator) []grpc.CallOption {
desc.IgnoreTruncated = true
return nil
})
}
// WithQueryCachePolicyKeepInCache manages keep-in-cache policy
//
// Deprecated: data queries always executes with enabled keep-in-cache policy.
// Will be removed after Oct 2024.
// Read about versioning policy: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
func WithQueryCachePolicyKeepInCache() QueryCachePolicyOption {
return withQueryCachePolicyKeepInCache(true)
}
func withQueryCachePolicyKeepInCache(keepInCache bool) QueryCachePolicyOption {
return func(p *queryCachePolicy, a *allocator.Allocator) {
p.KeepInCache = keepInCache
}
}
// WithQueryCachePolicy manages query cache policy
//
// Deprecated: use WithKeepInCache for disabling keep-in-cache policy.
// Will be removed after Oct 2024.
// Read about versioning policy: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
func WithQueryCachePolicy(opts ...QueryCachePolicyOption) ExecuteDataQueryOption {
return withQueryCachePolicy(opts...)
}
func withQueryCachePolicy(opts ...QueryCachePolicyOption) ExecuteDataQueryOption {
return executeDataQueryOptionFunc(func(d *ExecuteDataQueryDesc, a *allocator.Allocator) []grpc.CallOption {
if d.QueryCachePolicy == nil {
d.QueryCachePolicy = a.TableQueryCachePolicy()
d.QueryCachePolicy.KeepInCache = true
}
for _, opt := range opts {
if opt != nil {
opt((*queryCachePolicy)(d.QueryCachePolicy), a)
}
}
return nil
})
}
func WithCommitCollectStatsModeNone() CommitTransactionOption {
return func(d *CommitTransactionDesc) {
d.CollectStats = Ydb_Table.QueryStatsCollection_STATS_COLLECTION_NONE
}
}
func WithCommitCollectStatsModeBasic() CommitTransactionOption {
return func(d *CommitTransactionDesc) {
d.CollectStats = Ydb_Table.QueryStatsCollection_STATS_COLLECTION_BASIC
}
}
func WithCollectStatsModeNone() ExecuteDataQueryOption {
return executeDataQueryOptionFunc(func(d *ExecuteDataQueryDesc, a *allocator.Allocator) []grpc.CallOption {
d.CollectStats = Ydb_Table.QueryStatsCollection_STATS_COLLECTION_NONE
return nil
})
}
func WithCollectStatsModeBasic() ExecuteDataQueryOption {
return executeDataQueryOptionFunc(func(d *ExecuteDataQueryDesc, a *allocator.Allocator) []grpc.CallOption {
d.CollectStats = Ydb_Table.QueryStatsCollection_STATS_COLLECTION_BASIC
return nil
})
}
type (
BulkUpsertOption interface {
ApplyBulkUpsertOption() []grpc.CallOption
}
)
type (
ExecuteScanQueryDesc Ydb_Table.ExecuteScanQueryRequest
ExecuteScanQueryOption interface {
ApplyExecuteScanQueryOption(d *ExecuteScanQueryDesc) []grpc.CallOption
}
executeScanQueryOptionFunc func(*ExecuteScanQueryDesc) []grpc.CallOption
)
func (f executeScanQueryOptionFunc) ApplyExecuteScanQueryOption(d *ExecuteScanQueryDesc) []grpc.CallOption {
return f(d)
}
var _ ExecuteScanQueryOption = executeScanQueryOptionFunc(nil)
// WithExecuteScanQueryMode defines scan query mode: execute or explain
func WithExecuteScanQueryMode(m ExecuteScanQueryRequestMode) ExecuteScanQueryOption {