On this page
SingleStore provides the Data API to execute SQL statements against your database over an HTTP connection.
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 supports all SQL statements that can be run in a direct database connection with SingleStoreDB.
The Data API can support concurrent connections up to the value of the
http_ engine variable.
max_ engine variable is less than the value of
http_, then the number of supported concurrent requests is limited to the value of
max_ and the
http_ engine variables for your cluster.
SingleStore does not recommend updating or managing session-related entities using the Data API, for example, temporary tables, session variables, etc.
-- Obtain the connection ID for the temporary table --SHOW TEMPORARY TABLES;-- Use the connection ID to kill the connection --KILL CONNECTION <conn_ID>;
Is this a REST API?
No, the Data API is a JSON-based SQL API.
Is there a limit on the request body size?
The request body size must not exceed 1MB.
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?
The Data API can process up to 192 requests in parallel per aggregator, which is the default value of the
connection_ threads To support additional requests, you can increase the values of both the
http_engine variables up to the maximum values supported by the database engine.
api_ pool_ capacity
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.
In this section
Last modified: August 3, 2023