Skip to content

Commit caf9257

Browse files
authored
YDB FQ: drop outdated fields in Connector API (#16138)
1 parent f68624f commit caf9257

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

ydb/library/yql/providers/generic/connector/api/service/connector.proto

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,18 @@ option go_package = "a.yandex-team.ru/contrib/ydb/library/yql/providers/generic/
1010
// of YQ and YQL services.
1111
service Connector {
1212
// ListTables returns the list of tables existing in a particular database.
13-
rpc ListTables(TListTablesRequest) returns (stream TListTablesResponse);
13+
rpc ListTables(TListTablesRequest) returns (stream TListTablesResponse) {
14+
// This method have never been used in YDB - Connector interaction.
15+
option deprecated = true;
16+
};
17+
1418
// DescribeTable returns table's schema.
1519
rpc DescribeTable(TDescribeTableRequest) returns (TDescribeTableResponse);
20+
1621
// ListSplits asks Connector to partition the data that are going to be read
1722
// into elementary parts suitable for parallel reading.
1823
rpc ListSplits(TListSplitsRequest) returns (stream TListSplitsResponse);
24+
1925
// ReadSplits reads data associated with splits.
2026
rpc ReadSplits(TReadSplitsRequest) returns (stream TReadSplitsResponse);
2127
}

ydb/library/yql/providers/generic/connector/api/service/protos/connector.proto

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,14 @@ option go_package = "a.yandex-team.ru/contrib/ydb/library/yql/providers/generic/
1313

1414
// TListTablesRequest requests the list of tables in a particular database of the data source
1515
message TListTablesRequest {
16+
// This message have never been used in YDB - Connector interaction.
17+
option deprecated = true;
18+
1619
// Data source instance to connect
1720
NYql.TGenericDataSourceInstance data_source_instance = 1;
1821

1922
// There may be a huge number of tables in the data source,
20-
// and here are ways to extract only necessary ones:
23+
// and here are the ways to extract only necessary ones:
2124
oneof filtering {
2225
// Regexp to filter table names
2326
string pattern = 2;
@@ -26,6 +29,9 @@ message TListTablesRequest {
2629

2730
// TListTablesResponse returns the list of tables in a particular database of the data source
2831
message TListTablesResponse {
32+
// This message have never been used in YDB - Connector interaction.
33+
option deprecated = true;
34+
2935
// Table names list
3036
repeated string tables = 1;
3137

@@ -37,7 +43,8 @@ message TListTablesResponse {
3743
message TDescribeTableRequest {
3844
// Data source instance to connect
3945
NYql.TGenericDataSourceInstance data_source_instance = 1;
40-
// Table to describe
46+
// Table name to describe.
47+
// Should be equivalent to the name in TFrom filled in TListSplitsRequest and TReadSplitsRequest.
4148
string table = 2;
4249
// Rules for type mapping
4350
TTypeMappingSettings type_mapping_settings = 3;
@@ -54,7 +61,6 @@ enum EDateTimeFormat {
5461
YQL_FORMAT = 2;
5562
}
5663

57-
5864
// TDescribeTableResponse returns table metadata
5965
message TDescribeTableResponse {
6066
// The whole schema of a table
@@ -157,9 +163,7 @@ message TSelect {
157163
// Strongly typed tree of predicates
158164
TPredicate filter_typed = 1;
159165

160-
// An internal representation of YQL request part describing filters.
161-
// Advanced connectors may use it for the full-fledged implementations of the push down.
162-
TAst filter_raw = 2;
166+
reserved 2;
163167
}
164168

165169
// Transforms into WHERE $filter.
@@ -177,8 +181,8 @@ message TSelect {
177181

178182
// For schemaless data sources, when it's hard for us to infer schema for the query result,
179183
// user can supply the schema himself.
180-
// Optional field that must be empty for schematized data sources.
181-
TSchema predefined_schema = 6;
184+
// This field was used for some outdated experiments with S3 connector. Never try to fill them.
185+
TSchema predefined_schema = 6 [deprecated = true];
182186
}
183187

184188
// Split is a certain part of a table. In general, it should be much smaller than a partition.
@@ -193,6 +197,9 @@ message TSplit {
193197
// so we make the description opaque for YQ.
194198
bytes description = 2;
195199
}
200+
201+
// The ordered number in the split sequence generated in response to the `ListSplits` call
202+
uint64 id = 3;
196203
}
197204

198205
// ReadDataRequest reads the data associated with a particular table split.
@@ -495,17 +502,4 @@ message TError {
495502
// Detailed explanation of a problem;
496503
// must be empty if status == SUCCESS
497504
repeated Ydb.Issue.IssueMessage issues = 3;
498-
}
499-
500-
// TAst is an internal representation of an YQL request.
501-
// Advanced connectors may use it for the full-fledged implementations of the push down.
502-
message TAst {
503-
message TList {
504-
repeated TAst children = 1;
505-
}
506-
507-
oneof payload {
508-
bytes atom = 1;
509-
TList list = 2;
510-
}
511-
}
505+
}

0 commit comments

Comments
 (0)