Flow on Helios XL Ingest API

Note

This is a Preview feature.

XL Ingest handles the initial transfer of large tables by breaking them into smaller logical partitions. You can use this API to select and configure tables for slicing, and transfer data from source databases to SingleStore in parallel slices.

Prerequisites

Before using the XL Ingest APIs, ensure that the table to be ingested is selected in Ingest, Skip Initial Extract is enabled for the table, and a full extract has been performed to copy only the schema.

Authentication

All requests must include authentication credentials. Refer to Flow on Helios API Authentication for more information.

Base URL

All XL Ingest API requests must be sent to the following base URL:

https://<flow-endpoint>/ixl

Where <flow-endpoint> corresponds to the endpoint for the Helios Flow instance. It includes the gateway hostname, Helios cell name, /xlingest/ route, and Flow ID. To get the <flow-endpoint>, in the Portal, go to Ingestion > Flow. In the row for your Flow instance, click the three dots on the right, select View Details, and copy the value from Endpoint.

The resulting URL is as follows:

https://gateway.<cellname>.svc.singlestore.com/xlingest/<flowid>/ixl

Example:

https://gateway.aws-virginia-8.svc.singlestore.com/xlingest/b0c51e77-50fd-4d48-92a1-38f50bda9707/ixl

Flow on Helios XL Ingest API Reference

The following endpoints include HTTP methods, required headers, request and response formats, and example requests.

Last modified:

Was this article helpful?