aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/clickhouse/src/IO/S3/getObjectInfo.h
blob: 8804a9494eb24046824a4348e829e7623840d91a (plain) (blame)
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
#pragma once

#include "clickhouse_config.h"

#if USE_AWS_S3
#include <Storages/StorageS3Settings.h>
#include <base/types.h>
#include <IO/S3/Client.h>


namespace DB::S3
{

struct ObjectInfo
{
    size_t size = 0;
    time_t last_modification_time = 0;

    std::map<String, String> metadata = {}; /// Set only if getObjectInfo() is called with `with_metadata = true`.
};

ObjectInfo getObjectInfo(
    const S3::Client & client,
    const String & bucket,
    const String & key,
    const String & version_id = {},
    const S3Settings::RequestSettings & request_settings = {},
    bool with_metadata = false,
    bool for_disk_s3 = false,
    bool throw_on_error = true);

size_t getObjectSize(
    const S3::Client & client,
    const String & bucket,
    const String & key,
    const String & version_id = {},
    const S3Settings::RequestSettings & request_settings = {},
    bool for_disk_s3 = false,
    bool throw_on_error = true);

bool objectExists(
    const S3::Client & client,
    const String & bucket,
    const String & key,
    const String & version_id = {},
    const S3Settings::RequestSettings & request_settings = {},
    bool for_disk_s3 = false);

/// Throws an exception if a specified object doesn't exist. `description` is used as a part of the error message.
void checkObjectExists(
    const S3::Client & client,
    const String & bucket,
    const String & key,
    const String & version_id = {},
    const S3Settings::RequestSettings & request_settings = {},
    bool for_disk_s3 = false,
    std::string_view description = {});

bool isNotFoundError(Aws::S3::S3Errors error);

}

#endif