aboutsummaryrefslogtreecommitdiffstats
path: root/yql/essentials/providers/common/proto/gateways_config.proto
blob: 35654cb4671ea350959d8ce8211a4da16c477b4b (plain) (blame)
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
package NYql;
option java_package = "ru.yandex.yql.proto";

import "yql/essentials/protos/clickhouse.proto";
import "ydb/library/yql/providers/generic/connector/api/common/data_source.proto";
import "ydb/library/yql/providers/generic/connector/api/common/endpoint.proto";


/////////////////////////////// common ///////////////////////////////

message TActivationByHour {
    required uint32 Hour = 1;
    required uint32 Percentage = 2;
}

message TActivationPercentage {
    optional uint32 Percentage = 1 [default = 0];
    repeated TActivationByHour ByHour = 2;
    repeated string IncludeUsers = 3;
    repeated string ExcludeUsers = 4;
    optional bool ExcludeRobots = 5 [default = true];
    repeated string Tags = 6;
    repeated string IncludeGroups = 7;
    repeated string ExcludeGroups = 8;
    repeated string IncludeRevisions = 9;
    repeated string ExcludeRevisions = 10;
}

message TAttr {
    required string Name = 1;
    required string Value = 2;
    optional TActivationPercentage Activation = 3;
}

message TRemoteFilePattern {
    required string Pattern = 1; // regexp to match
    required string Cluster = 2;  // replacement string for YT server
    required string Path = 3;    // replacement string for remote file path
}

enum EYtLogLevel {
    YL_NONE        = -1;
    YL_FATAL       = 0;
    YL_ERROR       = 1;
    YL_INFO        = 2;
    YL_DEBUG       = 3;
};

enum EHostScheme {
    HS_HTTP        = 0;
    HS_HTTPS       = 1;
};

enum ETokenType {
    IAM = 0;
    OAUTH = 1;
    BLACKBOX = 2;
    CREDENTIALS = 3;
};

/////////////////////////////// HTTP GATEWAY //////////////////////

message TExplicitDNSRecord {
  enum ProtocolVersion {
    ANY = 0;
    IPV4 = 1;
    IPV6 = 2;
  };

  optional string Address = 1 [default = ""];
  optional uint32 Port = 2 [default = 443];
  optional string ExpectedIP = 3 [default = ""];
  optional ProtocolVersion Protocol = 4 [default = ANY];
}

message TDnsResolverConfig {
  optional uint32 RefreshMs = 1 [default = 60000];
  repeated TExplicitDNSRecord ExplicitDNSRecord = 100;
}

message THttpGatewayConfig {
    optional uint32 MaxInFlightCount = 1;
    optional uint64 MaxSimulatenousDownloadsSize = 2;
    optional uint32 BuffersSizePerStream = 3;
    optional uint64 ConnectionTimeoutSeconds = 4;
    optional uint64 BytesPerSecondLimit = 5;
    optional uint64 DownloadBufferBytesLimit = 6;
    optional uint64 RequestTimeoutSeconds = 7;
    optional uint64 LowSpeedTimeSeconds = 8;
    optional uint64 LowSpeedBytesLimit = 9;
    optional TDnsResolverConfig DnsResolverConfig = 10;
    optional uint64 MaxRetries = 11;
}

/////////////////////////////// YT ///////////////////////////////

message TYtClusterConfig {
    optional string Name = 1; // Short cluster name
    optional string Cluster = 2; // Real cluster server name with port
    optional bool Default = 3 [default = false]; // Default cluster
    optional string YTToken = 4; // token to use at YT servers
    optional string YTName = 5; // YT cluster name
    optional bool EnabledYtQlQueries = 6 [default = true]; // Allow to handle YtQl queries

    repeated TAttr Settings = 100;
}

