/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *   Copyright 2020-Present Couchbase, Inc.
 *
 *   Licensed 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 <couchbase/build_query_index_options.hxx>
#include <couchbase/create_primary_query_index_options.hxx>
#include <couchbase/create_query_index_options.hxx>
#include <couchbase/drop_primary_query_index_options.hxx>
#include <couchbase/drop_query_index_options.hxx>
#include <couchbase/get_all_query_indexes_options.hxx>
#include <couchbase/watch_query_indexes_options.hxx>

#include <future>
#include <memory>

#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
namespace couchbase::core
{
class cluster;

class query_context;

} // namespace couchbase::core
#endif

namespace couchbase
{
class collection;

/**
 * The Query Index Manager interface contains the means for managing indexes used for queries.
 *
 * @since 1.0.0
 * @committed
 */
class collection_query_index_manager
{
  public:
    /**
     * Get all indexes within a collection.
     *
     *
     * @param options optional parameters
     * @param handler the handler that implements @ref get_all_query_indexes_handler
     *
     * @since 1.0.0
     * @committed
     */
    void get_all_indexes(const get_all_query_indexes_options& options, get_all_query_indexes_handler&& handler) const;

    [[nodiscard]] auto get_all_indexes(const get_all_query_indexes_options& options) const
      -> std::future<std::pair<manager_error_context, std::vector<couchbase::management::query::index>>>;
    /**
     * Create an index on the collection.
     *
     * @param index_name name of the index
     * @param fields the fields to create the index over
     * @param options optional parameters
     * @param handler the handler that implements @ref create_query_index_handler
     *
     * @since 1.0.0
     * @committed
     */
    void create_index(std::string index_name,
                      std::vector<std::string> fields,
                      const create_query_index_options& options,
                      create_query_index_handler&& handler) const;

    [[nodiscard]] auto create_index(std::string index_name,
                                    std::vector<std::string> fields,
                                    const create_query_index_options& options) const -> std::future<manager_error_context>;

    /**
     * Create a primary index on a collection.
     *
     * @param options optional parameters
     * @param handler the handler that implements @ref create_query_index_handler
     *
     * @since 1.0.0
     * @committed
     */
    void create_primary_index(const create_primary_query_index_options& options, create_query_index_handler&& handler) const;

    [[nodiscard]] auto create_primary_index(const create_primary_query_index_options& options) -> std::future<manager_error_context>;
    /**
     * Drop primary index on a collection.
     *
     * @param options optional parameters
     * @param handler the handler that implements @ref drop_query_index_handler
     *
     * @since 1.0.0
     * @committed
     */
    void drop_primary_index(const drop_primary_query_index_options& options, drop_query_index_handler&& handler) const;

    [[nodiscard]] auto drop_primary_index(const drop_primary_query_index_options& options) const -> std::future<manager_error_context>;

    /**
     * Drop index in collection.
     *
     * @param index_name name of the index to drop
     * @param options optional parameters
     * @param handler handler that implements @ref drop_query_index_handler
     *
     * @since 1.0.0
     * @committed
     */
    void drop_index(std::string index_name, const drop_query_index_options& options, drop_query_index_handler&& handler) const;

    [[nodiscard]] auto drop_index(std::string index_name, const drop_query_index_options& options) -> std::future<manager_error_context>;
    /**
     * Builds all currently deferred indexes in this collection.
     *
     * By default, this method will build the indexes on the collection.
     *
     * @param options the custom options
     * @param handler the handler that implements @ref build_deferred_query_indexes_handler
     *
     * @since 1.0.0
     * @committed
     */
    void build_deferred_indexes(const build_query_index_options& options, build_deferred_query_indexes_handler&& handler) const;

    [[nodiscard]] auto build_deferred_indexes(const build_query_index_options& options) const -> std::future<manager_error_context>;

    /**
     * Polls the state of a set of indexes, until they all are online.
     *
     * @param index_names names of the indexes to watch
     * @param options optional parameters
     * @param handler handler that implements @ref watch_query_indexes_handler
     *
     * @since 1.0.0
     * @committed
     */
    void watch_indexes(std::vector<std::string> index_names,
                       const watch_query_indexes_options& options,
                       watch_query_indexes_handler&& handler) const;

    [[nodiscard]] auto watch_indexes(std::vector<std::string> index_names, const watch_query_indexes_options& options)
      -> std::future<manager_error_context>;

  private:
    friend class collection;

    explicit collection_query_index_manager(std::shared_ptr<couchbase::core::cluster> core,
                                            std::string bucket_name,
                                            std::string scope_name,
                                            std::string collection_name)
      : core_(core)
      , bucket_name_(std::move(bucket_name))
      , scope_name_(std::move(scope_name))
      , collection_name_(std::move(collection_name))
    {
    }

    std::shared_ptr<couchbase::core::cluster> core_;
    std::string bucket_name_;
    std::string scope_name_;
    std::string collection_name_;
};
} // namespace couchbase
