summaryrefslogtreecommitdiff
path: root/src/mongo/db/catalog/virtual_collection_options.h
blob: 433976ab3e5b90fb2111c6b19617249a1183f88c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/**
 *    Copyright (C) 2022-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#pragma once

#include <cstdint>
#include <fmt/format.h>
#include <string>
#include <vector>

#include "mongo/base/string_data.h"
#include "mongo/db/pipeline/aggregate_command_gen.h"
#include "mongo/db/pipeline/external_data_source_option_gen.h"
#include "mongo/util/assert_util.h"

namespace mongo {

/**
 * Metadata for external data source.
 */
struct ExternalDataSourceMetadata {
    static constexpr auto kUrlProtocolFile = "file://"_sd;
#ifndef _WIN32
    static constexpr auto kDefaultFileUrlPrefix = "file:///tmp/"_sd;
#else
    static constexpr auto kDefaultFileUrlPrefix = "file:////./pipe/"_sd;
#endif

    ExternalDataSourceMetadata(const std::string& url,
                               StorageTypeEnum storageType,
                               FileTypeEnum fileType)
        : storageType(storageType), fileType(fileType) {
        using namespace fmt::literals;
        uassert(6968500,
                "File url must start with {}"_format(kDefaultFileUrlPrefix),
                url.find(kDefaultFileUrlPrefix.toString()) == 0);
        uassert(6968501, "Storage type must be 'pipe'", storageType == StorageTypeEnum::pipe);
        uassert(6968502, "File type must be 'bson'", fileType == FileTypeEnum::bson);

        // Strip off the protocol prefix.
        this->url = url.substr(kUrlProtocolFile.size());
    }

    ExternalDataSourceMetadata(const ExternalDataSourceInfo& dataSourceInfo)
        : ExternalDataSourceMetadata(dataSourceInfo.getUrl().toString(),
                                     dataSourceInfo.getStorageType(),
                                     dataSourceInfo.getFileType()) {}

    /**
     * Url for an external data source
     */
    std::string url;

    /**
     * Storage type for an external data source
     */
    StorageTypeEnum storageType;

    /**
     * File type for an external data source
     */
    FileTypeEnum fileType;
};

/**
 * Options for virtual collection.
 */
struct VirtualCollectionOptions {
    VirtualCollectionOptions() : dataSources() {}
    VirtualCollectionOptions(std::vector<ExternalDataSourceMetadata> dataSources)
        : dataSources(std::move(dataSources)) {}
    VirtualCollectionOptions(const std::vector<ExternalDataSourceInfo>& options) {
        for (auto&& dataSource : options) {
            dataSources.emplace_back(dataSource);
        }
    }

    /**
     * Specification for external data sources.
     */
    std::vector<ExternalDataSourceMetadata> dataSources;
};
}  // namespace mongo