message TYtGatewayConfig {
    optional uint32 GatewayThreads = 1 [default = 0]; // Number of gateway MtpQueue threads. The adaptive MtpQueue will be used for 0 value
    optional EYtLogLevel YtLogLevel = 2 [default = YL_ERROR]; // The verbosity level of YT log
    optional string PerfToolsPath = 4; // Path to perftools libraries
    optional bool PerfToolsFromPackage = 5; // Use perftools from package
    optional string MrJobBin = 6; // Path to mrjob executable. If not set then main executable will be used
    optional string MrJobBinMd5 = 13; // MD5 checksum of mrjob executable. Should not be specified directly
    optional string MrJobUdfsDir = 7; // Path to linux udfs. If not set then loaded into main executable will be used
    optional bool ExecuteUdfLocallyIfPossible = 8; // Turns on local execution mode for calc job with UDF.
    optional bool LocalChainTest = 9 [default = false]; // Chain local execution jobs for test purpose.
    optional string YtDebugLogFile = 10; // File for full YT debug log
    optional uint64 YtDebugLogSize = 11 [default = 0]; // Max YT debug log size
    optional bool YtDebugLogAlwaysWrite = 12 [default = false]; // Write YT debug log always or on error only
    optional string LocalChainFile = 14; // File to dump table contet in test mode

    repeated TRemoteFilePattern RemoteFilePatterns = 100;
    repeated TYtClusterConfig ClusterMapping = 101; // Accepted cluster shortcuts. All names not from this list will be rejected
    repeated TAttr DefaultSettings = 102;
}

/////////////////////////////// Grut ///////////////////////////////

message TYtOrmClusterConfig {
    optional string Name = 1; // Examples: grut_testing, grut_stable, grut_dev
    optional string Cluster = 2; // Examples: sas, vla, etc
    optional bool Enabled = 3 [default = true]; // Allow to handle YTORM queries
    optional string EndpointSetId = 4; // Examples: grut-stable.object_api, grut-testing.object_api, etc
}

message TYtOrmGatewayConfig {
    repeated TYtOrmClusterConfig ClusterMapping = 1;
}

/////////////////////////////// Kikimr ///////////////////////////////

message THostPort {
    required string Host = 1;
    required uint32 Port = 2;
    optional uint64 TotalTimeoutMs = 3;
}

message TKikimrGrpcData {
    repeated string Locators = 1;
    optional uint64 TimeoutMs = 2;
    optional uint64 MaxMessageSizeBytes = 3;
    optional uint32 MaxInFlight = 4;
    optional bool EnableEndpointDiscovery = 5;
    optional bool UseLegacyApi = 6;
}

message TKikimrClusterConfig {
    optional string Name = 1;
    optional bool Default = 2 [default = false];
    repeated THostPort MessageBus = 3;
    optional TKikimrGrpcData Grpc = 4;
    optional string Database = 5;
    optional uint32 TvmId = 6 [default = 0];
    optional string Token = 7;
    optional string ProxyUrl = 8;
    optional string Location = 9;
    optional bool IsFromMvp = 10;
    optional ETokenType TokenType = 11;
    repeated TAttr Settings = 101;
}

message TKikimrGatewayConfig {
    repeated TKikimrClusterConfig ClusterMapping = 1;
    repeated TAttr DefaultSettings = 2;
}

/////////////////////////////// Kikimr MVP ///////////////////////////////

message TKikimrMvpProxyConfig {
    optional string Host = 1;
    optional uint32 Port = 2;
    optional string BasePath = 3;
    optional uint32 TvmId = 4 [default = 0];
}

message TKikimrMvpGatewayConfig {
    repeated TKikimrMvpProxyConfig ProxyMapping = 1;
}

///////////////////////////// Ydb /////////////////////////////

message TYdbClusterConfig {
    optional string Name = 1;
    optional string Endpoint = 2;
    optional string Token = 3;
    optional TKikimrGrpcData Grpc = 4;
    optional uint32 TvmId = 5 [default = 0];
    optional string Database = 6;
    optional string Id = 7;
    optional bool Secure = 8;
    optional string ServiceAccountId = 9;
    optional string ServiceAccountIdSignature = 10;
    optional bool AddBearerToToken = 11; // whether to use prefix "Bearer " in token
    repeated TAttr Settings = 100;
}

message TYdbGatewayConfig {
    repeated TYdbClusterConfig ClusterMapping = 1;
    optional string DefaultEndpoint = 2;
    optional string DefaultToken = 3;
    repeated TAttr DefaultSettings = 4;
}

///////////////////////////// ClickHouse /////////////////////////////

message TClickHouseClusterConfig {
    optional string Name = 1;
    optional bool Default = 2 [default = false];
    optional string Cluster = 3;
    optional string CHToken = 4;
    repeated TAttr Settings = 101;
    optional EHostScheme HostScheme = 5;
    optional uint32 HostPort = 6;
    optional string CHTokenYavSecretId = 7;
    optional string CHTokenYavVersionId = 8;
    optional string CHTokenYavKey = 9;
    optional NYql.NProto.TClickHouseRunnerConfig Runner = 10;
    optional uint32 NativeHostPort = 11 [default = 9000];
    optional bool NativeSecure = 12 [default = false];
    optional string Id = 13;
    repeated string GroupAllowed = 14;
}

