Skip to content

feat(mango): keys-only covering indexes #4512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nickva merged 11 commits into from
Apr 19, 2023
Merged

feat(mango): keys-only covering indexes #4512

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1efeb75
Remove explicit import
pgj Apr 17, 2023
21b7927
mango: introduce support for covering indexes
pgj Mar 16, 2023
4ed65d5
mango: add type information for better self-documentation
pgj Mar 20, 2023
7278574
mango: increase coverage of the `choose_best_index/1` test
pgj Mar 22, 2023
0394b9e
mango: add eunit tests
pgj Mar 22, 2023
96d0480
_find: mention the `covered` attribute in the `_explain` response
pgj Mar 22, 2023
7cbcce4
mango: add integration tests for keys-only covering indexes
pgj Mar 24, 2023
cfd4c73
mango: mark fields with the `$exists` operator indexable
pgj Mar 27, 2023
138fdfe
mango: enhance compositionality of `consider_index_coverage/3`
pgj Mar 27, 2023
842663d
mango: fix definition of index coverage
pgj Apr 17, 2023
cb9a3bf
mango: refactor
pgj Apr 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Remove explicit import
  • Loading branch information
@pgj
pgj committed Apr 17, 2023
commit 1efeb75fd83572f55baeb815231e4473e4e11028
133 changes: 63 additions & 70 deletions src/mango/src/mango_idx_text.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,6 @@
-include("mango.hrl").
-include("mango_idx.hrl").

-ifdef(TEST).
-import(test_util, [as_selector/1]).
-endif.

validate_new(#idx{} = Idx, Db) ->
{ok, Def} = do_validate(Idx#idx.def),
maybe_reject_index_all_req(Def, Db),
Expand Down Expand Up @@ -476,76 +472,73 @@ warn_index_all({Idx, Db}) ->
?assertThrow({test_error, logged_warning}, validate_new(Idx, Db))
end).

indexable(Selector) ->
indexable_fields(test_util:as_selector(Selector)).

indexable_fields_test() ->
?assertEqual(
[<<"$default">>, <<"field1:boolean">>, <<"field2:number">>, <<"field3:string">>],
indexable_fields(
as_selector(
#{
<<"$default">> => #{<<"$text">> => <<"text">>},
<<"field1">> => true,
<<"field2">> => 42,
<<"field3">> => #{<<"$regex">> => <<".*">>}
}
)
indexable(
#{
<<"$default">> => #{<<"$text">> => <<"text">>},
<<"field1">> => true,
<<"field2">> => 42,
<<"field3">> => #{<<"$regex">> => <<".*">>}
}
)
),
?assertEqual(
[<<"f1:string">>, <<"f2:string">>, <<"f3:string">>, <<"f4:string">>, <<"f5:string">>],
lists:sort(
indexable_fields(
as_selector(
#{
<<"$and">> =>
[
#{<<"f1">> => <<"v1">>},
#{<<"f2">> => <<"v2">>}
],
<<"$or">> =>
[
#{<<"f3">> => <<"v3">>},
#{<<"f4">> => <<"v4">>}
],
<<"$not">> => #{<<"f5">> => <<"v5">>}
}
)
)
)
),

?assertEqual(
[],
indexable_fields(
as_selector(
#{
<<"field1">> => null,
<<"field2">> => #{<<"$size">> => 3},
<<"field3">> => #{<<"$type">> => <<"type">>}
}
)
)
),
?assertEqual(
[],
indexable_fields(
as_selector(
indexable(
#{
<<"$and">> =>
[
#{<<"f1">> => null},
#{<<"f2">> => null}
#{<<"f1">> => <<"v1">>},
#{<<"f2">> => <<"v2">>}
],
<<"$or">> =>
[
#{<<"f3">> => null},
#{<<"f4">> => null}
#{<<"f3">> => <<"v3">>},
#{<<"f4">> => <<"v4">>}
],
<<"$not">> => #{<<"f5">> => null}
<<"$not">> => #{<<"f5">> => <<"v5">>}
}
)
)
),
?assertEqual(
[],
indexable(
#{
<<"field1">> => null,
<<"field2">> => #{<<"$size">> => 3},
<<"field3">> => #{<<"$type">> => <<"type">>}
}
)
),
?assertEqual(
[],
indexable(
#{
<<"$and">> =>
[
#{<<"f1">> => null},
#{<<"f2">> => null}
],
<<"$or">> =>
[
#{<<"f3">> => null},
#{<<"f4">> => null}
],
<<"$not">> => #{<<"f5">> => null}
}
)
).

