Typedb-client

New Features


Bugs Fixed

- **Fix incorrect usages of TypeDBClientException**
We fixed incorrect usages of TypeDBClientException leading to unhelpful error messages in some scenarios.


Code Refactors


Other Improvements

New Features

- **Add concept cast methods, and add all Concept types to typedb.client**
We added methods to cast concept types to each other: for example `concept.as_attribute()` will now cast a `Concept` to an `Attribute`, throwing an exception if it is not actually an `Attribute`. This aids type checking systems.
Also, all the `Concept` types are now importable from `typedb.client` directly.


Bugs Fixed


Code Refactors


Other Improvements

New Features


Bugs Fixed


Code Refactors

- **Implement cluster authentication**
Implemented authentication secure channels, and user management for typedb cluster.
**SSL is now required for connections to TypeDB cluster** , because sending username/passwords over plaintext connections is disallowed by gRPC.


Other Improvements

New Features

- **Rename batch_size option to prefetch_size**
The option `batch_size` was misleading as we generally use 'batch' to refer to all of the messages sent by a peer (server or client) within a set time window (eg: 1ms). So we renamed it to `prefetch_size`.


Bugs Fixed

- **Fault-tolerant Cluster database operations**
We improved the fault tolerance of our Cluster database operations, namely Create, Contains and Delete.


Code Refactors


Other Improvements

- **Adjust Cluster discovery logging**
Print logs on cluster discovery _before_ the actual discovery happens (and has a chance to fail) such that passing invalid cluster address is easier to debug.

PyPI package: https://pypi.org/project/grakn-client
Documentation: https://dev.docs.grakn.ai/docs/client-api/python

Distribution

Available through https://pypi.org


pip install grakn-client==2.0.1



New Features

- **Encode request IDs as bytes and make is_inferred a Local Thing method**
Previously the ID of a transaction request was stored as a string, which is an inefficient representation of a UUID. We've changed it to bytes.
Also, `is_inferred` is now a Local method on `Thing`.


Bugs Fixed


Code Refactors


Other Improvements



---

**Please refer to [full release notes of 2.0.0-alpha](https://github.com/graknlabs/client-python/releases/tag/2.0.0-alpha) to see the changes contained in 2.0.0.**

PyPI package: https://pypi.org/project/grakn-client
Documentation: https://dev.docs.grakn.ai/docs/client-api/python

Distribution

Available through https://pypi.org


pip install grakn-client==2.0.0



New Features

- **Implement explanations**
Following https://github.com/graknlabs/grakn/pull/6271 and the corresponding protocol change in https://github.com/graknlabs/protocol/pull/131 we implement Explanations, Explainable concept maps, and the explain() query API, which allows users to stream Explanations on demand **note: explain query or transaction option must be set to `true`**

- **Set default parallelism of CoreClient to 2**
Given that Python doesn't provide an easy way of getting the number of CPUs available to the process, we decided to reduce the default parallelism of CoreClient from 3 to 2. This should ensure it continues to run smoothly on systems with fewer cores.

- **Add prefetch, session, schema lock timeout options**
We added three new `GraknOptions`: `prefetch`, `session_idle_timeout_millis` and `schema_lock_acquire_timeout_millis`.


Bugs Fixed

- **Fix test-deployment**
API changes broke test-deployment, so we updated it.

- **On transaction failover, transfer options to the new session**
Previously, when opening a Transaction to Grakn Cluster failed (causing a new Session to be opened to a new server), the old Session options were discarded. Now, we properly transfer the Session-level options to the new session.


Code Refactors

- **Shorten enum names to SessionType, TransactionType**
While aligning Client Python with Client Java, we introduced `GraknTransaction.Type` and `GraknSession.Type`. But in Python these proved cumbersome to type out. So we reverted them to `SessionType` and `TransactionType`.

- **Architecture refactor**
We have refactored Client Python considerably to come up with an architecture that is easy to understand, easy to extend, and easy to replicate in other languages that wish to implement a Grakn Client.
This is a **breaking change**. The updated APIs are:

Create a Grakn Core client
py
client = Grakn.core_client(address="localhost:1729")

Create a Grakn Cluster client
py