Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darkterminal/turso-client-http
The PHP library for Turso over HTTP
https://github.com/darkterminal/turso-client-http
codeigniter laravel libsql libsqlite3 php sqlite sqlite3 turso
Last synced: 3 days ago
JSON representation
The PHP library for Turso over HTTP
- Host: GitHub
- URL: https://github.com/darkterminal/turso-client-http
- Owner: darkterminal
- License: mit
- Created: 2024-01-21T10:01:22.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-09-07T14:37:10.000Z (4 months ago)
- Last Synced: 2024-12-15T12:18:05.085Z (13 days ago)
- Topics: codeigniter, laravel, libsql, libsqlite3, php, sqlite, sqlite3, turso
- Language: PHP
- Homepage:
- Size: 521 KB
- Stars: 44
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
The `TursoHTTP` library is a PHP wrapper for Turso HTTP Database API (Only). It simplifies interaction with Turso databases using the Hrana over HTTP protocol. This library provides an object-oriented approach to build and execute SQL queries with same API Interface like PHP Native Extension [Turso Client PHP](https://github.com/tursodatabase/turso-client-php).
---
## Requirements
- Intention and Courage
- Instinct as a Software Freestyle Engineer
- Strong determination!
- [Turso](https://tur.so/dt) Account
- Don't forget to install [PHP](https://php.net) on your machine
- A cup of coffee and the music you hate the most
- Dancing (optional: if you are willing)
## Features
- **[libSQL Native Extension](https://github.com/tursodatabase/turso-client-php)** like API Interface
- Schema Builder
- Query Builder
- Turso Platform API
- Timezone Support
## Installation
You can install the **TursoHTTP** library using Composer:
```bash
composer require darkterminal/turso-client-http
```
## Environment Variables
| Variable Name | Value | Description |
| ----------------------------------------- | ---------------------------------- | ----------------------------------------------------------------------------- |
| `DB_URL` or `TURSO_URL` | Your Turso database URL | - |
| `DB_TOKEN` or `TURSO_TOKEN` | Your Turso database TOKEN | - |
| `DB_TIMEZONE` or `TURSO_TIMEZONE` | `Asia/Jakarta` | See the list of timezones [here](https://www.php.net/manual/en/timezones.php) |
| `DB_STRICT_QUERY` or `TURSO_STRICT_QUERY` | `true` / default: `false` | Use strict query when using `explain` method in Query Builder |
| `DB_LOG_DEBUG` or `TURSO_LOG_DEBUG` | `true` / default: `false` | Set Query logs to save all query activities into a log file |
| `DB_LOG_NAME` or `TURSO_LOG_NAME` | `libsql_debug` | Set Query channel name |
| `DB_LOG_PATH` or `TURSO_LOG_PATH` | `$HOME/.turso-http/logs/debug.log` | Log file location |
## Usage Example
```php
use Darkterminal\TursoHttp\LibSQL;
require_once 'vendor/autoload.php';
$dbname = getenv('DB_URL');
$authToken = getenv('DB_TOKEN');
$db = new LibSQL("dbname=$dbname&authToken=$authToken");
echo $db->version() . PHP_EOL;
$create_table = <<execute($create_table);
```
## LibSQL Schema Builder
```php
create('contacts', function(LibSQLBlueprint $table) {
$table->increments('id');
$table->string('name');
$table->unique('email');
$table->string('phone');
$table->timestamps();
})->execute();
echo "Table created successfully.\n";
// Add new column in the table
$schemaBuilder->table('contacts', function(LibSQLBlueprint $table) {
$table->addColumn(DataType::TEXT, 'address');
})->execute();
echo "Column added successfully.\n";
// Drop the table
$schemaBuilder->drop('contacts')->execute();
echo "Table contacts successfully dropped!.\n";
} catch (Exception $e) {
echo "An error occurred: " . $e->getMessage();
}
```
## Raw Query
```php
execute($query, [
'Imam Ali Mustofa',
'[email protected]',
'08123456789',
'Punk Univers'
]);
```
## Query Builder
```php
table('contacts')
->where('address', '=', 'Punk Universe')
->get();
var_dump($contacts);
```
## License
This library is licensed under the MIT License - see the [LICENSE](https://github.com/darkterminal/turso-http/blob/main/LICENSE) file for details.