PHP Class Elastica\AbstractUpdateAction

Author: Nik Everett ([email protected])
Inheritance: extends Param
Show file Open project: ruflin/elastica Class Usage Examples

Protected Properties

Property Type Description
$_upsert Document

Public Methods

Method Description
getConsistency ( ) : string
getFields ( ) : string
getId ( ) : string | integer Returns document id.
getIndex ( ) : string Get the document index name.
getOpType ( ) : string Get operation type.
getOptions ( array $fields = [], boolean $withUnderscore = false ) : array
getParent ( ) : string | integer Returns the parent document id.
getRefresh ( ) : boolean
getReplication ( ) : string
getRetryOnConflict ( ) : integer
getRouting ( ) : string Get routing parameter.
getTimeout ( ) : boolean
getTimestamp ( ) : integer
getTtl ( ) : string
getType ( ) : string Return document type name.
getUpsert ( ) : Document
getVersion ( ) : string | integer Returns document version.
getVersionType ( ) : string | integer Returns document version type.
hasConsistency ( ) : boolean
hasFields ( ) : boolean
hasId ( ) : boolean
hasOpType ( ) : boolean
hasParent ( ) : boolean
hasRefresh ( ) : boolean
hasReplication ( ) : boolean
hasRetryOnConflict ( ) : boolean
hasRouting ( ) : boolean
hasTimeout ( ) : boolean
hasTimestamp ( ) : boolean
hasTtl ( ) : boolean
hasUpsert ( ) : boolean
hasVersion ( ) : boolean
hasVersionType ( ) : boolean
setConsistency ( string $timeout )
setFields ( array | string $fields )
setFieldsSource ( )
setId ( string $id ) Sets the id of the document.
setIndex ( Index | string $index ) Sets the document index name.
setOpType ( string $opType ) Set operation type.
setParent ( string | integer $parent ) Sets parent document id.
setRefresh ( boolean $refresh = true )
setReplication ( string $timeout )
setRetryOnConflict ( integer $num )
setRouting ( string $value ) Set routing query param.
setTimeout ( string $timeout )
setTimestamp ( string $timestamp )
setTtl ( string $ttl ) Sets lifetime of document.
setType ( Type | string $type ) Sets the document type name.
setUpsert ( Document | array $data )
setVersion ( integer $version ) Sets the version of a document for use with optimistic concurrency control.
setVersionType ( string $versionType ) Sets the version_type of a document Default in ES is internal, but you can set to external to use custom versioning.

Method Details

getConsistency() public method

public getConsistency ( ) : string
return string

getFields() public method

public getFields ( ) : string
return string

getId() public method

Returns document id.
public getId ( ) : string | integer
return string | integer Document id

getIndex() public method

Get the document index name.
public getIndex ( ) : string
return string Index name

getOpType() public method

Get operation type.
public getOpType ( ) : string
return string

getOptions() public method

public getOptions ( array $fields = [], boolean $withUnderscore = false ) : array
$fields array if empty array all options will be returned, field names can be either with underscored either without, i.e. _percolate, routing
$withUnderscore boolean should option keys contain underscore prefix
return array

getParent() public method

Returns the parent document id.
public getParent ( ) : string | integer
return string | integer Parent document id

getRefresh() public method

public getRefresh ( ) : boolean
return boolean

getReplication() public method

public getReplication ( ) : string
return string

getRetryOnConflict() public method

public getRetryOnConflict ( ) : integer
return integer

getRouting() public method

Get routing parameter.
public getRouting ( ) : string
return string

getTimeout() public method

public getTimeout ( ) : boolean
return boolean

getTimestamp() public method

public getTimestamp ( ) : integer
return integer

getTtl() public method

public getTtl ( ) : string
return string

getType() public method

Return document type name.
public getType ( ) : string
return string Document type name

getUpsert() public method

public getUpsert ( ) : Document
return Document

getVersion() public method

Returns document version.
public getVersion ( ) : string | integer
return string | integer Document version

getVersionType() public method

Returns document version type.
public getVersionType ( ) : string | integer
return string | integer Document version type

hasConsistency() public method

public hasConsistency ( ) : boolean
return boolean

hasFields() public method

public hasFields ( ) : boolean
return boolean

hasId() public method

public hasId ( ) : boolean
return boolean

hasOpType() public method

public hasOpType ( ) : boolean
return boolean

hasParent() public method

public hasParent ( ) : boolean
return boolean

hasRefresh() public method

public hasRefresh ( ) : boolean
return boolean

hasReplication() public method

public hasReplication ( ) : boolean
return boolean

hasRetryOnConflict() public method

public hasRetryOnConflict ( ) : boolean
return boolean

hasRouting() public method

public hasRouting ( ) : boolean
return boolean

hasTimeout() public method

public hasTimeout ( ) : boolean
return boolean

hasTimestamp() public method

public hasTimestamp ( ) : boolean
return boolean

hasTtl() public method

public hasTtl ( ) : boolean
return boolean

hasUpsert() public method

public hasUpsert ( ) : boolean
return boolean

hasVersion() public method

public hasVersion ( ) : boolean
return boolean

hasVersionType() public method

public hasVersionType ( ) : boolean
return boolean

setConsistency() public method

public setConsistency ( string $timeout )
$timeout string

setFields() public method

public setFields ( array | string $fields )
$fields array | string

setFieldsSource() public method

public setFieldsSource ( )

setId() public method

Sets the id of the document.
public setId ( string $id )
$id string

setIndex() public method

Sets the document index name.
public setIndex ( Index | string $index )
$index Index | string Index name

setOpType() public method

Set operation type.
public setOpType ( string $opType )
$opType string Only accept create

setParent() public method

Sets parent document id.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-parent-field.html
public setParent ( string | integer $parent )
$parent string | integer Parent document id

setRefresh() public method

public setRefresh ( boolean $refresh = true )
$refresh boolean

setReplication() public method

public setReplication ( string $timeout )
$timeout string

setRetryOnConflict() public method

public setRetryOnConflict ( integer $num )
$num integer

setRouting() public method

Set routing query param.
public setRouting ( string $value )
$value string routing

setTimeout() public method

public setTimeout ( string $timeout )
$timeout string

setTimestamp() public method

public setTimestamp ( string $timestamp )
$timestamp string

setTtl() public method

Sets lifetime of document.
public setTtl ( string $ttl )
$ttl string

setType() public method

Sets the document type name.
public setType ( Type | string $type )
$type Type | string Type name

setUpsert() public method

public setUpsert ( Document | array $data )
$data Document | array

setVersion() public method

Sets the version of a document for use with optimistic concurrency control.
See link: https://www.elastic.co/blog/versioning
public setVersion ( integer $version )
$version integer Document version

setVersionType() public method

Sets the version_type of a document Default in ES is internal, but you can set to external to use custom versioning.
public setVersionType ( string $versionType )
$versionType string Document version type

Property Details

$_upsert protected property

protected Document,Elastica $_upsert
return Document