upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-04-15 22:11:17 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 26

Merge pull request #36097 from nextcloud/path-prefix-optimize

Browse source 
extend path-prefix optimizer to remove all cases of path_hash= when encountering a path prefix filter
This commit is contained in:
Robin Appelman 2023-04-03 16:39:49 +02:00 committed by GitHub
commit 5024f295dc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 61 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
lib/private/Files/Search/QueryOptimizer/PathPrefixOptimizer.php
View file

@ -29,27 +29,49 @@ use OCP\Files\Search\ISearchComparison;
use OCP\Files\Search\ISearchOperator;
class PathPrefixOptimizer extends QueryOptimizerStep {
public function processOperator(ISearchOperator &$operator) {
// normally the `path = "$prefix"` search query part of the prefix filter would be generated as an `path_hash = md5($prefix)` sql query
private bool $useHashEq = true;
public function inspectOperator(ISearchOperator $operator): void {
// normally any `path = "$path"` search filter would be generated as an `path_hash = md5($path)` sql query
// since the `path_hash` sql column usually provides much faster querying that selecting on the `path` sql column
//
// however, since we're already doing a filter on the `path` column in the form of `path LIKE "$prefix/%"`
// however, if we're already doing a filter on the `path` column in the form of `path LIKE "$prefix/%"`
// generating a `path = "$prefix"` sql query lets the database handle use the same column for both expressions and potentially use the same index
if ($operator instanceof ISearchBinaryOperator && $operator->getType() === ISearchBinaryOperator::OPERATOR_OR && count($operator->getArguments()) == 2) {
$a = $operator->getArguments()[0];
$b = $operator->getArguments()[1];
if ($a instanceof ISearchComparison && $b instanceof ISearchComparison && $a->getField() === 'path' && $b->getField() === 'path') {
if ($a->getType() === ISearchComparison::COMPARE_LIKE_CASE_SENSITIVE && $b->getType() === ISearchComparison::COMPARE_EQUAL
&& $a->getValue() === SearchComparison::escapeLikeParameter($b->getValue()) . '/%') {
$b->setQueryHint(ISearchComparison::HINT_PATH_EQ_HASH, false);
}
if ($b->getType() === ISearchComparison::COMPARE_LIKE_CASE_SENSITIVE && $a->getType() === ISearchComparison::COMPARE_EQUAL
&& $b->getValue() === SearchComparison::escapeLikeParameter($a->getValue()) . '/%') {
$a->setQueryHint(ISearchComparison::HINT_PATH_EQ_HASH, false);
}
}
//
// If there is any operator in the query that matches this pattern, we change all `path = "$path"` instances to not the `path_hash` equality,
// otherwise mariadb has a tendency of ignoring the path_prefix index
if ($this->useHashEq && $this->isPathPrefixOperator($operator)) {
$this->useHashEq = false;
}
parent::inspectOperator($operator);
}
public function processOperator(ISearchOperator &$operator) {
if (!$this->useHashEq && $operator instanceof ISearchComparison && $operator->getField() === 'path' && $operator->getType() === ISearchComparison::COMPARE_EQUAL) {
$operator->setQueryHint(ISearchComparison::HINT_PATH_EQ_HASH, false);
}
parent::processOperator($operator);
}
private function isPathPrefixOperator(ISearchOperator $operator): bool {
if ($operator instanceof ISearchBinaryOperator && $operator->getType() === ISearchBinaryOperator::OPERATOR_OR && count($operator->getArguments()) == 2) {
$a = $operator->getArguments()[0];
$b = $operator->getArguments()[1];
if ($this->operatorPairIsPathPrefix($a, $b) || $this->operatorPairIsPathPrefix($b, $a)) {
return true;
}
}
return false;
}
private function operatorPairIsPathPrefix(ISearchOperator $like, ISearchOperator $equal): bool {
return (
$like instanceof ISearchComparison && $equal instanceof ISearchComparison &&
$like->getField() === 'path' && $equal->getField() === 'path' &&
$like->getType() === ISearchComparison::COMPARE_LIKE_CASE_SENSITIVE && $equal->getType() === ISearchComparison::COMPARE_EQUAL
&& $like->getValue() === SearchComparison::escapeLikeParameter($equal->getValue()) . '/%'
);
}
}

3
lib/private/Files/Search/QueryOptimizer/QueryOptimizer.php
View file

@ -38,6 +38,9 @@ class QueryOptimizer {
}
public function processOperator(ISearchOperator $operator) {
foreach ($this->steps as $step) {
$step->inspectOperator($operator);
}
foreach ($this->steps as $step) {
$step->processOperator($operator);
}

20
lib/private/Files/Search/QueryOptimizer/QueryOptimizerStep.php
View file

@ -27,6 +27,26 @@ use OCP\Files\Search\ISearchBinaryOperator;
use OCP\Files\Search\ISearchOperator;
class QueryOptimizerStep {
/**
* Allow optimizer steps to inspect the entire query before starting processing
*
* @param ISearchOperator $operator
* @return void
*/
public function inspectOperator(ISearchOperator $operator): void {
if ($operator instanceof ISearchBinaryOperator) {
foreach ($operator->getArguments() as $argument) {
$this->inspectOperator($argument);
}
}
}
/**
* Allow optimizer steps to modify query operators
*
* @param ISearchOperator $operator
* @return void
*/
public function processOperator(ISearchOperator &$operator) {
if ($operator instanceof ISearchBinaryOperator) {
foreach ($operator->getArguments() as $argument) {