message TClickHouseGatewayConfig {
    repeated TClickHouseClusterConfig ClusterMapping = 1;
    repeated TAttr DefaultSettings = 2;
}

///////////////////////////// RTMR /////////////////////////////
enum EYfArtifactType {
    AT_NONE  = 0;
    AT_FILE  = 1;
    AT_LAYER = 2;
};

enum ERtmrOperationType {
    OT_NONE        = 0;
    OT_LF_PARSE    = 1;
    OT_YDB_OUT     = 2;
    OT_SOLOMON_OUT = 3;
    OT_PQ_OUT      = 4;
};

message TYfArtifactLink {
    optional EYfArtifactType Type = 1;
    optional string Url = 2; // in any format suitable for file storage
    optional string TargetFilePath = 3; // ignored for Type=AT_LAYER
};

message TRtmrOperationArtifactsInfo {
    optional ERtmrOperationType Type = 1;
    repeated TYfArtifactLink Links = 2;
};

message TRtmrPqConsumerInfo {
    optional string Cluster = 1;
    optional string Consumer = 2;
}

message TRtmrClusterConfig {
    optional string Name = 1;
    optional bool Default = 2 [default = false];
    optional string Cluster = 3;
    optional string RemoteName = 4;
    optional string YfCluster = 5;
    optional string S3TokenPath = 6;
    optional string S3FileCachePath = 7;
    optional uint32 TvmId = 8 [default = 0];
    optional string TvmSecretPath = 9;
    repeated string Users = 10;
    optional bool UploadViaYfClient = 11 [default = false];
    optional string MdsTorrentUrl = 12;
    repeated TRtmrOperationArtifactsInfo ArtifactOverrides = 13; // override CommonArtifacts by ERtmrOperationType
    optional string PqConsumer = 14;
    repeated TRtmrPqConsumerInfo PqConsumerMapping = 15;
    optional uint32 MaxPqPartitions = 16;
    optional uint32 PreviewCollectTimeoutMs = 17;
    optional string SbdTvmSecretFile = 18;
    optional uint64 SbdTvmClientId = 19;
    optional uint64 SbdTvmServerId = 20 [default = 2021848];
    repeated TAttr Settings = 101;
}

message TRtmrGatewayConfig {
    repeated TRtmrClusterConfig ClusterMapping = 1;
    repeated TAttr DefaultSettings = 2;
    optional string YqlRtmrDynLib = 3; // path to libyql-dynlib.so
    optional bool UseFakeYfUpload = 4 [default = false]; // use in tests only to speedup upload
    repeated string Artifacts = 5;  /// default artifacts to put into every function
    repeated TRtmrOperationArtifactsInfo CommonArtifacts = 6; // common artifacts for all clusters
    optional uint32 MaxPqPartitions = 7 [default = 10];
    optional uint32 PreviewCollectTimeoutMs = 8 [default = 2000];
    optional bool KeepActiveProcess = 9 [default = false];
}

///////////////////////////// Pq //////////////////////////////

message TPqClusterConfig {
    enum EClusterType {
        CT_UNSPECIFIED = 0;
        CT_PERS_QUEUE = 1;
        CT_DATA_STREAMS = 2;
    }

    optional string Name = 1;
    optional EClusterType ClusterType = 2 [default = CT_PERS_QUEUE];
    optional string Endpoint = 3;
    optional string ConfigManagerEndpoint = 4;
    optional string Token = 5;
    optional string Database = 6 [default = "/Root"];
    optional uint32 TvmId = 7 [default = 0];
    optional bool UseSsl = 8; // grpcs
    optional string ServiceAccountId = 9;
    optional string ServiceAccountIdSignature = 10;
    optional bool AddBearerToToken = 11; // whether to use prefix "Bearer " in token
    optional string DatabaseId = 12;
    repeated TAttr Settings = 100;
    optional bool SharedReading = 101;
    optional string ReconnectPeriod = 102; // disabled by default, example of a parameter: 5m
}

