duckdb::BaseSecret Class Reference

Base class from which BaseSecret classes can be made. More...

#include <duckdb.hpp>

Inheritance diagram for duckdb::BaseSecret:

Collaboration diagram for duckdb::BaseSecret:

Public Member Functions
	BaseSecret (vector< string > prefix_paths_p, string type_p, string provider_p, string name_p)
	BaseSecret (const BaseSecret &other)
virtual int64_t	MatchScore (const string &path) const
virtual string	ToString (SecretDisplayType mode=SecretDisplayType::REDACTED) const
	Prints the secret as a string.
virtual void	Serialize (Serializer &serializer) const
	Serialize this secret.
virtual unique_ptr< const BaseSecret >	Clone () const
const vector< string > &	GetScope () const
	Getters.
const string &	GetType () const
const string &	GetProvider () const
const string &	GetName () const
bool	IsSerializable () const

Protected Member Functions
virtual void	SerializeBaseSecret (Serializer &serializer) const final
	Helper function to serialize the base BaseSecret class variables.

Protected Attributes
vector< string >	prefix_paths
	prefixes to which the secret applies
string	type
	Type of secret.
string	provider
	Provider of the secret.
string	name
	Name of the secret.
bool	serializable
	Whether the secret can be serialized/deserialized.

Friends
class	SecretManager

Detailed Description

Base class from which BaseSecret classes can be made.

Constructor & Destructor Documentation

BaseSecret() [1/2]

duckdb::BaseSecret::BaseSecret ( vector< string >  prefix_paths_p, string  type_p, string  provider_p, string  name_p  )

inline

        : prefix_paths(std::move(prefix_paths_p)), type(std::move(type_p)), provider(std::move(provider_p)),
          name(std::move(name_p)), serializable(false) {
        D_ASSERT(!type.empty());
    }

BaseSecret() [2/2]

duckdb::BaseSecret::BaseSecret ( const BaseSecret &  other )

inline

        : prefix_paths(other.prefix_paths), type(other.type), provider(other.provider), name(other.name),
          serializable(other.serializable) {
        D_ASSERT(!type.empty());
    }

Member Function Documentation

MatchScore()

virtual int64_t duckdb::BaseSecret::MatchScore ( const string &  path ) const

virtual

The score of how well this secret's scope matches the path (by default: the length of the longest matching prefix)

ToString()

virtual string duckdb::BaseSecret::ToString ( SecretDisplayType  mode = SecretDisplayType::REDACTED ) const

virtual

Prints the secret as a string.

Reimplemented in duckdb::KeyValueSecret.

Serialize()

virtual void duckdb::BaseSecret::Serialize ( Serializer &  serializer ) const

virtual

Serialize this secret.

Reimplemented in duckdb::KeyValueSecret.

Clone()

virtual unique_ptr< const BaseSecret > duckdb::BaseSecret::Clone ( ) const

inlinevirtual

                                                       {
        D_ASSERT(typeid(BaseSecret) == typeid(*this));
        return make_uniq<BaseSecret>(*this);
    }

GetScope()

const vector< string > & duckdb::BaseSecret::GetScope ( ) const

inline

Getters.

                                           {
        return prefix_paths;
    }

GetType()

const string & duckdb::BaseSecret::GetType ( ) const

inline

                                  {
        return type;
    }

GetProvider()

const string & duckdb::BaseSecret::GetProvider ( ) const

inline

                                      {
        return provider;
    }

GetName()

const string & duckdb::BaseSecret::GetName ( ) const

inline

                                  {
        return name;
    }

IsSerializable()

bool duckdb::BaseSecret::IsSerializable ( ) const

inline

                                {
        return serializable;
    }

---

The documentation for this class was generated from the following file:

• external/duckdb/duckdb.hpp