feat(python): support use of KùzuDB via pl.read_database

[alexander-beedie]

Quite happy with how the ConnectionExecutor abstraction is holding up as it only required a few minor tweaks to add support for kuzu¹ graph database queries (which make use of the Cypher² query language).

Registered it as having Arrow-aware return, so we will always load results efficiently (eg: not via the row iterator), and also made a PR on their side adding direct Polars export support to their QueryResult object; we don't need to wait on that here though, as we can use their existing Arrow export directly (see: kuzudb/kuzu#2985).

Example

df = pl.read_database(
    query = "MATCH (a:User)-[f:Follows]->(b:User) RETURN a.name, f.since, b.name",
    connection = kuzu_connection,
)
# shape: (4, 3)
# ┌─────────┬─────────┬─────────┐
# │ a.name  ┆ f.since ┆ b.name  │
# │ ---     ┆ ---     ┆ ---     │
# │ str     ┆ i64     ┆ str     │
# ╞═════════╪═════════╪═════════╡
# │ Adam    ┆ 2020    ┆ Karissa │
# │ Adam    ┆ 2020    ┆ Zhang   │
# │ Karissa ┆ 2021    ┆ Zhang   │
#  ...

Footnotes

1. KùzuDB: https://kuzudb.com/ ↩

2. Cypher: https://kuzudb.com/docusaurus/cypher/ ↩

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.94%. Comparing base (5a5abdc) to head (c89d9a5).

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #14822      +/-   ##
==========================================
- Coverage   80.95%   80.94%   -0.02%     
==========================================
  Files        1327     1327              
  Lines      172080   172081       +1     
  Branches     2452     2453       +1     
==========================================
- Hits       139305   139283      -22     
- Misses      32305    32328      +23     
  Partials      470      470              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[stinodego]

Looks good overall, I think it's nice to add support for this.

A nitpick / some general questions.

[alexander-beedie]

I'll fix the Windows test shortly 🤔

Update: done.

[stinodego]

All right, nice! Thanks Alex.