Skip to content

Commit 688b7e2

Browse files
committed
Prepare for release 3.0.5. Update release notes
1 parent 8633697 commit 688b7e2

File tree

2 files changed

+29
-37
lines changed

2 files changed

+29
-37
lines changed

RELEASE_NOTES_LATEST.md

Lines changed: 28 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Documentation: https://typedb.com/docs/drivers/rust/overview
99

1010

1111
```sh
12-
cargo add [email protected].4
12+
cargo add [email protected].5
1313
```
1414

1515

1616
### Java driver
1717

18-
Available through [https://repo.typedb.com](https://cloudsmith.io/~typedb/repos/public-release/packages/detail/maven/typedb-driver/3.0.4/a=noarch;xg=com.typedb/)
18+
Available through [https://repo.typedb.com](https://cloudsmith.io/~typedb/repos/public-release/packages/detail/maven/typedb-driver/3.0.5/a=noarch;xg=com.typedb/)
1919
Documentation: https://typedb.com/docs/drivers/java/overview
2020

2121
```xml
@@ -29,7 +29,7 @@ Documentation: https://typedb.com/docs/drivers/java/overview
2929
<dependency>
3030
<groupid>com.typedb</groupid>
3131
<artifactid>typedb-driver</artifactid>
32-
<version>3.0.4</version>
32+
<version>3.0.5</version>
3333
</dependency>
3434
</dependencies>
3535
```
@@ -42,49 +42,41 @@ Documentation: https://typedb.com/docs/drivers/python/overview
4242
Available through https://pypi.org
4343

4444
```
45-
pip install typedb-driver==3.0.4
45+
pip install typedb-driver==3.0.5
4646
```
4747

48-
### NodeJS driver
48+
## New Features
49+
- **Introduce optional concepts to Concept Rows**
4950

50-
NPM package: https://www.npmjs.com/package/typedb-driver
51-
Documentation: https://typedb.com/docs/drivers/nodejs/overview
52-
53-
```
54-
npm install [email protected]
55-
```
51+
`get()` and `get_index()` interfaces of Concept Rows always return optional Concepts (previously, the Java and Python drivers used to return non-optional `Concept` instances). If the requested variable name or index exists in the column names of a row, but the actual value for this variable is empty, an empty optional value is returned. This is a natural behavior for optionals (coming to TypeDB soon!) and is already useful for queries like (where the variable `$empty` won't have values):
52+
```
53+
match not {$empty isa user;}; insert $u isa user, has username "Hi";
54+
```
55+
56+
If the requested variable name or index does not exist in the column names of a row, an error is returned.
5657

57-
### C# driver
58+
59+
5860

59-
NuGet package: https://www.nuget.org/packages/TypeDB.Driver
60-
Documentation: https://typedb.com/docs/drivers/csharp/overview
61+
## Bugs Fixed
62+
- **Mark query answer accessors as allocating for SWIG to prevent memory leaks in the Python driver**
63+
64+
We mark `query_answer_into_rows` and `query_answer_into_documents` as creating a new allocation that needs to be freed by SWIG. Previously, the iterators extracted from the `QueryAnswer` would have been ignored by SWIG and not deallocated when the wrapper is freed.
65+
66+
6167

62-
```xml
63-
<ItemGroup>
64-
<PackageReference Include="TypeDB.Driver" Version="3.0.4" />
65-
<PackageReference Include="TypeDB.Driver.Pinvoke.osx-x64" Version="3.0.4" />
66-
<PackageReference Include="TypeDB.Driver.Pinvoke.linux-x64" Version="3.0.4" />
67-
<PackageReference Include="TypeDB.Driver.Pinvoke.win-x64" Version="3.0.4" />
68-
<PackageReference Include="TypeDB.Driver.Pinvoke.osx-arm64" Version="3.0.4" />
69-
<PackageReference Include="TypeDB.Driver.Pinvoke.linux-arm64" Version="3.0.4" />
70-
</ItemGroup>
71-
```
68+
## Code Refactors
7269

73-
### C++ driver
70+
- **Cleanup driver errors**
7471

75-
Compiled distributions comprising headers and shared libraries available at: https://cloudsmith.io/~typedb/repos/public-release/packages/?q=name:^typedb-driver-cpp+version:3.0.4
76-
Documentation: https://typedb.com/docs/drivers/cpp/overview
72+
Query errors are dissolved in the Java and Python drivers.
73+
All the arguments passed to the external interfaces are validated to be non-null and of the correct format (e.g., non-negative for `concept_row.get_index(column_index)`).
7774

78-
### C driver
7975

80-
Compiled distributions comprising headers and shared libraries available at: https://cloudsmith.io/~typedb/repos/public-release/packages/?q=name:^typedb-driver-clib+version:3.0.4
76+
## Other Improvements
8177

82-
## Code Refactors
83-
- **Add 'dec' suffix to notation of 'Decimal' type**
84-
Add 'dec' suffix to notation of 'Decimal' type
85-
78+
- **Automate README examples updates**
8679

87-
## Other Improvements
88-
- **Update 3.0 drivers api references**
80+
Cloud driver usage examples are added to all the available READMEs. Additionally, these examples are officially available in the repo as separate files.
8981

90-
82+
The process of README examples updating is automated by unifying all language updates in a single script. A new CI job is introduced to verify that the README examples are up to date.

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.0.4
1+
3.0.5

0 commit comments

Comments
 (0)