EasySQL PHP & Laravel SDK

Official PHP & Laravel SDK for the EasySQL API · A Clearsoft Product

--- Ask questions in natural language to your MySQL, MariaDB, or SQLite databases directly from your PHP applications and Laravel projects. ## Packages This is a multipackage repository. All packages are versioned and released together. | Package | Composer name | Description | |---|---|---| | [`packages/client`](packages/client) | `easysql/client` | 🤖 Generated API client (from the OpenAPI spec) + token-refresh runtime | | [`packages/connectors/mysql`](packages/connectors/mysql) | `easysql/connectors-mysql` | Local MySQL/MariaDB introspection + SELECT execution | | [`packages/connectors/postgres`](packages/connectors/postgres) | `easysql/connectors-postgres` | Local PostgreSQL introspection + SELECT execution | | [`packages/connectors/sqlite`](packages/connectors/sqlite) | `easysql/connectors-sqlite` | Local SQLite introspection + SELECT execution | | [`packages/common`](packages/common) | `easysql/common` | Shared code (SQL safety validation, credential sanitization) | | [`packages/schema-generation`](packages/schema-generation) | `easysql/schema-generation` | Raw introspection → API schema payload (deterministic, no I/O) | | [`packages/laravel`](packages/laravel) | `easysql/laravel` | Laravel service provider, manager and facade | ## Requirements - **PHP** >= 8.2 - **ext-json** - **guzzlehttp/guzzle** ^7.0 (client package) - **ext-pdo_mysql** (mysql connector), **ext-pdo_pgsql** (postgres connector), **ext-pdo_sqlite** (sqlite connector) - *(Optional)* **Laravel** ^11.0 || ^12.0 (for Service Provider and Facade) ## Installation --- ## Laravel Integration The SDK provides first-class support for Laravel with automatic package discovery, configuration publishing, and a dedicated `EasySQL` facade. ### 1. Publish Configuration (Optional) Publish the `easysql.php` configuration file: This creates `config/easysql.php` in your Laravel application. ### 2. Configure Environment Variables Add your credentials to your `.env` file: ### 3. Using the Facade --- ## Standalone PHP Usage ### Typed API Client (Recommended) Use the generated `Client` with typed methods for all endpoints: ### Automatic Token Refresh The typed `Client` supports a token store and refreshes the access token automatically (once) on a 401, persisting the new tokens: For raw Guzzle access, `EasySQLClient` wraps the same token manager: ### Typed DTOs The generated `packages/client/src/Models` classes hydrate an API response array into a typed object: ### Local Connectors + Schema Generation Introspect a local database and push only the schema to the API — credentials never leave the machine: --- ## API Overview | Module | Available Methods | |---|---| | **Auth** | `refresh`, `logout`, `me`, `deleteMe`, `updateMe` | | **Queries** | `createQuery`, `listQueries`, `getQuery`, `answerQuery` | | **Connectors** | `listConnectors`, `createConnector`, `getConnector`, `getConnectorSchema`, `getSuggestions`, `updateConnector`, `deleteConnector`, `syncConnector` | | **Billing** | `getPlan`, `checkout`, `portal` | | **Dashboard** | `dashboardStats` | | **Health** | `health`, `healthHealth` | See [packages/client/docs/API.md](packages/client/docs/API.md) for full endpoint reference and parameters. --- ## Migration from the single-package layout (v1.x) Version 1.x shipped a single package `clearsoft/easysql-sdk` with namespace `Clearsoft\EasySQL\SDK`. The multipackage layout keeps that package as a meta-package (same name, same version line), so `composer require clearsoft/easysql-sdk` keeps working — but the namespaces changed: | Before (v1.x) | After | |---|---| | `Clearsoft\EasySQL\SDK\Client` | `Clearsoft\EasySQL\Api\Client` | | `Clearsoft\EasySQL\SDK\Models\*` | `Clearsoft\EasySQL\Api\Models\*` | | `Clearsoft\EasySQL\SDK\Exceptions\ApiException` | `Clearsoft\EasySQL\Api\Exceptions\ApiException` | | `Clearsoft\EasySQL\SDK\EasySQLClient` | `Clearsoft\EasySQL\Api\Http\EasySQLClient` | | `Clearsoft\EasySQL\SDK\TokenStoreInterface` | `Clearsoft\EasySQL\Api\Http\TokenStoreInterface` | | `Clearsoft\EasySql\Laravel\*` | unchanged (now in `easysql/laravel`) | Connector methods now take their path parameters explicitly (this also fixes a v1.x bug where `getConnector('conn_1')` silently ignored the id and requested a literal `{connector_id}` URL): --- ## Samples Runnable examples for every package live in [`samples/`](samples) — from a basic client call and token refresh to MySQL/PostgreSQL/SQLite introspection + sync and the Laravel integration. See the [samples README](samples/README.md). --- ## Development & Contributing Contributions are welcome! Please read our **[Contributing Guidelines](https://github.com/Clearsoft-net/easysql-php/blob/main/CONTRIBUTING.md)** for details on the development workflow and pull request process. Composer scripts mirror the common ones: `composer test`, `composer analyse`, `composer generate`. --- ## License This project is open source and licensed under the [MIT License](./LICENSE). Maintained by **[Clearsoft](https://clearsoft.net)**.