duckdb::KeyValueSecretReader Class Reference

Collaboration diagram for duckdb::KeyValueSecretReader:

Public Member Functions
	KeyValueSecretReader (const KeyValueSecret &secret_p, FileOpener &opener_p)
	Manually pass in a secret reference.
	KeyValueSecretReader (FileOpener &opener_p, optional_ptr< FileOpenerInfo > info, const char **secret_types, idx_t secret_types_len)
	Initializes the KeyValueSecretReader by fetching the secret automatically.
	KeyValueSecretReader (FileOpener &opener_p, optional_ptr< FileOpenerInfo > info, const char *secret_type)
	KeyValueSecretReader (DatabaseInstance &db, const char **secret_types, idx_t secret_types_len, string path)
	Initialize KeyValueSecretReader from a db instance.
	KeyValueSecretReader (DatabaseInstance &db, const char *secret_type, string path)
	KeyValueSecretReader (ClientContext &context, const char **secret_types, idx_t secret_types_len, string path)
	KeyValueSecretReader (ClientContext &context, const char *secret_type, string path)
SettingLookupResult	TryGetSecretKey (const string &secret_key, Value &result)
	Lookup a KeyValueSecret value.
SettingLookupResult	TryGetSecretKeyOrSetting (const string &secret_key, const string &setting_name, Value &result)
	Lookup a KeyValueSecret value or a setting.
Value	GetSecretKey (const string &secret_key)
	Lookup a KeyValueSecret value or a setting, throws InvalidInputException on not found.
Value	GetSecretKeyOrSetting (const string &secret_key, const string &setting_name)
	Lookup a KeyValueSecret value or a setting, throws InvalidInputException on not found.
template<class TYPE >
SettingLookupResult	TryGetSecretKey (const string &secret_key, TYPE &value_out)
	Templating around TryGetSecretKey.
template<class TYPE >
SettingLookupResult	TryGetSecretKeyOrSetting (const string &secret_key, const string &setting_name, TYPE &value_out)
	Templating around TryGetSecretOrSetting.
template<class TYPE >
TYPE	GetSecretKeyOrSettingOrDefault (const string &secret_key, const string &setting_name, TYPE default_value)

Protected Member Functions
void	Initialize (const char **secret_types, idx_t secret_types_len)
void	ThrowNotFoundError (const string &secret_key)
void	ThrowNotFoundError (const string &secret_key, const string &setting_name)

Protected Attributes
optional_ptr< const KeyValueSecret >	secret
	Fetching the secret.
shared_ptr< SecretEntry >	secret_entry
	Optionally an owning pointer to the secret entry.
optional_ptr< DatabaseInstance >	db
optional_ptr< ClientContext >	context
string	path

Member Function Documentation

TryGetSecretKey()

template<class TYPE >

SettingLookupResult duckdb::KeyValueSecretReader::TryGetSecretKey ( const string &  secret_key, TYPE &  value_out  )

inline

Templating around TryGetSecretKey.

                                                                                   {
        Value result;
        auto lookup_result = TryGetSecretKey(secret_key, result);
        if (lookup_result) {
            value_out = result.GetValue<TYPE>();
        }
        return lookup_result;
    }

Here is the call graph for this function:

TryGetSecretKeyOrSetting()

template<class TYPE >

SettingLookupResult duckdb::KeyValueSecretReader::TryGetSecretKeyOrSetting ( const string &  secret_key, const string &  setting_name, TYPE &  value_out  )

inline

Templating around TryGetSecretOrSetting.

                                                                  {
        Value result;
        auto lookup_result = TryGetSecretKeyOrSetting(secret_key, setting_name, result);
        if (lookup_result) {
            if (!result.IsNull()) {
                value_out = result.GetValue<TYPE>();
            }
        }
        return lookup_result;
    }

Here is the call graph for this function:

GetSecretKeyOrSettingOrDefault()

template<class TYPE >

TYPE duckdb::KeyValueSecretReader::GetSecretKeyOrSettingOrDefault ( const string &  secret_key, const string &  setting_name, TYPE  default_value  )

inline

                                                                                                                  {
        TYPE result;
        if (TryGetSecretKeyOrSetting(secret_key, setting_name, result)) {
            return result;
        }
        return default_value;
    }

Member Data Documentation

db

optional_ptr<DatabaseInstance> duckdb::KeyValueSecretReader::db

protected

Secrets/settings will be fetched either through a context (local + global settings) or a databaseinstance (global only)

---

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

• external/duckdb/duckdb.hpp