Data API
SingleStore provides the Data API to execute SQL statements against your database over an HTTP connection. The Data API can be used to integrate SingleStore with serverless architecture, develop custom applications, and build seamless integrations with applications.
SingleStore's Data API is authenticated to the server using the HTTP Basic Authentication standard, which must be used in conjunction with SSL (HTTPS) for secure communication over the network. The Data API uses standard HTTP methods and response codes and supports URI versioning. It also uses JSON-encoded responses with support for conventional data type conversions. The Data API is accessible via a built-in HTTP server. It can be easily enabled or disabled using engine variables.
The Data API supports all SQL statements that can be run in a direct database connection with SingleStoreDB. To learn about the Data API endpoints supported, refer to Data API Endpoint Reference.
FAQs
Is this a REST API?
No, the Data API is a JSON-based SQL API.
Is there a limit on the response size?
The response is streamed not buffered. There are no limits explicitly set on the response size.
How many concurrent requests are supported by the Data API?
By default, the Data API can process upto 2048 queries in parallel per aggregator. You can increase this value upto the maximum amount supported by the engine.
Does it support API pagination?
By itself, the Data API does not implement any logic to handle pagination. However, users can build pagination into the queries they send to the API.