SMW\Elastic\Connection\Client Class Reference

Public Member Functions
	__construct (ElasticClient $client, LockManager $lockManager, Config $options=null)
	getConfig ()
	clear ()
	getIndexNameByType ( $type)
	getIndexName ( $type)
	getIndexDefByType ( $type)
	getIndexDefFileModificationTimeByType ( $type)
	getVersion ()
	getSoftwareInfo ()
	info ()
	stats ( $type='indices', $params=[])
	cat ( $type, $params=[])
	indices ()
	ingest ()
	hasIndex ( $type)
	createIndex ( $type)
	deleteIndex ( $type)
	putSettings (array $params)
	putMapping (array $params)
	getMapping (array $params)
	getSettings (array $params)
	refresh (array $params)
	validate (array $params)
	ping ()
	quick_ping ( $timeout=2)
	exists (array $params)
	get (array $params)
	delete (array $params)
	update (array $params)
	index (array $params)
	bulk (array $params)
	count (array $params)
	search (array $params)
	explain (array $params)
	hasMaintenanceLock ()
	setMaintenanceLock ()
	setLock ( $type, $version)
	hasLock ( $type)
	getLock ( $type)
	releaseLock ( $type)

Public Attributes
const	TYPE_DATA = 'data'
const	TYPE_LOOKUP = 'lookup'

Detailed Description

Reduced interface to the Elasticsearch client class.

GNU GPL v2+

Since

3.0

Author

mwjames

Constructor & Destructor Documentation

__construct()

SMW\Elastic\Connection\Client::__construct	(	ElasticClient	$client,
		LockManager	$lockManager,
		Config	$options = null
	)

Since

3.0

Parameters

ElasticClient	$client
LockManager	$lockManager
Options | null	$options

Member Function Documentation

bulk()

SMW\Elastic\Connection\Client::bulk

(

array

$params

)

See also

Client::index

Since

3.0

Parameters

array

$params

cat()

SMW\Elastic\Connection\Client::cat	(		$type,
			$params = []
	)

Since

3.0

Parameters

array

clear()

SMW\Elastic\Connection\Client::clear

(

)

Since

3.0

count()

SMW\Elastic\Connection\Client::count

(

array

$params

)

See also

https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html

Client::count

Since

3.0

Parameters

array

$params

Returns

mixed

createIndex()

SMW\Elastic\Connection\Client::createIndex

(

$type

)

Since

3.0

Parameters

string

$type

delete()

SMW\Elastic\Connection\Client::delete

(

array

$params

)

See also

Client::delete

Since

3.0

Parameters

array

$params

Returns

mixed

deleteIndex()

SMW\Elastic\Connection\Client::deleteIndex

(

$type

)

Since

3.0

Parameters

string

$type

exists()

SMW\Elastic\Connection\Client::exists

(

array

$params

)

See also

Client::exists

Since

3.0

Parameters

array

$params

Returns

boolean

explain()

SMW\Elastic\Connection\Client::explain

(

array

$params

)

See also

Client::explain

Since

3.0

Parameters

array

$params

Returns

mixed

get()

SMW\Elastic\Connection\Client::get

(

array

$params

)

See also

Client::get

Since

3.0

Parameters

array

$params

Returns

mixed

getConfig()

SMW\Elastic\Connection\Client::getConfig

(

)

Since

3.0

Returns

Options

getIndexDefByType()

SMW\Elastic\Connection\Client::getIndexDefByType

(

$type

)

Since

3.0

Parameters

string

$type

Returns

string

getIndexDefFileModificationTimeByType()

SMW\Elastic\Connection\Client::getIndexDefFileModificationTimeByType

(

$type

)

Since

3.0

Returns

integer

getIndexName()

SMW\Elastic\Connection\Client::getIndexName

(

$type

)

Since

3.0

Parameters

string

$type

Returns

string

getIndexNameByType()

SMW\Elastic\Connection\Client::getIndexNameByType

(

$type

)

