https://github.com/reedtechus/azure-data-explorer-laravel
Azure Data Explorer SDK for Laravel
https://github.com/reedtechus/azure-data-explorer-laravel
azure data-explorer kusto laravel php
Last synced: 5 months ago
JSON representation
Azure Data Explorer SDK for Laravel
- Host: GitHub
- URL: https://github.com/reedtechus/azure-data-explorer-laravel
- Owner: reedtechus
- License: mit
- Created: 2022-11-07T19:29:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-09T20:14:13.000Z (over 2 years ago)
- Last Synced: 2025-07-13T09:49:01.621Z (11 months ago)
- Topics: azure, data-explorer, kusto, laravel, php
- Language: PHP
- Homepage:
- Size: 46.9 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Azure Data Explorer SDK for Laravel
[](https://packagist.org/packages/reedtechus/azure-data-explorer-laravel)
[](https://github.com/reedtechus/azure-data-explorer-laravel/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/reedtechus/azure-data-explorer-laravel/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/reedtechus/azure-data-explorer-laravel)
This project is a Laravel package that allows you to connect to Azure Data Explorer and execute queries from your Laravel Application.
> :warning: **Experimental:** This package is still in development and is not ready for production use.
> Breaking changes can still occur **without** a major version change until **1.0.0**.
This package is a direct extension of the [Azure Data Explorer SDK for PHP](https://github.com/reedtechus/azure-data-explorer) by [Reed Tech](https://github.com/reedtechus) which provides a PHP SDK to interact with the [Azure Data Explorer REST API](https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/).
## Goals
The goal of this project is to provide a Laravel friendly interface to the [Azure Data Explorer SDK](https://github.com/reedtechus/azure-data-explorer) package.
**Feature Roadmap**
- [ ] Caching via Redis
## Installation
You can install the package via composer:
```bash
composer require reedtechus/azure-data-explorer-laravel
```
The following environment variables are **required** for this package to work:
```dotenv
# Azure Data Explorer
AZURE_DATA_EXPLORER_TENANT_ID="TENANT_ID"
AZURE_DATA_EXPLORER_CLIENT_ID="CLIENT_ID"
AZURE_DATA_EXPLORER_CLIENT_SECRET="SECRET"
AZURE_DATA_EXPLORER_CLUSTER="CLUSTER"
AZURE_DATA_EXPLORER_REGION="REGION"
AZURE_DATA_EXPLORER_DATABASE="DATABASE_NAME"
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="azure-data-explorer-laravel-config"
```
This is the contents of the published config file:
```php
return [
/*
|--------------------------------------------------------------------------
| Azure Data Explorer
|--------------------------------------------------------------------------
|
| This is the configuration for the Azure Data Explorer package.
|
*/
// The base URL of the Azure Data Explorer API.
'base_url' => env('AZURE_DATA_EXPLORER_BASE_URL', 'https://login.microsoftonline.com'),
// The tenant ID of the Azure Data Explorer API.
'tenant_id' => env('AZURE_DATA_EXPLORER_TENANT_ID'),
// The client ID of the Azure Data Explorer API.
'client_id' => env('AZURE_DATA_EXPLORER_CLIENT_ID'),
// The client secret of the Azure Data Explorer API.
'client_secret' => env('AZURE_DATA_EXPLORER_CLIENT_SECRET'),
// The cache driver to use for caching responses.
'cache_driver' => env('AZURE_DATA_EXPLORER_CACHE_DRIVER', 'redis'),
// The cache TTL to use for caching responses.
'cache_ttl' => env('AZURE_DATA_EXPLORER_CACHE_TTL', 3500),
// The cluster of the Azure Data Explorer API.
'cluster' => env('AZURE_DATA_EXPLORER_CLUSTER'),
// The region of the Azure Data Explorer API.
'region' => env('AZURE_DATA_EXPLORER_REGION'),
// The database of the Azure Data Explorer API.
'database' => env('AZURE_DATA_EXPLORER_DATABASE'),
];
```
## Usage
```php
// Option A: More efficient to save and re-use the AzureDataExplorer class instance for followup queries
$de = new AzureDataExplorer();
$results = $de->query($query);
// Option B: you can use the AzureDataExplorer::queryOnce() method to perform the query
$results = AzureDataExplorer::queryOnce($query);
```
These calls return a `QueryResultsDTO` object (or throw an exception).
**Using the results**
```php
dump('Columns: '.implode(', ', $results->columns));
dump('Number of Results: '.count($results->data));
dump('Execution Time: '.$results->executionTime);
dump('First Row: '.print_r($results->data[0], true));
```
## Testing
```bash
composer test
```
## Dependencies
- [Azure Data Explorer REST API](https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/)
- [Reed Tech's](https://github.com/reedtechus/azure-data-explorer) package, [Azure Data Explorer PHP SDK](https://github.com/reedtechus/azure-data-explorer)
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Chris Reed](https://github.com/chrisreedio)
- [All Contributors](../../contributors)
This package is not endorsed nor supported by [Microsoft](https://github.com/microsoft) in any way.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.