MongoDB C++ Driver current
Loading...
Searching...
No Matches
bucket.hpp
1// Copyright 2017 MongoDB Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#pragma once
16
17#include <istream>
18#include <memory>
19#include <ostream>
20
21#include <bsoncxx/document/view_or_value.hpp>
22#include <bsoncxx/stdx/optional.hpp>
23#include <bsoncxx/stdx/string_view.hpp>
24#include <bsoncxx/types/bson_value/view.hpp>
25#include <mongocxx/cursor.hpp>
26#include <mongocxx/gridfs/downloader.hpp>
27#include <mongocxx/gridfs/uploader.hpp>
28#include <mongocxx/options/find.hpp>
29#include <mongocxx/options/gridfs/bucket.hpp>
30#include <mongocxx/options/gridfs/upload.hpp>
31#include <mongocxx/result/gridfs/upload.hpp>
32#include <mongocxx/stdx.hpp>
33
34#include <mongocxx/config/prelude.hpp>
35
36namespace mongocxx {
37inline namespace v_noabi {
38class database;
39
40namespace gridfs {
41
62class MONGOCXX_API bucket {
63 public:
69 bucket() noexcept;
70
74 bucket(bucket&&) noexcept;
75
79 bucket& operator=(bucket&&) noexcept;
80
84 bucket(const bucket&);
85
89 bucket& operator=(const bucket&);
90
95
99 explicit operator bool() const noexcept;
100
128 uploader open_upload_stream(stdx::string_view filename,
129 const options::gridfs::upload& options = {});
130
161 stdx::string_view filename,
162 const options::gridfs::upload& options = {});
166
197 stdx::string_view filename,
198 const options::gridfs::upload& options = {});
199
233 stdx::string_view filename,
234 const options::gridfs::upload& options = {});
238
281 result::gridfs::upload upload_from_stream(stdx::string_view filename,
282 std::istream* source,
283 const options::gridfs::upload& options = {});
284
329 stdx::string_view filename,
330 std::istream* source,
331 const options::gridfs::upload& options = {});
335
379 stdx::string_view filename,
380 std::istream* source,
381 const options::gridfs::upload& options = {});
382
428 stdx::string_view filename,
429 std::istream* source,
430 const options::gridfs::upload& options = {});
434
453
478
501 void download_to_stream(bsoncxx::types::bson_value::view id, std::ostream* destination);
502
510 std::ostream* destination,
511 std::size_t start,
512 std::size_t end);
513
539 std::ostream* destination);
540
541 // clang-format off
548 // clang-format on
551 std::ostream* destination,
552 std::size_t start,
553 std::size_t end);
557
572
591
612 cursor find(bsoncxx::document::view_or_value filter, const options::find& options = {});
613
636 cursor find(const client_session& session,
637 bsoncxx::document::view_or_value filter,
638 const options::find& options = {});
642
649 stdx::string_view bucket_name() const;
650
651 private:
652 friend class mongocxx::database;
653
654 // Constructs a new GridFS bucket. Throws if options are invalid.
655 MONGOCXX_PRIVATE bucket(const database& db, const options::gridfs::bucket& options);
656
657 MONGOCXX_PRIVATE void create_indexes_if_nonexistent(const client_session* session);
658
659 MONGOCXX_PRIVATE uploader _open_upload_stream_with_id(const client_session* session,
661 stdx::string_view filename,
662 const options::gridfs::upload& options);
663
664 MONGOCXX_PRIVATE void _upload_from_stream_with_id(const client_session* session,
666 stdx::string_view filename,
667 std::istream* source,
668 const options::gridfs::upload& options);
669
670 MONGOCXX_PRIVATE downloader _open_download_stream(const client_session* session,
672 stdx::optional<std::size_t> start,
673 stdx::optional<std::size_t> end);
674
675 MONGOCXX_PRIVATE void _download_to_stream(const client_session* session,
677 std::ostream* destination,
678 stdx::optional<std::size_t> start,
679 stdx::optional<std::size_t> end);
680
681 MONGOCXX_PRIVATE void _delete_file(const client_session* session,
683
684 class MONGOCXX_PRIVATE impl;
685
686 MONGOCXX_PRIVATE impl& _get_impl();
687 MONGOCXX_PRIVATE const impl& _get_impl() const;
688
689 std::unique_ptr<impl> _impl;
690};
691
692} // namespace gridfs
693} // namespace v_noabi
694} // namespace mongocxx
695
696#include <mongocxx/config/postlude.hpp>
A view-only variant that can contain any BSON type.
Definition view.hpp:44
Use a session for a sequence of operations, optionally with either causal consistency or snapshots.
Definition client_session.hpp:40
Class representing a pointer to the result set of a query on a MongoDB server.
Definition cursor.hpp:36
Class representing a MongoDB database.
Definition database.hpp:44
Class representing a GridFS bucket.
Definition bucket.hpp:62
void download_to_stream(bsoncxx::types::bson_value::view id, std::ostream *destination, std::size_t start, std::size_t end)
Downloads the contents of a stored GridFS file from the bucket and writes it to a stream.
uploader open_upload_stream_with_id(bsoncxx::types::bson_value::view id, stdx::string_view filename, const options::gridfs::upload &options={})
Opens a gridfs::uploader to create a new GridFS file.
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={})
Opens a gridfs::uploader to create a new GridFS file.
stdx::string_view bucket_name() const
Gets the name of the GridFS bucket.
uploader open_upload_stream(const client_session &session, stdx::string_view filename, const options::gridfs::upload &options={})
Opens a gridfs::uploader to create a new GridFS file.
void download_to_stream(const client_session &session, bsoncxx::types::bson_value::view id, std::ostream *destination)
Downloads the contents of a stored GridFS file from the bucket and writes it to a stream.
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)
Downloads the contents of a stored GridFS file from the bucket and writes it to a stream.
cursor find(bsoncxx::document::view_or_value filter, const options::find &options={})
Finds the documents in the files collection of the bucket which match the provided filter.
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={})
Creates a new GridFS file with a user-supplied unique id by uploading bytes from an input stream.
void delete_file(const client_session &session, bsoncxx::types::bson_value::view id)
Deletes a GridFS file from the bucket.
downloader open_download_stream(const client_session &session, bsoncxx::types::bson_value::view id)
Opens a gridfs::downloader to read a GridFS file.
void download_to_stream(bsoncxx::types::bson_value::view id, std::ostream *destination)
Downloads the contents of a stored GridFS file from the bucket and writes it to a stream.
result::gridfs::upload upload_from_stream(const client_session &session, stdx::string_view filename, std::istream *source, const options::gridfs::upload &options={})
Creates a new GridFS file by uploading bytes from an input stream.
cursor find(const client_session &session, bsoncxx::document::view_or_value filter, const options::find &options={})
Finds the documents in the files collection of the bucket which match the provided filter.
void delete_file(bsoncxx::types::bson_value::view id)
Deletes a GridFS file from the bucket.
bucket() noexcept
Default constructs a bucket object.
void upload_from_stream_with_id(bsoncxx::types::bson_value::view id, stdx::string_view filename, std::istream *source, const options::gridfs::upload &options={})
Creates a new GridFS file with a user-supplied unique id by uploading bytes from an input stream.
result::gridfs::upload upload_from_stream(stdx::string_view filename, std::istream *source, const options::gridfs::upload &options={})
Creates a new GridFS file by uploading bytes from an input stream.
downloader open_download_stream(bsoncxx::types::bson_value::view id)
Opens a gridfs::downloader to read a GridFS file.
Class used to download a GridFS file.
Definition downloader.hpp:45
Class used to upload a GridFS file.
Definition uploader.hpp:40
Class representing the optional arguments to a MongoDB query.
Definition find.hpp:37
Class representing the optional arguments to a MongoDB GridFS bucket creation operation.
Definition bucket.hpp:35
Class representing the optional arguments to a MongoDB GridFS upload operation.
Definition upload.hpp:31
Class representing the result of a GridFS upload operation.
Definition upload.hpp:28
The top-level namespace for mongocxx library entities.
Definition bulk_write.hpp:24