usable(Index, Selector, Fields) ->
is_usable(Index, test_util:as_selector(Selector), Fields).

is_usable_test() ->
?assertNot(is_usable(undefined, {[]}, undefined)),

Expand All @@ -555,38 +548,38 @@ is_usable_test() ->
Field1 = {[{<<"name">>, <<"field1">>}, {<<"type">>, <<"string">>}]},
Field2 = {[{<<"name">>, <<"field2">>}, {<<"type">>, <<"number">>}]},
Index = #idx{def = {[{<<"fields">>, [Field1, Field2]}]}},
?assert(is_usable(Index, as_selector(#{<<"field1">> => <<"value">>}), undefined)),
?assertNot(is_usable(Index, as_selector(#{<<"field1">> => 42}), undefined)),
?assertNot(is_usable(Index, as_selector(#{<<"field3">> => true}), undefined)),
?assert(usable(Index, #{<<"field1">> => <<"value">>}, undefined)),
?assertNot(usable(Index, #{<<"field1">> => 42}, undefined)),
?assertNot(usable(Index, #{<<"field3">> => true}, undefined)),
?assert(
is_usable(Index, as_selector(#{<<"field1">> => #{<<"$type">> => <<"string">>}}), undefined)
usable(Index, #{<<"field1">> => #{<<"$type">> => <<"string">>}}, undefined)
),
?assert(
is_usable(Index, as_selector(#{<<"field1">> => #{<<"$type">> => <<"boolean">>}}), undefined)
usable(Index, #{<<"field1">> => #{<<"$type">> => <<"boolean">>}}, undefined)
),
?assert(
is_usable(Index, as_selector(#{<<"field3">> => #{<<"$type">> => <<"boolean">>}}), undefined)
usable(Index, #{<<"field3">> => #{<<"$type">> => <<"boolean">>}}, undefined)
),
?assert(is_usable(Index, as_selector(#{<<"field1">> => #{<<"$exists">> => true}}), undefined)),
?assert(is_usable(Index, as_selector(#{<<"field1">> => #{<<"$exists">> => false}}), undefined)),
?assert(is_usable(Index, as_selector(#{<<"field3">> => #{<<"$exists">> => true}}), undefined)),
?assert(is_usable(Index, as_selector(#{<<"field3">> => #{<<"$exists">> => false}}), undefined)),
?assert(usable(Index, #{<<"field1">> => #{<<"$exists">> => true}}, undefined)),
?assert(usable(Index, #{<<"field1">> => #{<<"$exists">> => false}}, undefined)),
?assert(usable(Index, #{<<"field3">> => #{<<"$exists">> => true}}, undefined)),
?assert(usable(Index, #{<<"field3">> => #{<<"$exists">> => false}}, undefined)),
?assert(
is_usable(Index, as_selector(#{<<"field1">> => #{<<"$regex">> => <<".*">>}}), undefined)
usable(Index, #{<<"field1">> => #{<<"$regex">> => <<".*">>}}, undefined)
),
?assertNot(
is_usable(Index, as_selector(#{<<"field2">> => #{<<"$regex">> => <<".*">>}}), undefined)
usable(Index, #{<<"field2">> => #{<<"$regex">> => <<".*">>}}, undefined)
),
?assertNot(
is_usable(Index, as_selector(#{<<"field3">> => #{<<"$regex">> => <<".*">>}}), undefined)
usable(Index, #{<<"field3">> => #{<<"$regex">> => <<".*">>}}, undefined)
),
?assertNot(
is_usable(Index, as_selector(#{<<"field1">> => #{<<"$nin">> => [1, 2, 3]}}), undefined)
usable(Index, #{<<"field1">> => #{<<"$nin">> => [1, 2, 3]}}, undefined)
),
?assert(
is_usable(Index, as_selector(#{<<"field2">> => #{<<"$nin">> => [1, 2, 3]}}), undefined)
usable(Index, #{<<"field2">> => #{<<"$nin">> => [1, 2, 3]}}, undefined)
),
?assertNot(
is_usable(Index, as_selector(#{<<"field3">> => #{<<"$nin">> => [1, 2, 3]}}), undefined)
usable(Index, #{<<"field3">> => #{<<"$nin">> => [1, 2, 3]}}, undefined)
).
-endif.
Loading