arrakis-schema 0.1.0

Schemas for the Arrakis API

arrakis-schema

Schemas for the Arrakis API

---

Endpoints

The Arrakis server responds to API requests corresponding to the four main actions exposed by the client API:

• stream
• describe
• find
• count

as well as two actions which aid in publication:

• partition
• publish

All API requests are done in a two-stage approach by first sending an Arrow Flight descriptor to the server, returning back a Flight info object which contains the request and the server to contact, contained within a Flight ticket. This ticket is then sent to receive back the expected payload with a specific Arrow flight schema dependent on the request, serialized in the Arrow .

The Flight descriptors sent to the server in the first stage are all specified here as JSON packets which are UTF-8-encoded, using the command variant of the Flight descriptor, which can be used to specify any application-specific command.

Schemas

The generic Flight descriptor schema is described within each endpoint in {endpoint}.json. In addition, a generic descriptor specification for all endpoints is described in descriptor.json.

Usage

from arrakis_schema import load_schema

schema = load_schema("count.json")