123 lines
4.2 KiB
C++
123 lines
4.2 KiB
C++
/**
|
|
*
|
|
* BucketsClient.h: InfluxDB Buckets Client
|
|
*
|
|
* MIT License
|
|
*
|
|
* Copyright (c) 2020 InfluxData
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*/
|
|
#ifndef _BUCKETS_CLIENT_H_
|
|
#define _BUCKETS_CLIENT_H_
|
|
|
|
#include <HTTPService.h>
|
|
#include <memory>
|
|
|
|
class BucketsClient;
|
|
class Test;
|
|
/**
|
|
* Bucket represents a bucket in the InfluxDB 2 server
|
|
**/
|
|
class Bucket {
|
|
friend class BucketsClient;
|
|
friend class Test;
|
|
public:
|
|
// Create empty, invalid, bucket instance
|
|
Bucket();
|
|
// Create a bucket instance
|
|
Bucket(const char *id, const char *name, const uint32_t expire);
|
|
// Copy constructor
|
|
Bucket(const Bucket &other);
|
|
// Assignment operator
|
|
Bucket &operator=(const Bucket &other);
|
|
// for testing validity
|
|
operator bool() const { return !isNull(); }
|
|
// Clean bucket
|
|
~Bucket();
|
|
// Returns Bucket ID
|
|
const char *getID() const { return _data?_data->id:nullptr; }
|
|
// Retuns bucket name
|
|
const char *getName() const { return _data?_data->name:nullptr; }
|
|
// Retention policy in sec, 0 - inifinite
|
|
uint32_t getExpire() const { return _data?_data->expire:0; }
|
|
// Checks if it is null instance
|
|
bool isNull() const { return _data == nullptr; }
|
|
// String representation
|
|
String toString() const;
|
|
private:
|
|
class Data {
|
|
public:
|
|
Data(const char *id, const char *name, const uint32_t expire);
|
|
~Data();
|
|
char *id;
|
|
char *name;
|
|
uint32_t expire;
|
|
};
|
|
std::shared_ptr<Data> _data;
|
|
};
|
|
|
|
class InfluxDBClient;
|
|
class E2ETest;
|
|
|
|
/**
|
|
* BucketsClient is a client for managing buckets in the InfluxDB 2 server
|
|
* A new bucket can be created, or a bucket can be checked for existence by its name.
|
|
* A bucket can be also deleted.
|
|
**/
|
|
class BucketsClient {
|
|
friend class InfluxDBClient;
|
|
friend class Test;
|
|
friend class E2ETest;
|
|
public:
|
|
// Copy contructor
|
|
BucketsClient(const BucketsClient &other);
|
|
// Assignment operator
|
|
BucketsClient &operator=(const BucketsClient &other);
|
|
// nullptr assignment for clearing
|
|
BucketsClient &operator=(std::nullptr_t);
|
|
// for testing validity
|
|
operator bool() const { return !isNull(); }
|
|
// Returns true if a bucket exists
|
|
bool checkBucketExists(const char *bucketName);
|
|
// Returns a Bucket instance if a bucket is found.
|
|
Bucket findBucket(const char *bucketName);
|
|
// Creates a bucket with given name and optional retention policy. 0 means infinite.
|
|
Bucket createBucket(const char *bucketName, uint32_t expiresSec = 0);
|
|
// Delete a bucket with given id. Use findBucket to get a bucket with id.
|
|
bool deleteBucket(const char *id);
|
|
// Returns last error message
|
|
String getLastErrorMessage() { return _data?_data->pConnInfo->lastError:""; }
|
|
// check validity
|
|
bool isNull() const { return _data == nullptr; }
|
|
protected:
|
|
BucketsClient();
|
|
BucketsClient(ConnectionInfo *pConnInfo, HTTPService *service);
|
|
String getOrgID(const char *org);
|
|
private:
|
|
class Data {
|
|
public:
|
|
Data(ConnectionInfo *pConnInfo, HTTPService *pService):pConnInfo(pConnInfo),pService(pService) {};
|
|
ConnectionInfo *pConnInfo;
|
|
HTTPService *pService;
|
|
};
|
|
std::shared_ptr<Data> _data;
|
|
};
|
|
#endif
|