mirror of
https://github.com/Codappix/search_core.git
synced 2024-12-24 02:36:10 +01:00
Daniel Siepmann
2d9062b6e3
* Do not add duplicate information from PHP to phpdoc. * Do not add useless comments like "this is a constructor of class x".
69 lines
2 KiB
PHP
69 lines
2 KiB
PHP
<?php
|
|
|
|
namespace Codappix\SearchCore\Connection;
|
|
|
|
/*
|
|
* Copyright (C) 2016 Daniel Siepmann <coding@daniel-siepmann.de>
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
* 02110-1301, USA.
|
|
*/
|
|
|
|
use Elastica\Query;
|
|
|
|
/**
|
|
* Defines interface for connections to storage backend for interacting with documents.
|
|
*/
|
|
interface ConnectionInterface
|
|
{
|
|
/**
|
|
* Will add a new document.
|
|
*/
|
|
public function addDocument(string $documentType, array $document);
|
|
|
|
/**
|
|
* Add the given documents.
|
|
*/
|
|
public function addDocuments(string $documentType, array $documents);
|
|
|
|
/**
|
|
* Will update an existing document.
|
|
*
|
|
* NOTE: Batch updating is not yet supported.
|
|
*/
|
|
public function updateDocument(string $documentType, array $document);
|
|
|
|
/**
|
|
* Will remove an existing document.
|
|
*
|
|
* NOTE: Batch deleting is not yet supported.
|
|
*/
|
|
public function deleteDocument(string $documentType, string $identifier);
|
|
|
|
/**
|
|
* Search by given request and return result.
|
|
*/
|
|
public function search(SearchRequestInterface $searchRequest): SearchResultInterface;
|
|
|
|
/**
|
|
* Will delete the whole index / db.
|
|
*/
|
|
public function deleteIndex();
|
|
|
|
/**
|
|
* Will delete the index / db of defined document type.
|
|
*/
|
|
public function deleteIndexByQuery(Query $query);
|
|
}
|