database.hpp

Go to the documentation of this file.

// Copyright 2009-present MongoDB, 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 <memory>
#include <string>
 
#include <mongocxx/client-fwd.hpp>
#include <mongocxx/client_encryption-fwd.hpp>
#include <mongocxx/collection-fwd.hpp>
#include <mongocxx/database-fwd.hpp>
 
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/string/view_or_value.hpp>
 
#include <mongocxx/client_session.hpp>
#include <mongocxx/collection.hpp>
#include <mongocxx/gridfs/bucket.hpp>
#include <mongocxx/options/create_collection.hpp>
#include <mongocxx/options/gridfs/bucket.hpp>
#include <mongocxx/read_preference.hpp>
#include <mongocxx/write_concern.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
 
class database {
   public:
    MONGOCXX_ABI_EXPORT_CDECL() database() noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL() database(database&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(database&) operator=(database&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL() database(const database&);
 
    MONGOCXX_ABI_EXPORT_CDECL(database&) operator=(const database&);
 
    MONGOCXX_ABI_EXPORT_CDECL() ~database();
 
    explicit MONGOCXX_ABI_EXPORT_CDECL() operator bool() const noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(cursor)
    aggregate(const pipeline& pipeline, const options::aggregate& options = options::aggregate());
 
    MONGOCXX_ABI_EXPORT_CDECL(cursor)
    aggregate(const client_session& session,
              const pipeline& pipeline,
              const options::aggregate& options = options::aggregate());
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::value)
    run_command(bsoncxx::v_noabi::document::view_or_value command);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::value)
    run_command(const client_session& session, bsoncxx::v_noabi::document::view_or_value command);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::value)
    run_command(bsoncxx::v_noabi::document::view_or_value command, uint32_t server_id);
 
    MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::collection)
    create_collection(stdx::string_view name,
                      bsoncxx::v_noabi::document::view_or_value collection_options = {},
                      const stdx::optional<write_concern>& write_concern = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::collection)
    create_collection(const client_session& session,
                      stdx::string_view name,
                      bsoncxx::v_noabi::document::view_or_value collection_options = {},
                      const stdx::optional<write_concern>& write_concern = {});
 
    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::collection)
        create_collection(bsoncxx::v_noabi::string::view_or_value name,
                          const options::create_collection_deprecated& collection_options,
                          const stdx::optional<write_concern>& write_concern = {}) {
        return create_collection_deprecated(name, collection_options, write_concern);
    }
 
    MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::collection)
    create_collection_deprecated(bsoncxx::v_noabi::string::view_or_value name,
                                 const options::create_collection_deprecated& collection_options,
                                 const stdx::optional<write_concern>& write_concern = {});
 
    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::collection)
        create_collection(const client_session& session,
                          bsoncxx::v_noabi::string::view_or_value name,
                          const options::create_collection_deprecated& collection_options,
                          const stdx::optional<write_concern>& write_concern = {}) {
        return create_collection_deprecated(session, name, collection_options, write_concern);
    }
 
    MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::collection)
    create_collection_deprecated(const client_session& session,
                                 bsoncxx::v_noabi::string::view_or_value name,
                                 const options::create_collection_deprecated& collection_options,
                                 const stdx::optional<write_concern>& write_concern = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop(const bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::write_concern>& write_concern =
             {});
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop(const client_session& session,
         const bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::write_concern>& write_concern =
             {});
 
    MONGOCXX_ABI_EXPORT_CDECL(bool)
    has_collection(bsoncxx::v_noabi::string::view_or_value name) const;
 
    MONGOCXX_ABI_EXPORT_CDECL(cursor)
    list_collections(bsoncxx::v_noabi::document::view_or_value filter = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(cursor)
    list_collections(const client_session& session,
                     bsoncxx::v_noabi::document::view_or_value filter = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(std::vector<std::string>)
    list_collection_names(bsoncxx::v_noabi::document::view_or_value filter = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(std::vector<std::string>)
    list_collection_names(const client_session& session,
                          bsoncxx::v_noabi::document::view_or_value filter = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(stdx::string_view) name() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(void) read_concern(mongocxx::v_noabi::read_concern rc);
 
    MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::read_concern) read_concern() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(void) read_preference(mongocxx::v_noabi::read_preference rp);
 
    MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::read_preference) read_preference() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(void) write_concern(mongocxx::v_noabi::write_concern wc);
 
    MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::write_concern) write_concern() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::collection)
    collection(bsoncxx::v_noabi::string::view_or_value name) const;
 
    mongocxx::v_noabi::collection operator[](bsoncxx::v_noabi::string::view_or_value name) const {
        return collection(name);
    }
 
    MONGOCXX_ABI_EXPORT_CDECL(gridfs::bucket)
    gridfs_bucket(const options::gridfs::bucket& options = options::gridfs::bucket()) const;
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream) watch(const options::change_stream& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream)
    watch(const client_session& session, const options::change_stream& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream)
    watch(const pipeline& pipe, const options::change_stream& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream)
    watch(const client_session& session,
          const pipeline& pipe,
          const options::change_stream& options = {});
 
   private:
    friend ::mongocxx::v_noabi::client_encryption;
    friend ::mongocxx::v_noabi::client;
    friend ::mongocxx::v_noabi::collection;
 
    database(const mongocxx::v_noabi::client& client, bsoncxx::v_noabi::string::view_or_value name);
 
    cursor _aggregate(const client_session* session,
                      const pipeline& pipeline,
                      const options::aggregate& options);
 
    bsoncxx::v_noabi::document::value _run_command(
        const client_session* session, bsoncxx::v_noabi::document::view_or_value command);
 
    mongocxx::v_noabi::collection _create_collection(
        const client_session* session,
        stdx::string_view name,
        bsoncxx::v_noabi::document::view_or_value collection_options,
        const stdx::optional<mongocxx::v_noabi::write_concern>& write_concern);
 
    mongocxx::v_noabi::collection _create_collection_deprecated(
        const client_session* session,
        bsoncxx::v_noabi::string::view_or_value name,
        const options::create_collection_deprecated& collection_options,
        const stdx::optional<mongocxx::v_noabi::write_concern>& write_concern);
 
    cursor _list_collections(const client_session* session,
                             bsoncxx::v_noabi::document::view_or_value filter);
 
    std::vector<std::string> _list_collection_names(
        const client_session* session, bsoncxx::v_noabi::document::view_or_value filter);
 
    void _drop(
        const client_session* session,
        const bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::write_concern>& write_concern);
 
    change_stream _watch(const client_session* session,
                         const pipeline& pipe,
                         const options::change_stream& options);
 
    class impl;
 
    impl& _get_impl();
    const impl& _get_impl() const;
 
    std::unique_ptr<impl> _impl;
};
 
}  // namespace v_noabi
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>