duckdb::DatabaseManager Class Reference

The DatabaseManager is a class that sits at the root of all attached databases. More...

Collaboration diagram for duckdb::DatabaseManager:

Public Member Functions
	DatabaseManager (DatabaseInstance &db)
DatabaseInstance &	GetInstance ()
void	InitializeSystemCatalog ()
	Initializes the system catalog of the attached SYSTEM_DATABASE.
void	FinalizeStartup ()
	Finalize starting up the system.
optional_ptr< AttachedDatabase >	GetDatabase (ClientContext &context, const string &name)
	Get an attached database by its name.
shared_ptr< AttachedDatabase >	GetDatabase (const string &name)
shared_ptr< AttachedDatabase >	AttachDatabase (ClientContext &context, AttachInfo &info, AttachOptions &options)
	Attach a new database.
void	DetachDatabase (ClientContext &context, const string &name, OnEntryNotFound if_not_found)
	Detach an existing database.
void	Alter (ClientContext &context, AlterInfo &info)
	Alter operation dispatcher.
shared_ptr< AttachedDatabase >	DetachInternal (const string &name)
	Rollback the attach of a database.
Catalog &	GetSystemCatalog ()
	Returns a reference to the system catalog.
void	SetDefaultDatabase (ClientContext &context, const string &new_value)
InsertDatabasePathResult	InsertDatabasePath (const AttachInfo &info, AttachOptions &options)
	Inserts a path to name mapping to the database paths map.
void	GetDatabaseType (ClientContext &context, AttachInfo &info, const DBConfig &config, AttachOptions &options)
vector< shared_ptr< AttachedDatabase > >	GetDatabases (ClientContext &context, const optional_idx max_db_count=optional_idx())
vector< shared_ptr< AttachedDatabase > >	GetDatabases ()
	Scans the catalog set and returns each committed database entry.
idx_t	ApproxDatabaseCount ()
	Returns the approximate count of attached databases.
void	ResetDatabases ()
transaction_t	GetNewQueryNumber ()
transaction_t	ActiveQueryNumber () const
transaction_t	GetNewTransactionNumber ()
transaction_t	ActiveTransactionNumber () const
idx_t	NextOid ()
bool	HasDefaultDatabase ()
vector< string >	GetAttachedDatabasePaths ()
	Gets a list of all attached database paths.
shared_ptr< AttachedDatabase >	GetDatabaseInternal (const lock_guard< mutex > &, const string &name)

Static Public Member Functions
static DatabaseManager &	Get (DatabaseInstance &db)
static DatabaseManager &	Get (ClientContext &db)
static DatabaseManager &	Get (AttachedDatabase &db)
static const string &	GetDefaultDatabase (ClientContext &context)

Private Member Functions
optional_ptr< AttachedDatabase >	FinalizeAttach (ClientContext &context, AttachInfo &info, shared_ptr< AttachedDatabase > database)
void	RenameDatabase (ClientContext &context, const string &old_name, const string &new_name, OnEntryNotFound if_not_found)
	Rename an existing database.

Private Attributes
DatabaseInstance &	db
shared_ptr< AttachedDatabase >	system
	The system database is a special database that holds system entries (e.g. functions)
mutex	databases_lock
	Lock for databases.
case_insensitive_map_t< shared_ptr< AttachedDatabase > >	databases
	The set of attached databases.
atomic< idx_t >	next_oid
	The next object id handed out by the NextOid method.
atomic< transaction_t >	current_query_number
	The current query number.
atomic< transaction_t >	current_transaction_id
	The current transaction number.
string	default_database
	The current default database.
shared_ptr< DatabaseFilePathManager >	path_manager
	Manager for ensuring we never open the same database file twice in the same program.

Friends
class	Catalog

Detailed Description

The DatabaseManager is a class that sits at the root of all attached databases.

Member Function Documentation

GetInstance()

DatabaseInstance & duckdb::DatabaseManager::GetInstance ( )

inline

                                    {
        return db;
    }

GetDatabaseType()

void duckdb::DatabaseManager::GetDatabaseType	(	ClientContext &	context,
		AttachInfo &	info,
		const DBConfig &	config,
		AttachOptions &	options
	)

Returns the database type. This might require checking the header of the file, in which case the file handle is necessary. We can only grab the file handle, if it is not yet held, even for uncommitted changes. Thus, we have to lock for this operation.

GetDatabases()

vector< shared_ptr< AttachedDatabase > > duckdb::DatabaseManager::GetDatabases	(	ClientContext &	context,
		const optional_idx	max_db_count = optional_idx()
	)

Scans the catalog set and adds each committed database entry, and each database entry of the current transaction, to a vector holding AttachedDatabase references

ResetDatabases()

void duckdb::DatabaseManager::ResetDatabases

(

)

Removes all databases from the catalog set. This is necessary for the database instance's destructor, as the database manager has to be alive when destroying the catalog set objects.

GetNewQueryNumber()

transaction_t duckdb::DatabaseManager::GetNewQueryNumber ( )

inline

                                      {
        return current_query_number++;
    }

ActiveQueryNumber()

transaction_t duckdb::DatabaseManager::ActiveQueryNumber ( ) const

inline

                                            {
        return current_query_number;
    }

GetNewTransactionNumber()

transaction_t duckdb::DatabaseManager::GetNewTransactionNumber ( )

inline

                                            {
        return current_transaction_id++;
    }

ActiveTransactionNumber()

transaction_t duckdb::DatabaseManager::ActiveTransactionNumber ( ) const

inline

                                                  {
        return current_transaction_id;
    }

NextOid()

idx_t duckdb::DatabaseManager::NextOid ( )

inline

                    {
        return next_oid++;
    }

HasDefaultDatabase()

bool duckdb::DatabaseManager::HasDefaultDatabase ( )

inline

                              {
        return !default_database.empty();
    }

---

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

• external/duckdb/duckdb.hpp