PHP 클래스 Sleimanx2\Plastic\Connection

파일 보기 프로젝트 열기: sleimanx2/plastic 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$elastic Elasticsearch\Client Elasticsearch client instance.
$index string Elastic Search default index.

공개 메소드들

메소드 설명
__construct ( array $config = [] ) Connection constructor.
bulkStatement ( array $params ) : array Execute a bulk statement on index;.
deleteStatement ( array $params ) : array Execute a update statement on index;.
existsStatement ( array $params ) : array | boolean Execute a exists statement on index.
getClient ( ) : Elasticsearch\Client Get the elastic search client instance.
getDSLQuery ( ) : DSLGrammar Get DSL grammar instance for this connection.
getDefaultIndex ( ) : string Get the default elastic index.
getMapBuilder ( ) : Builder Get map builder instance for this connection.
getMapGrammar ( ) : Builder Get map grammar instance for this connection.
indexStatement ( array $params ) : array Execute a insert statement on index;.
mapStatement ( array $mappings ) : array Execute a map statement on index;.
persist ( ) : EloquentPersistence Create a new elastic persistence handler.
search ( ) : SearchBuilder Begin a fluent search query builder.
searchStatement ( array $search ) : array Execute a map statement on index;.
setClient ( Elasticsearch\Client $client ) Set a custom elastic client.
setDefaultIndex ( $index ) : Connection Set the default index.
suggest ( ) : SuggestionBuilder Begin a fluent suggest query builder.
suggestStatement ( array $suggestions ) : array Execute a map statement on index;.
updateStatement ( array $params ) : array Execute a update statement on index;.

비공개 메소드들

메소드 설명
buildClient ( array $config ) : Elasticsearch\Client Create an elastic search instance.
setStatementIndex ( array $params ) : array

메소드 상세

__construct() 공개 메소드

Connection constructor.
public __construct ( array $config = [] )
$config array

bulkStatement() 공개 메소드

Execute a bulk statement on index;.
public bulkStatement ( array $params ) : array
$params array
리턴 array

deleteStatement() 공개 메소드

Execute a update statement on index;.
public deleteStatement ( array $params ) : array
$params array
리턴 array

existsStatement() 공개 메소드

Execute a exists statement on index.
public existsStatement ( array $params ) : array | boolean
$params array
리턴 array | boolean

getClient() 공개 메소드

Get the elastic search client instance.
public getClient ( ) : Elasticsearch\Client
리턴 Elasticsearch\Client

getDSLQuery() 공개 메소드

Get DSL grammar instance for this connection.
public getDSLQuery ( ) : DSLGrammar
리턴 DSLGrammar

getDefaultIndex() 공개 메소드

Get the default elastic index.
public getDefaultIndex ( ) : string
리턴 string

getMapBuilder() 공개 메소드

Get map builder instance for this connection.
public getMapBuilder ( ) : Builder
리턴 Sleimanx2\Plastic\Map\Builder

getMapGrammar() 공개 메소드

Get map grammar instance for this connection.
public getMapGrammar ( ) : Builder
리턴 Sleimanx2\Plastic\Map\Builder

indexStatement() 공개 메소드

Execute a insert statement on index;.
public indexStatement ( array $params ) : array
$params array
리턴 array

mapStatement() 공개 메소드

Execute a map statement on index;.
public mapStatement ( array $mappings ) : array
$mappings array
리턴 array

persist() 공개 메소드

Create a new elastic persistence handler.
public persist ( ) : EloquentPersistence
리턴 Sleimanx2\Plastic\Persistence\EloquentPersistence

searchStatement() 공개 메소드

Execute a map statement on index;.
public searchStatement ( array $search ) : array
$search array
리턴 array

setClient() 공개 메소드

Set a custom elastic client.
public setClient ( Elasticsearch\Client $client )
$client Elasticsearch\Client

setDefaultIndex() 공개 메소드

Set the default index.
public setDefaultIndex ( $index ) : Connection
$index
리턴 Connection

suggest() 공개 메소드

Begin a fluent suggest query builder.
public suggest ( ) : SuggestionBuilder
리턴 Sleimanx2\Plastic\DSL\SuggestionBuilder

suggestStatement() 공개 메소드

Execute a map statement on index;.
public suggestStatement ( array $suggestions ) : array
$suggestions array
리턴 array

updateStatement() 공개 메소드

Execute a update statement on index;.
public updateStatement ( array $params ) : array
$params array
리턴 array

프로퍼티 상세

$elastic 보호되어 있는 프로퍼티

Elasticsearch client instance.
protected Client,Elasticsearch $elastic
리턴 Elasticsearch\Client

$index 보호되어 있는 프로퍼티

Elastic Search default index.
protected string $index
리턴 string