DB.h

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

#pragma once

#include "Options.h"
#include "meta/Meta.h"
#include "Status.h"
#include "Types.h"

#include <string>
#include <memory>

namespace zilliz {
namespace milvus {
namespace engine {

class Env;

class DB {
public:
    DB() = default;
    DB(const DB&) = delete;
    DB& operator=(const DB&) = delete;

    virtual ~DB() = default;

    virtual Status Start() = 0;
    virtual Status Stop() = 0;

    virtual Status CreateTable(meta::TableSchema& table_schema_) = 0;
    virtual Status DeleteTable(const std::string& table_id, const meta::DatesT& dates) = 0;
    virtual Status DescribeTable(meta::TableSchema& table_schema_) = 0;
    virtual Status HasTable(const std::string& table_id, bool& has_or_not_) = 0;
    virtual Status AllTables(std::vector<meta::TableSchema>& table_schema_array) = 0;
    virtual Status GetTableRowCount(const std::string& table_id, uint64_t& row_count) = 0;
    virtual Status PreloadTable(const std::string& table_id) = 0;
    virtual Status UpdateTableFlag(const std::string &table_id, int64_t flag) = 0;

    virtual Status InsertVectors(const std::string& table_id_,
            uint64_t n, const float* vectors, IDNumbers& vector_ids_) = 0;

    virtual Status Query(const std::string& table_id, uint64_t k, uint64_t nq, uint64_t nprobe,
            const float* vectors, QueryResults& results) = 0;

    virtual Status Query(const std::string& table_id, uint64_t k, uint64_t nq, uint64_t nprobe,
            const float* vectors, const meta::DatesT& dates, QueryResults& results) = 0;

    virtual Status Query(const std::string& table_id, const std::vector<std::string>& file_ids,
            uint64_t k, uint64_t nq, uint64_t nprobe, const float* vectors,
            const meta::DatesT& dates, QueryResults& results) = 0;

    virtual Status Size(uint64_t& result) = 0;

    virtual Status CreateIndex(const std::string& table_id, const TableIndex& index) = 0;
    virtual Status DescribeIndex(const std::string& table_id, TableIndex& index) = 0;
    virtual Status DropIndex(const std::string& table_id) = 0;

    virtual Status DropAll() = 0;

}; // DB

using DBPtr = std::shared_ptr<DB>;

} // namespace engine
} // namespace milvus
} // namespace zilliz