message TPqGatewayConfig {
    repeated TPqClusterConfig ClusterMapping = 1;
    optional string DefaultToken = 2;
    repeated TAttr DefaultSettings = 100;
}

///////////////////////////// Stat /////////////////////////////

message TStatClusterConfig {
    optional string Name = 1; // Short cluster name
    optional string Cluster = 2; // Real cluster server name with port
    optional bool Default = 3 [default = false]; // Default cluster
    optional string StatToken = 4; // token to use in communication with Statface
    optional string StatName = 5; // Stat cluster name

    repeated TAttr Settings = 100;
}

message TStatGatewayConfig {
    optional uint32 GatewayThreads = 1 [default = 0]; // Number of gateway MtpQueue threads. The adaptive MtpQueue will be used for 0 value

    repeated TStatClusterConfig ClusterMapping = 101; // Accepted cluster shortcuts. All names not from this list will be rejected
    repeated TAttr DefaultSettings = 102;
}

///////////////////////////// CHYT /////////////////////////////

message TChytClusterConfig {
    optional string Name = 1; // Short cluster name
    optional string YtCluster = 2; // Name of the corresponding YT cluster.
}

message TChytGatewayConfig {
    repeated TChytClusterConfig ClusterMapping = 1;
}

///////////////////////////// S3 /////////////////////////////

message TS3ClusterConfig {
    optional string Name = 1; // Short cluster name
    optional string Url = 2;
    optional string Token = 3;
    optional string ServiceAccountId = 4;
    optional string ServiceAccountIdSignature = 5;
    repeated TAttr Settings = 100;
}

message TS3FormatSizeLimit {
    optional string Name = 1;          // Format name i.e. csv_with_names
    optional uint64 FileSizeLimit = 2; // Max allowed size for this format
}

message TS3GatewayConfig {
    repeated TS3ClusterConfig ClusterMapping = 1;

    optional uint64 FileSizeLimit = 2;               // Global limit
    repeated TS3FormatSizeLimit FormatSizeLimit = 6; // Format limits (override FileSizeLimit)
    optional uint64 BlockFileSizeLimit = 10;         // Global limit for block readers (overrides FormatSizeLimit)
    optional uint64 MaxFilesPerQuery = 3;
    optional uint64 MaxReadSizePerQuery = 4;
    optional uint64 MaxDiscoveryFilesPerQuery = 5;
    optional uint64 MaxInflightListsPerQuery = 7;
    optional uint64 MaxDirectoriesAndFilesPerQuery = 8;
    optional uint64 MinDesiredDirectoriesOfFilesPerQuery = 9;
    optional bool AllowConcurrentListings = 11 [default = false];
    optional uint64 ListingCallbackThreadCount = 12;
    optional uint64 ListingCallbackPerThreadQueueSize = 13;
    optional uint64 RegexpCacheSize = 14;
    optional uint64 GeneratorPathsLimit = 15;
    optional uint64 MaxListingResultSizePerPartition = 16;
    optional uint64 RowsInBatch = 17; // Default = 1000
    optional uint64 MaxInflight = 18; // Default = 20
    optional uint64 DataInflight = 19; // Default = 200 MB
    optional bool AllowLocalFiles = 20;

    repeated TAttr DefaultSettings = 100;
}

///////////////////////////// Solomon /////////////////////////////

message TSolomonClusterConfig {
    enum ESolomonClusterType {
        SCT_UNSPECIFIED = 0;
        SCT_SOLOMON = 1;
        SCT_MONITORING = 2;
    }

    message TShardPath {
        required string Project = 1; // CloudId for YC
        required string Cluster = 2; // FolderId for YC
    }

    optional string Name = 1;
    optional string Cluster = 2;
    optional bool UseSsl = 3;
    optional ESolomonClusterType ClusterType = 4 [default = SCT_SOLOMON];
    optional string Token = 5;
    optional string ServiceAccountId = 6;
    optional string ServiceAccountIdSignature = 7;
    optional TShardPath Path = 8;

    repeated TAttr Settings = 100;
}

message TSolomonGatewayConfig {
    repeated TSolomonClusterConfig ClusterMapping = 1;
    repeated TAttr DefaultSettings = 2;
}

