PHP 인터페이스 Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface

저자: Aurelien FOUCRET ([email protected])
파일 보기 프로젝트 열기: smile-sa/elasticsuite 0 사용 예제들

공개 메소드들

메소드 설명
addDocument ( Smile\ElasticsuiteCore\Api\Index\IndexInterface $index, Smile\ElasticsuiteCore\Api\Index\TypeInterface $type, string | integer $docId, array $data ) : Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface Add a single document to the index.
addDocuments ( Smile\ElasticsuiteCore\Api\Index\IndexInterface $index, Smile\ElasticsuiteCore\Api\Index\TypeInterface $type, array $data ) : Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface Add a several documents to the index.
deleteDocument ( Smile\ElasticsuiteCore\Api\Index\IndexInterface $index, Smile\ElasticsuiteCore\Api\Index\TypeInterface $type, string | integer $docId ) : Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface Delete a document from the index.
deleteDocuments ( Smile\ElasticsuiteCore\Api\Index\IndexInterface $index, Smile\ElasticsuiteCore\Api\Index\TypeInterface $type, array $docIds ) : Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface Delete multiple documents from the index.
getOperations ( ) : array Return list of operations to be executed as an array.
isEmpty ( ) : boolean Indicates if the current bulk contains operation.
updateDocument ( Smile\ElasticsuiteCore\Api\Index\IndexInterface $index, Smile\ElasticsuiteCore\Api\Index\TypeInterface $type, string | integer $docId, array $data ) : Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface Update a single document to the index.
updateDocuments ( Smile\ElasticsuiteCore\Api\Index\IndexInterface $index, Smile\ElasticsuiteCore\Api\Index\TypeInterface $type, array $data ) : Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface Update a several documents to the index.

메소드 상세

addDocument() 공개 메소드

Add a single document to the index.
public addDocument ( Smile\ElasticsuiteCore\Api\Index\IndexInterface $index, Smile\ElasticsuiteCore\Api\Index\TypeInterface $type, string | integer $docId, array $data ) : Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface
$index Smile\ElasticsuiteCore\Api\Index\IndexInterface Index the document has to be added to.
$type Smile\ElasticsuiteCore\Api\Index\TypeInterface Document type.
$docId string | integer Document id.
$data array Document data.
리턴 Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface

addDocuments() 공개 메소드

$data format have to be an array of all documents with document id as key.
public addDocuments ( Smile\ElasticsuiteCore\Api\Index\IndexInterface $index, Smile\ElasticsuiteCore\Api\Index\TypeInterface $type, array $data ) : Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface
$index Smile\ElasticsuiteCore\Api\Index\IndexInterface Index the documents have to be added to.
$type Smile\ElasticsuiteCore\Api\Index\TypeInterface Document type.
$data array Document data.
리턴 Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface

deleteDocument() 공개 메소드

Delete a document from the index.
public deleteDocument ( Smile\ElasticsuiteCore\Api\Index\IndexInterface $index, Smile\ElasticsuiteCore\Api\Index\TypeInterface $type, string | integer $docId ) : Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface
$index Smile\ElasticsuiteCore\Api\Index\IndexInterface Index the document has to be delete from.
$type Smile\ElasticsuiteCore\Api\Index\TypeInterface Document type.
$docId string | integer Document id.
리턴 Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface

deleteDocuments() 공개 메소드

Delete multiple documents from the index.
public deleteDocuments ( Smile\ElasticsuiteCore\Api\Index\IndexInterface $index, Smile\ElasticsuiteCore\Api\Index\TypeInterface $type, array $docIds ) : Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface
$index Smile\ElasticsuiteCore\Api\Index\IndexInterface Index the document has to be delete from.
$type Smile\ElasticsuiteCore\Api\Index\TypeInterface Type of the documents to be delete.
$docIds array Ids of the deleted documents.
리턴 Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface

getOperations() 공개 메소드

Return list of operations to be executed as an array.
public getOperations ( ) : array
리턴 array

isEmpty() 공개 메소드

Indicates if the current bulk contains operation.
public isEmpty ( ) : boolean
리턴 boolean

updateDocument() 공개 메소드

Note : only updated fields are needed into data. Others fields are kept untouched by the update operation.
public updateDocument ( Smile\ElasticsuiteCore\Api\Index\IndexInterface $index, Smile\ElasticsuiteCore\Api\Index\TypeInterface $type, string | integer $docId, array $data ) : Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface
$index Smile\ElasticsuiteCore\Api\Index\IndexInterface Index the document has to be added to.
$type Smile\ElasticsuiteCore\Api\Index\TypeInterface Document type.
$docId string | integer Document id.
$data array Updated data.
리턴 Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface Self reference.

updateDocuments() 공개 메소드

$data format have to be an array of all documents update data with document id as key.
public updateDocuments ( Smile\ElasticsuiteCore\Api\Index\IndexInterface $index, Smile\ElasticsuiteCore\Api\Index\TypeInterface $type, array $data ) : Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface
$index Smile\ElasticsuiteCore\Api\Index\IndexInterface Index the documents have to be added to.
$type Smile\ElasticsuiteCore\Api\Index\TypeInterface Document type.
$data array Document data.
리턴 Smile\ElasticsuiteCore\Api\Index\Bulk\BulkRequestInterface Self reference.