@singlestore/http-client

SingleStore HTTP Client for JavaScript

(@singlestore/http-client)

This API allows you to execute SQL statements against a SingleStore database. It supports all statements that can be run in a direct database connection, and uses conventional data type conversion.

For more information, please visit https://docs.singlestore.com/managed-service/en/reference/http-api.html.

Installation

npm (Node.js)

This client is designed to be deployed using npm. You can use the npm command to automatically install it into your project from the hosted site, as follows:

npm install @singlestore/http-client

Example

This package contains an example.js file that explains how to use the SingleStore HTTP Client for JavaScript. The instructions at the top explain how to run it. Included are a basic example and several extended examples. The basic example will show you how to get started quickly with a few lines of code. The extended examples build on the basic one and illustrate other API calls and usage.

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
SingleStoreClient.HttpApi	exec	POST /api/v1/exec	Exec
SingleStoreClient.HttpApi	ping	GET /ping	Ping
SingleStoreClient.HttpApi	rows	POST /api/v1/query/rows	Query
SingleStoreClient.HttpApi	spec	GET /api/v1/spec	Spec
SingleStoreClient.HttpApi	tuples	POST /api/v1/query/tuples	Query

Models

• SingleStoreClient.Column
• SingleStoreClient.ExecInput
• SingleStoreClient.ExecOutput
• SingleStoreClient.QueryInput
• SingleStoreClient.QueryInputArg
• SingleStoreClient.QueryOutput
• SingleStoreClient.QueryOutputError
• SingleStoreClient.ResultSet
• SingleStoreClient.RowValue
• SingleStoreClient.StreamOutput
• SingleStoreClient.StreamResult

Authorization

BasicAuth

• Type: HTTP basic authentication

Known Issues

The /api/v1/spec endpoint is included in the API, but is not accessible yet in SingleStore, and will return a 404. It will be available soon. In the meantime the OpenAPI 3.0 spec can be downloaded from this repository.

About this package

This JavaScript package was automatically generated by the OpenAPI Generator project, with some custom templating:

• API version: 1.0.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen