Skip to content

Commit

Permalink
Add requirements for Thrift connector
Browse files Browse the repository at this point in the history
  • Loading branch information
Jessie212 authored and hashhar committed Jul 9, 2021
1 parent 7854abc commit d706dac
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/src/main/sphinx/connector/thrift.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Thrift connector

The Thrift connector makes it possible to integrate with external storage systems
without a custom Trino connector implementation by using
`Apache Thrift <https://thrift.apache.org/>`_ on these servers. It is therefore generic and can provide access any backend, as long as it exposes the expected API by using Thrift.
`Apache Thrift <https://thrift.apache.org/>`_ on these servers. It is therefore
generic and can provide access to any backend, as long as it exposes the expected
API by using Thrift.

In order to use the Thrift connector with an external system, you need to implement
the ``TrinoThriftService`` interface, found below. Next, you configure the Thrift connector
Expand All @@ -14,6 +16,14 @@ splits and data. The connector randomly chooses a server to talk to from the ava
instances for metadata calls, or for data calls unless the splits include a list of addresses.
All requests are assumed to be idempotent and can be retried freely among any server.

Requirements
------------

To connect to your custom servers with the Thrift protocol, you need:

* Network access from the Trino coordinator and workers to the Thrift servers.
* A :ref:`trino-thrift-service` for your system.

Configuration
-------------

Expand Down Expand Up @@ -84,8 +94,10 @@ Number of refresh threads for metadata cache.

This property is optional; the default is ``1``.

Thrift IDL file
---------------
.. _trino-thrift-service:

TrinoThriftService implementation
---------------------------------

The following IDL describes the ``TrinoThriftService`` that must be implemented:

Expand Down

0 comments on commit d706dac

Please sign in to comment.