README

(singlestore/http-client)

Attention: The code in this repository is intended for experimental use only and is not fully tested, documented, or supported by SingleStore. Visit the SingleStore Forums to ask questions about this repository.

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

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

Composer

This client is designed to be deployed using Composer. Since it is hosted at Packagist, you can use the composer command to automatically install it into your project as follows:

composer require singlestore/http-client

Alternatively, you can add the binding manually by editing your project's composer.json file:

{
  "require": {
    "singlestore/http-client": "^2.0"
  }
}

Then run composer update followed by composer install.

ZIP File

If you do not want to use Composer, you can also generate and download the package in a ZIP file using the php-download.com website. Here is a link to the SingleStore HTTP Client.

Example

This package contains an example.php file that explains how to use the SingleStore HTTP Client for PHP. 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
HttpApi	exec	POST /api/v2/exec	Exec
HttpApi	ping	GET /ping	Ping
HttpApi	rows	POST /api/v2/query/rows	Query
HttpApi	spec	GET /api/v2/spec	Spec
HttpApi	tuples	POST /api/v2/query/tuples	Query

Models

Authorization

BasicAuth

Type: HTTP basic authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

About this package

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

API version: 2.0.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

singlestore / http-client

Maintainers

Details