message TFileStorageAdditionalConfig {
    message TUrlPattern {
        required string Pattern = 1;
        optional string Alias = 2;
    }

    message TSchemeTranslate {
        required string Pattern = 1; // regexp to match
        required string TargetUrl = 2; // replacement string for target URL
    }

    repeated TUrlPattern AllowedUrls = 2; // Whitelist of url regexps; disabled if empty
    repeated TUrlPattern ExternalAllowedUrls = 3; // Whitelist of url regexps for external users; disabled if empty
    repeated TSchemeTranslate CustomSchemes = 4;
}

/////////////////////////////// Postgresql /////////////////////////////

message TPostgresqlClusterConfig {
    optional string Name = 1;
    optional string Cluster = 2;
    optional string PGtoken = 3;
    optional string TargetServerType = 4;
    optional uint64 MaxResultBufferSize = 5 [default = 1000000]; // Zero value disables adaptiveFetch
}

message TPostgresqlGatewayConfig {
    repeated TPostgresqlClusterConfig ClusterMapping = 1;
    optional uint64 MaxResultBufferSize = 2 [default = 1000000]; // Zero value disables adaptiveFetch by default
}

/////////////////////////////// Mysql /////////////////////////////

message TMysqlClusterConfig {
    optional string Name = 1;
    optional string Cluster = 2;
    optional string MysqlToken = 3;
}

message TMysqlGatewayConfig {
    repeated TMysqlClusterConfig ClusterMapping = 1;
}


/////////////////////////////// Dq /////////////////////////////////////
message TDqGatewayConfig {
    message TDefaultAutoByHourPercentage {
        required uint32 Hour = 1;
        required uint32 Percentage = 2;
    }

    optional uint32 DefaultAutoPercentage = 1 [default = 0]; // Probability of 'DqEngine="auto"'
    repeated TDefaultAutoByHourPercentage DefaultAutoByHour = 2;
    repeated string NoDefaultAutoForUsers = 3;

    repeated string DefaultAnalyzeQueryForUsers = 4;

    repeated TAttr DefaultSettings = 102;

    optional uint32 WithHiddenPercentage = 5 [default = 0];     // Depricated. TODO: remove
    repeated TDefaultAutoByHourPercentage WithHiddenByHour = 6; // Depricated. TODO: remove
    repeated string NoWithHiddenForUsers = 7;                   // Depricated. TODO: remove
    repeated string WithHiddenForUsers = 8;                     // Depricated. TODO: remove

    optional TActivationPercentage HiddenActivation = 9;
}

/////////////////////////////// Yql Core ///////////////////////////////

message TCoreAttr {
    required string Name = 1;
    repeated string Args = 2;
    optional TActivationPercentage Activation = 3;
}

message TYqlCoreConfig {
    repeated TCoreAttr Flags = 1;
    optional TActivationPercentage QPlayerActivation = 2;
}

/////////////////////////////// Sql Core ///////////////////////////////
message TWarnAsErrorByHourPercentage {
    required uint32 Hour = 1;
    required uint32 Percentage = 2;
}

message TSqlCoreConfig {
    optional uint32 V0SyntaxWarnAsErrorPercentage = 1 [default = 0]; // Probability of 'deprecated syntax'
                                                                     // warning to become an error
    repeated TWarnAsErrorByHourPercentage V0SyntaxWarnAsErrorByHour = 2;
    repeated string NoV0SyntaxErrorForUsers = 3;

    repeated string TranslationFlags = 4;
}

/////////////////////////////// Db Tool ///////////////////////////////

message TUserException {
    required string Login = 1;
    optional uint32 ExpireDays = 2 [default = 0]; // 0 - don't delete history at all
}

message TDbToolConfig {
    optional uint32 DefaultExpireDays = 1;
    optional string RobotPattern = 2;
    repeated string DeleteQueryRunner = 3;
    repeated TUserException UserException = 4;
}


/////////// Generic gateway for the external data sources ////////////

message TGenericClusterConfig {
    // Cluster name
    optional string Name = 1;

    // Data source kind
    optional NYql.NConnector.NApi.EDataSourceKind Kind = 8;

    // Location represents the network address of a data source instance we want to connect
    oneof Location {
        // Endpoint must be used for on-premise deployments.
        NYql.NConnector.NApi.TEndpoint Endpoint = 9;
        // DatabaseId must be used when the data source is deployed in cloud.
        // Data source FQDN and port will be resolved by MDB service.
        string DatabaseId = 4;
    }

    // Credentials used to access data source instance
    optional NYql.NConnector.NApi.TCredentials Credentials = 10;

    // Credentials used to access managed databases APIs.
    // When working with external data source instances deployed in clouds,
    // one should either set (ServiceAccountId, ServiceAccountIdSignature) pair 
    // that will be resolved into IAM Token via Token Accessor, 
    // or provide IAM Token directly.
    optional string ServiceAccountId = 6;
    optional string ServiceAccountIdSignature = 7;
    optional string Token = 11;

    // If true, the generic provider will ask connector server to use secure connections
    // to access remote data sources.
    optional bool UseSsl = 12;

    // Name of a particular database within a database cluster
    optional string DatabaseName = 13;

    // Transport protocol used to establish a network connection with database
    optional NYql.NConnector.NApi.EProtocol Protocol = 14;

    // Data source options specific to various data sources
    map<string, string> DataSourceOptions = 15;

    reserved 2, 3, 5;
}

message TGenericConnectorConfig {
    // There are two options to configure Connector network address:
    // 1. Set address statically via `Endpoint.Host` and `Endpoint.Port`;
    // 2. Ask YDB to set `Endpoint.Port` to the value of expression `./ydbd --ic-port + OffsetFromIcPort`,
    // while Connector's hostname will still be taken from `Endpoint.Host` (with 'localhost' as a default value).
    optional NYql.NConnector.NApi.TEndpoint Endpoint = 3;
    optional uint32 OffsetFromIcPort = 6;

    // If true, Connector GRPC Client will use TLS encryption.
    optional bool UseSsl = 4;
    // Path to the custom CA certificate to verify Connector's certs.
    // If empty, the default system CA certificate pool will be used.
    optional string SslCaCrt = 5;

    reserved 1, 2;
}

message TGenericGatewayConfig {
    // Connector service network endpoint
    // TODO: replace with map<DataSourceKind, TGenericConnectorConfig>
    optional TGenericConnectorConfig Connector = 5;

    // Database clusters supported by this particular instance
    repeated TGenericClusterConfig ClusterMapping = 3;

    // MDB API endpoint (no need to fill in case of on-prem deployment).
    optional string MdbGateway = 4;

    // YDB MVP API endpoint (no need to fill in case of on-prem deployment).
    // Expected format:
    // [http|https]://host:port/ydbc/cloud-prod/
    optional string YdbMvpEndpoint = 7;

    repeated TAttr DefaultSettings = 6;

    reserved 1, 2;
}

/////////////////////////////// Db Resolver ///////////////////////////////////

message TDbResolverConfig {
    // Ydb / Yds MVP endpoint.
    // Expected format: 
    // [http|https]://host:port/ydbc/cloud-prod/
    optional string YdbMvpEndpoint = 2;
}

/////////////////////////////// Revision filter ///////////////////////////////

message TRevisionException {
    repeated string Revisions = 1;
    repeated string IncludeUsers = 2;
    repeated string ExcludeUsers = 3;
}

message TRevisionFilterConfig {
    repeated TRevisionException RevisionException = 1;
}

/////////////////////////////// Root ///////////////////////////////

message TGatewaysConfig {
    optional TYtGatewayConfig Yt = 1;
    optional TKikimrGatewayConfig Kikimr = 2;
    optional TClickHouseGatewayConfig ClickHouse = 3;
    optional TRtmrGatewayConfig Rtmr = 4;
    optional TKikimrMvpGatewayConfig KikimrMvp = 5;
    optional TStatGatewayConfig Stat = 6;
    optional TChytGatewayConfig Chyt = 7;
    optional TSolomonGatewayConfig Solomon = 8;
    optional TFileStorageAdditionalConfig Fs = 9;
    optional TYqlCoreConfig YqlCore = 10;
    optional TPostgresqlGatewayConfig Postgresql = 11;
    optional TSqlCoreConfig SqlCore = 12;
    optional TDqGatewayConfig Dq = 13;
    optional TMysqlGatewayConfig Mysql = 14;
    optional TYdbGatewayConfig Ydb = 15;
    optional TPqGatewayConfig Pq = 16;
    optional TS3GatewayConfig S3 = 17;
    optional THttpGatewayConfig HttpGateway = 18;
    optional TYtOrmGatewayConfig YtOrm = 19;
    optional TDbToolConfig DbTool = 20;
    optional TGenericGatewayConfig Generic = 21;
    optional TRevisionFilterConfig RevisionFilter = 22;
    optional TDbResolverConfig DbResolver = 23;
}