Since

3.0

Parameters

string

$type

Returns

string

getLock()

SMW\Elastic\Connection\Client::getLock

(

$type

)

Since

3.0

Parameters

string

$type

Returns

mixed

getMapping()

SMW\Elastic\Connection\Client::getMapping

(

array

$params

)

Since

3.0

Parameters

array

$params

getSettings()

SMW\Elastic\Connection\Client::getSettings

(

array

$params

)

Since

3.0

Parameters

array

$params

getSoftwareInfo()

SMW\Elastic\Connection\Client::getSoftwareInfo

(

)

Since

3.0

Returns

[]

getVersion()

SMW\Elastic\Connection\Client::getVersion

(

)

Since

3.0

Returns

integer

hasIndex()

SMW\Elastic\Connection\Client::hasIndex

(

$type

)

Since

3.0

Parameters

string	$type
	boolean

hasLock()

SMW\Elastic\Connection\Client::hasLock

(

$type

)

Since

3.0

Parameters

string

$type

Returns

boolean

hasMaintenanceLock()

SMW\Elastic\Connection\Client::hasMaintenanceLock

(

)

Since

3.1

Returns

boolean

index()

SMW\Elastic\Connection\Client::index

(

array

$params

)

See also

Client::index

Since

3.0

Parameters

array

$params

Returns

mixed

indices()

SMW\Elastic\Connection\Client::indices

(

)

Since

3.0

Returns

Indices

info()

SMW\Elastic\Connection\Client::info

(

)

Since

3.0

Parameters

array

ingest()

SMW\Elastic\Connection\Client::ingest

(

)

Since

3.0

Returns

Ingest

ping()

SMW\Elastic\Connection\Client::ping

(

)

See also

Client::ping

Since

3.0

Returns

boolean

putMapping()

SMW\Elastic\Connection\Client::putMapping

(

array

$params

)

Since

3.0

Parameters

array

$params

putSettings()

SMW\Elastic\Connection\Client::putSettings

(

array

$params

)

Since

3.0

Parameters

array

$params

quick_ping()

SMW\Elastic\Connection\Client::quick_ping

(

$timeout = 2

)

Check is faster than the standard Client::ping

Since

3.0

Returns

boolean

refresh()

SMW\Elastic\Connection\Client::refresh

(

array

$params

)

Since

3.0

Parameters

array

$params

releaseLock()

SMW\Elastic\Connection\Client::releaseLock

(

$type

)

Since

3.0

Parameters

string

$type

search()

SMW\Elastic\Connection\Client::search

(

array

$params

)

See also

Client::search

Since

3.0

Parameters

array

$params

Returns

array

setLock()

SMW\Elastic\Connection\Client::setLock	(		$type,
			$version
	)

Since

3.0

Parameters

string	$type
string	$version

setMaintenanceLock()

SMW\Elastic\Connection\Client::setMaintenanceLock

(

)

Since

3.1

stats()

SMW\Elastic\Connection\Client::stats	(		$type = 'indices',
			$params = []
	)

Since

3.0

Parameters

array

update()

SMW\Elastic\Connection\Client::update

(

array

$params

)

See also

Client::update

Since

3.0

Parameters

array

$params

Returns

mixed

validate()

SMW\Elastic\Connection\Client::validate

(

array

$params

)

Since

3.0

Parameters

array

$params

Member Data Documentation

TYPE_DATA

const SMW\Elastic\Connection\Client::TYPE_DATA = 'data'

See also

https://www.elastic.co/blog/index-vs-type

https://www.elastic.co/guide/en/elasticsearch/reference/master/removal-of-types.html

" ... Indices created in Elasticsearch 6.0.0 or later may only contain a single mapping type ..."

TYPE_LOOKUP

const SMW\Elastic\Connection\Client::TYPE_LOOKUP = 'lookup'

Index, type to temporary store index lookups during the execution of subqueries.

---

The documentation for this class was generated from the following file:

• Client.php