bucket.hpp

// Copyright 2017 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 <istream>
#include <memory>
#include <ostream>
 
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
#include <bsoncxx/stdx/string_view.hpp>
#include <bsoncxx/types/bson_value/view.hpp>
#include <mongocxx/cursor.hpp>
#include <mongocxx/gridfs/downloader.hpp>
#include <mongocxx/gridfs/uploader.hpp>
#include <mongocxx/options/find.hpp>
#include <mongocxx/options/gridfs/bucket.hpp>
#include <mongocxx/options/gridfs/upload.hpp>
#include <mongocxx/result/gridfs/upload.hpp>
#include <mongocxx/stdx.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
inline namespace v_noabi {
class database;
 
namespace gridfs {
 
class MONGOCXX_API bucket {
   public:
    bucket() noexcept;
 
    bucket(bucket&&) noexcept;
 
    bucket& operator=(bucket&&) noexcept;
 
    bucket(const bucket&);
 
    bucket& operator=(const bucket&);
 
    ~bucket();
 
    explicit operator bool() const noexcept;
 
    uploader open_upload_stream(stdx::string_view filename,
                                const options::gridfs::upload& options = {});
 
    uploader open_upload_stream(const client_session& session,
                                stdx::string_view filename,
                                const options::gridfs::upload& options = {});
 
    uploader open_upload_stream_with_id(bsoncxx::types::bson_value::view id,
                                        stdx::string_view filename,
                                        const options::gridfs::upload& options = {});
 
    uploader open_upload_stream_with_id(const client_session& session,
                                        bsoncxx::types::bson_value::view id,
                                        stdx::string_view filename,
                                        const options::gridfs::upload& options = {});
 
    result::gridfs::upload upload_from_stream(stdx::string_view filename,
                                              std::istream* source,
                                              const options::gridfs::upload& options = {});
 
    result::gridfs::upload upload_from_stream(const client_session& session,
                                              stdx::string_view filename,
                                              std::istream* source,
                                              const options::gridfs::upload& options = {});
 
    void upload_from_stream_with_id(bsoncxx::types::bson_value::view id,
                                    stdx::string_view filename,
                                    std::istream* source,
                                    const options::gridfs::upload& options = {});
 
    void upload_from_stream_with_id(const client_session& session,
                                    bsoncxx::types::bson_value::view id,
                                    stdx::string_view filename,
                                    std::istream* source,
                                    const options::gridfs::upload& options = {});
 
    downloader open_download_stream(bsoncxx::types::bson_value::view id);
 
    downloader open_download_stream(const client_session& session,
                                    bsoncxx::types::bson_value::view id);
 
    void download_to_stream(bsoncxx::types::bson_value::view id, std::ostream* destination);
 
    void download_to_stream(bsoncxx::types::bson_value::view id,
                            std::ostream* destination,
                            std::size_t start,
                            std::size_t end);
 
    void download_to_stream(const client_session& session,
                            bsoncxx::types::bson_value::view id,
                            std::ostream* destination);
 
    // clang-format off
    // clang-format on
    void download_to_stream(const client_session& session,
                            bsoncxx::types::bson_value::view id,
                            std::ostream* destination,
                            std::size_t start,
                            std::size_t end);
 
    void delete_file(bsoncxx::types::bson_value::view id);
 
    void delete_file(const client_session& session, bsoncxx::types::bson_value::view id);
 
    cursor find(bsoncxx::document::view_or_value filter, const options::find& options = {});
 
    cursor find(const client_session& session,
                bsoncxx::document::view_or_value filter,
                const options::find& options = {});
 
    stdx::string_view bucket_name() const;
 
   private:
    friend class mongocxx::database;
 
    // Constructs a new GridFS bucket.  Throws if options are invalid.
    MONGOCXX_PRIVATE bucket(const database& db, const options::gridfs::bucket& options);
 
    MONGOCXX_PRIVATE void create_indexes_if_nonexistent(const client_session* session);
 
    MONGOCXX_PRIVATE uploader _open_upload_stream_with_id(const client_session* session,
                                                          bsoncxx::types::bson_value::view id,
                                                          stdx::string_view filename,
                                                          const options::gridfs::upload& options);
 
    MONGOCXX_PRIVATE void _upload_from_stream_with_id(const client_session* session,
                                                      bsoncxx::types::bson_value::view id,
                                                      stdx::string_view filename,
                                                      std::istream* source,
                                                      const options::gridfs::upload& options);
 
    MONGOCXX_PRIVATE downloader _open_download_stream(const client_session* session,
                                                      bsoncxx::types::bson_value::view id,
                                                      stdx::optional<std::size_t> start,
                                                      stdx::optional<std::size_t> end);
 
    MONGOCXX_PRIVATE void _download_to_stream(const client_session* session,
                                              bsoncxx::types::bson_value::view id,
                                              std::ostream* destination,
                                              stdx::optional<std::size_t> start,
                                              stdx::optional<std::size_t> end);
 
    MONGOCXX_PRIVATE void _delete_file(const client_session* session,
                                       bsoncxx::types::bson_value::view id);
 
    class MONGOCXX_PRIVATE impl;
 
    MONGOCXX_PRIVATE impl& _get_impl();
    MONGOCXX_PRIVATE const impl& _get_impl() const;
 
    std::unique_ptr<impl> _impl;
};
 
}  // namespace gridfs
}  // namespace v_noabi
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>