Skip to content

Commit 876646d

Browse files
authored
docs: clarify DataFusion 52 FFI session-parameter requirement for provider hooks (#1439)
* mention new session arg * flow better * smaller change
1 parent e09c93b commit 876646d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/source/user-guide/upgrade-guides.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,10 @@ parameter, which is a Python object that can be used to extract the
5252
``FFI_LogicalExtensionCodec`` that is necessary.
5353

5454
A complete example can be found in the `FFI example <https://github.com/apache/datafusion-python/tree/main/examples/datafusion-ffi-example>`_.
55-
Your methods need to be updated to take an additional parameter like in this
56-
example.
55+
Your FFI hook methods — ``__datafusion_catalog_provider__``,
56+
``__datafusion_schema_provider__``, ``__datafusion_table_provider__``, and
57+
``__datafusion_table_function__`` — need to be updated to accept an additional
58+
``session: Bound<PyAny>`` parameter, as shown in this example.
5759

5860
.. code-block:: rust
5961

0 commit comments

Comments
 (0)