Skip to content

Commit 068e5e5

Browse files
rekbyasmyasnikov
authored andcommitted
Update CHANGELOG.md
1 parent 4cb0464 commit 068e5e5

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

CHANGELOG.md

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,17 @@
1+
SMALL BROKEN CHANGES
2+
Most users can skip there notes and upgrade as usual because build break rare used methods (expiremental API and api for special cases, not need for common use YDB) and this version has no any behavior changes.
3+
14
Changes for expiremental topic API
2-
* BROKEN CHANGE in experimantal topic api: producer id on start writer now is optional
3-
* BROKEN CHANGE in experimantal topic api: remove WithMessageGroupID option (because not supported now)
5+
* Moved producer_id from required positional argument to option `WithProducerID` (and it is optional now)
6+
* Removed `WithMessageGroupID` option (because not supported now)
47

58
Changes in ydb connection:
6-
* Publish internal private ydb.connection as ydb.Driver (implement ydb.Connection)
7-
* ydb.Connection was Deprected
8-
* BROKEN CHANGE: ydb.Open(...) return *ydb.Driver instead of ydb.Connection
9-
* BROKEN CHANGE: ydb.New(...) return *ydb.Driver instead of ydb.Connection
10-
* BROKEN CHANGE: ydb.GRPCConn accept *ydb.Driver instead of ydb.Connection
11-
* BROKEN CHANGE: remove method With for ydb.Connection (use *Driver.With) if need.
12-
13-
Notes:
14-
Most users can skip there notes and upgrade as usual because build beroken for rare used methods (expiremental API and api for special cases, not need for common use YDB) and this version will not change behaviour.
15-
16-
For most users there changes will not broke them code because new *Driver is implement old ydb.Connection interface and previous code with ydb.Connection variables will continue to work. ydb.Connection.With not need for normal work with YDB. it need for rare special cases only.
17-
18-
It is intermediate version for API changes: if you use topic writer or use strong linter with deny to use
19-
deprecated functions/types.
20-
21-
If your code build wwas broken recommend upgrade way to upgrade:
22-
1. Upgrade to latest v3.42.x version and check work your application. (Send issue if some bugs, we will fix it in v.3.42.x patches)
23-
2. Upgrade from v3.42 to v3.43 - it is API changes only version, without change behaviour.
24-
3. Upgrade next as usual (if any bugs you can downgrade to 3.42 without change you code)
9+
* Publish internal private ydb.connection as `ydb.Driver` (it is implement `ydb.Connection`)
10+
* `ydb.Connection` was Deprected
11+
* Changed return type of `ydb.Open(...)` from `ydb.Connection` to `*ydb.Driver`
12+
* Changed return type of `ydb.New(...)` from `ydb.Connection` to `*ydb.Driver`
13+
* Changed argument type for ydb.GRPCConn from `ydb.Connection` to `*ydb.Driver`
14+
* Removed method `With` from `ydb.Connection` (use *Driver.With) if need.
2515

2616
## v3.42.15
2717
* Fixed checking `nil` error with `internal/xerrors.Is`

0 commit comments

Comments
 (0)