pgsql_host_data_source.h

Go to the documentation of this file.

// Copyright (C) 2016-2023 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef PGSQL_HOST_DATA_SOURCE_H
#define PGSQL_HOST_DATA_SOURCE_H
 
#include <database/database_connection.h>
#include <dhcpsrv/base_host_data_source.h>
#include <pgsql/pgsql_connection.h>
#include <pgsql/pgsql_exchange.h>
 
namespace isc {
namespace dhcp {
 
class PgSqlHostDataSourceImpl;
 
typedef boost::shared_ptr<PgSqlHostDataSourceImpl> PgSqlHostDataSourceImplPtr;
 
class PgSqlHostContext;
 
typedef boost::shared_ptr<PgSqlHostContext> PgSqlHostContextPtr;
 
class PgSqlHostDataSource : public BaseHostDataSource {
public:
 
    PgSqlHostDataSource(const db::DatabaseConnection::ParameterMap& parameters);
 
    virtual ~PgSqlHostDataSource();
 
    virtual isc::db::DatabaseConnection::ParameterMap getParameters() const;
 
    virtual void add(const HostPtr& host);
 
    virtual bool del(const SubnetID& subnet_id,
                     const asiolink::IOAddress& addr);
 
    virtual bool del4(const SubnetID& subnet_id,
                      const Host::IdentifierType& identifier_type,
                      const uint8_t* identifier_begin,
                      const size_t identifier_len);
 
    virtual bool del6(const SubnetID& subnet_id,
                      const Host::IdentifierType& identifier_type,
                      const uint8_t* identifier_begin,
                      const size_t identifier_len);
 
    virtual ConstHostCollection getAll(const Host::IdentifierType& identifier_type,
                                       const uint8_t* identifier_begin,
                                       const size_t identifier_len) const;
 
    virtual ConstHostCollection getAll4(const SubnetID& subnet_id) const;
 
    virtual ConstHostCollection getAll6(const SubnetID& subnet_id) const;
 
    virtual ConstHostCollection getAllbyHostname(const std::string& hostname) const;
 
    virtual ConstHostCollection getAllbyHostname4(const std::string& hostname,
                                                  const SubnetID& subnet_id) const;
 
    virtual ConstHostCollection getAllbyHostname6(const std::string& hostname,
                                                  const SubnetID& subnet_id) const;
 
    virtual ConstHostCollection getPage4(const SubnetID& subnet_id,
                                         size_t& source_index,
                                         uint64_t lower_host_id,
                                         const HostPageSize& page_size) const;
 
    virtual ConstHostCollection getPage6(const SubnetID& subnet_id,
                                         size_t& source_index,
                                         uint64_t lower_host_id,
                                         const HostPageSize& page_size) const;
 
    virtual ConstHostCollection getPage4(size_t& source_index,
                                         uint64_t lower_host_id,
                                         const HostPageSize& page_size) const;
 
    virtual ConstHostCollection getPage6(size_t& source_index,
                                         uint64_t lower_host_id,
                                         const HostPageSize& page_size) const;
 
    virtual ConstHostCollection getAll4(const asiolink::IOAddress& address) const;
 
    virtual ConstHostPtr get4(const SubnetID& subnet_id,
                              const Host::IdentifierType& identifier_type,
                              const uint8_t* identifier_begin,
                              const size_t identifier_len) const;
 
    virtual ConstHostPtr get4(const SubnetID& subnet_id,
                              const asiolink::IOAddress& address) const;
 
    virtual ConstHostCollection
    getAll4(const SubnetID& subnet_id,
            const asiolink::IOAddress& address) const;
 
    virtual ConstHostPtr get6(const SubnetID& subnet_id,
                              const Host::IdentifierType& identifier_type,
                              const uint8_t* identifier_begin,
                              const size_t identifier_len) const;
 
    virtual ConstHostPtr get6(const asiolink::IOAddress& prefix,
                              const uint8_t prefix_len) const;
 
    virtual ConstHostPtr get6(const SubnetID& subnet_id,
                              const asiolink::IOAddress& address) const;
 
    virtual ConstHostCollection
    getAll6(const SubnetID& subnet_id,
            const asiolink::IOAddress& address) const;
 
    virtual ConstHostCollection getAll6(const asiolink::IOAddress& address) const;
 
    void update(HostPtr const& host);
 
    virtual std::string getType() const {
        return (std::string("postgresql"));
    }
 
    virtual std::string getName() const;
 
    virtual std::string getDescription() const;
 
    virtual std::pair<uint32_t, uint32_t> getVersion(const std::string& timer_name = std::string()) const;
 
    virtual void commit();
 
    virtual void rollback();
 
    virtual bool setIPReservationsUnique(const bool unique);
 
    virtual bool isUnusable();
 
    class PgSqlHostContextAlloc {
    public:
 
        PgSqlHostContextAlloc(PgSqlHostDataSourceImpl& mgr);
 
        ~PgSqlHostContextAlloc();
 
        PgSqlHostContextPtr ctx_;
 
    private:
        PgSqlHostDataSourceImpl& mgr_;
    };
 
private:
    PgSqlHostDataSourceImplPtr impl_;
};
 
}  // namespace dhcp
}  // namespace isc
 
#endif // PGSQL_HOST_DATA_SOURCE_H