1 | /** |
2 | * Copyright 2021 Alibaba, Inc. and its affiliates. All Rights Reserved. |
3 | * |
4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
5 | * you may not use this file except in compliance with the License. |
6 | * You may obtain a copy of the License at |
7 | * |
8 | * http://www.apache.org/licenses/LICENSE-2.0 |
9 | * |
10 | * Unless required by applicable law or agreed to in writing, software |
11 | * distributed under the License is distributed on an "AS IS" BASIS, |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
13 | * See the License for the specific language governing permissions and |
14 | * limitations under the License. |
15 | * |
16 | * \author guonix |
17 | * \date Nov 2020 |
18 | * \brief |
19 | */ |
20 | |
21 | #pragma once |
22 | |
23 | #include "common/profiler.h" |
24 | #include "index/index_service.h" |
25 | #include "meta/meta_service.h" |
26 | #include "proto/proxima_be.pb.h" |
27 | |
28 | namespace proxima { |
29 | namespace be { |
30 | namespace query { |
31 | |
32 | //! Predefine class |
33 | class QueryService; |
34 | //! Alias for QueryService |
35 | using QueryServicePtr = std::shared_ptr<QueryService>; |
36 | |
37 | |
38 | /*! |
39 | * QueryService interface |
40 | */ |
41 | class QueryService { |
42 | public: |
43 | //! Destructor |
44 | virtual ~QueryService() = default; |
45 | |
46 | public: |
47 | //! Initialized flag |
48 | virtual bool initialized() const = 0; |
49 | |
50 | //! Query Service |
51 | virtual int search(const proto::QueryRequest *query, |
52 | proto::QueryResponse *response, ProfilerPtr profiler) = 0; |
53 | |
54 | //! Query document by key |
55 | virtual int search_by_key(const proto::GetDocumentRequest *query, |
56 | proto::GetDocumentResponse *response, |
57 | ProfilerPtr profiler) = 0; |
58 | |
59 | //! Cleanup QueryService |
60 | virtual int cleanup() = 0; |
61 | }; |
62 | |
63 | |
64 | } // namespace query |
65 | } // namespace be |
66 | } // namespace proxima |
67 | |