elasticsearch

KO | EN

gitlite — search

#typescript #llm #golang #android #machine-learning #rust #deep-learning #linux #docker #java #cli #vue #ios #mcp

(★ 102)

Use SQL statements to query elasticsearch

elasticsearch Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Crcms Elasticsearch

[![Latest Stable Version](https://poser.pugx.org/crcms/elasticsearch/v/stable)](https://packagist.org/packages/crcms/elasticsearch)
[![License](https://poser.pugx.org/crcms/elasticsearch/license)](https://packagist.org/packages/crcms/elasticsearch)
[![StyleCI](https://github.styleci.io/repos/100927763/shield?branch=master)](https://github.styleci.io/repos/100927763)

## Version Matrix

| Elasticsearch Version | crcms/elasticsearch Branch |
| --------------------- | ------------------------ |
| >= 7.0                | master(beta unstable)                      |
| >= 6.0                | 1.*                      |
| >= 5.0, < 6.0         | 0.*                      |

## Install

You can install the package via composer:

```
composer require crcms/elasticsearch
```

> Please install if you want to use the latest version `dev-master`

## Use

### Non-Laravel framework

```php
// select config path
$config = require 'search.php';
$builder = Factory::builder($config);
```

### Laravel

Modify `config / app.php` If the version is less <= 5.5
```
'providers' => [
    CrCms\ElasticSearch\LaravelServiceProvider::class,
]

```

If you'd like to make configuration changes in the configuration file you can pubish it with the following Aritsan command:
```
php artisan vendor:publish --provider="CrCms\ElasticSearch\LaravelServiceProvider"
```

## Quickstart

### Create

```php
$builder->index('index')->type('type')->create([
    'key' => 'value'
]);

// return a collection
$builder->index('index')->type('type')->createCollection([
    'key' => 'value'
]);
```

### Update

```php
$builder->index('index')->type('type')->update([
    'key' => 'value1'
]);

```

### Delete

```php
$builder->index('index')->type('type')->delete($result->_id);
```

### Select

```php

$builder = $builder->index('index')->type('type');
	
//SQL:select ... where id = 1 limit 1;
$result = $builder->whereTerm('id',1)->first();

//SQL:select ... where (key=1 or key=2) and key1=1
$result = $builder->where(function (Query $inQuery) {
    $inQuery->whereTerm('key',1)->orWhereTerm('key',2)
})->whereTerm('key1',1)->get();

```

### More

skip / take
```php
$builder->take(10)->get(); // or limit(10)
$builder->offset(10)->take(10)->get(); // or skip(10)
```

term query
```php
$builder->whereTerm('key',value)->first();
```

match query
```php
$builder->whereMatch('key',value)->first();
```

range query
```php
$builder->whereBetween('key',[value1,value2])->first();
```

where in query
```php
$builder->whereIn('key',[value1,value2])->first();
```

logic query
```php
$builder->whereTerm('key',value)->orWhereTerm('key2',value)->first();
```

nested query
```php
$result = $builder->where(function (Builder $inQuery) {
    $inQuery->whereTerm('key',1)->orWhereTerm('key',2)
})->whereTerm('key1',1)->get();
```

### Available conditions

```php
public function select($columns): self
```

```php
public function where($column, $operator = null, $value = null, $leaf = 'term', $boolean = 'and'): self
```

```php
public function orWhere($field, $operator = null, $value = null, $leaf = 'term'): self
```

```php
public function whereMatch($field, $value, $boolean = 'and'): self
```

```php
public function orWhereMatch($field, $value, $boolean = 'and'): self
```

```php
public function whereTerm($field, $value, $boolean = 'and'): self
```

```php
public function whereIn($field, array $value)
```

```php
public function orWhereIn($field, array $value)
```

```php
public function orWhereTerm($field, $value, $boolean = 'or'): self
```

```php
public function whereRange($field, $operator = null, $value = null, $boolean = 'and'): self
```

```php
public function orWhereRange($field, $operator = null, $value = null): self
```

```php
public function whereBetween($field, array $values, $boolean = 'and'): self
```
```php
public function whereNotBetween($field, array $values): self
```
```php
public function orWhereNotBetween(string $field, array $values): self
```
```php
public function whereExists($field, $boolean = 'and'): self
```
```php
public function whereNotExists($field, $boolean = 'and'): self
```

```php
public function orWhereBetween($field, array $values): self
```

```php
public function orderBy(string $field, $sort): self
```

```php
public function scroll(string $scroll): self
```

```php
public function aggBy($field, $type): self
```

```php
public function select($columns): self
```

### Result Method
```php
public function get(): Collection
```

```php
public function paginate(int $page, int $perPage = 15): Collection
```

```php
public function first()
```

```php
public function byId($id)
```

```php
public function byIdOrFail($id): stdClass
```

```php
public function chunk(callable $callback, $limit = 2000, $scroll = '10m')
```

```php
public function create(array $data, $id = null, $key = 'id'): stdClass
```

```php
public function update($id, array $data): bool
```

```php
public function delete($id)
```

```php
public function count(): int
```

### Log

```php
//open log
$builder->enableQueryLog();

//all query log
dump($build->getQueryLog());

//last query log
dump($build->getLastQueryLog());
```

### Elastisearch object

```php
getElasticSearch() // or search()
```

> If you want to expand more, you can use this method, call https://github.com/elastic/elasticsearch-php

## Other
For more examples, please see test cases
https://github.com/crcms/elasticsearch/blob/master/tests/BuildTest.php
## License
[MIT license](https://opensource.org/licenses/MIT)

elasticsearch

elasticsearch Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

elasticsearch

elasticsearch Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README