The AttachedDatabase represents an attached database instance. More...

Inheritance diagram for duckdb::AttachedDatabase:

[legend]

Collaboration diagram for duckdb::AttachedDatabase:

[legend]

Public Member Functions
	AttachedDatabase (DatabaseInstance &db, AttachedDatabaseType type=AttachedDatabaseType::SYSTEM_DATABASE)
	Create the built-in system database (without storage).

	AttachedDatabase (DatabaseInstance &db, Catalog &catalog, string name, string file_path, AttachOptions &options)
	Create an attached database instance with the specified name and storage.

	AttachedDatabase (DatabaseInstance &db, Catalog &catalog, StorageExtension &ext, ClientContext &context, string name, AttachInfo &info, AttachOptions &options)
	Create an attached database instance with the specified storage extension.

void	Initialize (optional_ptr< ClientContext > context=nullptr)
	Initializes the catalog and storage of the attached database.

void	FinalizeLoad (optional_ptr< ClientContext > context)

void	Close (const DatabaseCloseAction action)
	Close the database before shutting it down.

Catalog &	ParentCatalog () override

const Catalog &	ParentCatalog () const override

bool	HasStorageManager () const

StorageManager &	GetStorageManager ()

const StorageManager &	GetStorageManager () const

Catalog &	GetCatalog ()

TransactionManager &	GetTransactionManager ()

DatabaseInstance &	GetDatabase ()

optional_ptr< StorageExtension >	GetStorageExtension ()

const string &	GetName () const

void	SetName (const string &new_name)

bool	IsSystem () const

bool	IsTemporary () const

bool	IsReadOnly () const

bool	IsInitialDatabase () const

void	SetInitialDatabase ()

void	SetReadOnlyDatabase ()

void	OnDetach (ClientContext &context)

RecoveryMode	GetRecoveryMode () const

AttachVisibility	GetVisibility () const

const unordered_map< string, Value > &	GetAttachOptions () const

string	StoredPath () const

Public Member Functions inherited from duckdb::CatalogEntry
	CatalogEntry (CatalogType type, Catalog &catalog, string name)

	CatalogEntry (CatalogType type, string name, idx_t oid)

virtual unique_ptr< CatalogEntry >	AlterEntry (ClientContext &context, AlterInfo &info)

virtual unique_ptr< CatalogEntry >	AlterEntry (CatalogTransaction transaction, AlterInfo &info)

virtual void	UndoAlter (ClientContext &context, AlterInfo &info)

virtual void	Rollback (CatalogEntry &prev_entry)

virtual void	OnDrop ()

virtual unique_ptr< CatalogEntry >	Copy (ClientContext &context) const

virtual unique_ptr< CreateInfo >	GetInfo () const

virtual void	SetAsRoot ()
	Sets the CatalogEntry as the new root entry (i.e. the newest entry)

virtual string	ToSQL () const
	Convert the catalog entry to a SQL string that can be used to re-construct the catalog entry.

virtual SchemaCatalogEntry &	ParentSchema ()

virtual const SchemaCatalogEntry &	ParentSchema () const

virtual void	Verify (Catalog &catalog)

void	Serialize (Serializer &serializer) const

void	SetChild (unique_ptr< CatalogEntry > child)

unique_ptr< CatalogEntry >	TakeChild ()

bool	HasChild () const

bool	HasParent () const

CatalogEntry &	Child ()

CatalogEntry &	Parent ()

const CatalogEntry &	Parent () const

template<class TARGET >
TARGET &	Cast ()

template<class TARGET >
const TARGET &	Cast () const

Public Member Functions inherited from duckdb::enable_shared_from_this< AttachedDatabase >
shared_ptr< AttachedDatabase >	shared_from_this ()

shared_ptr< AttachedDatabase const >	shared_from_this () const

Static Public Member Functions
static bool	NameIsReserved (const string &name)

static string	ExtractDatabaseName (const string &dbpath, FileSystem &fs)

static void	InvokeCloseIfLastReference (shared_ptr< AttachedDatabase > &attached_database)

Static Public Member Functions inherited from duckdb::CatalogEntry
static unique_ptr< CreateInfo >	Deserialize (Deserializer &deserializer)

Private Member Functions
void	Cleanup ()
	Clean any (shared) resources held by the database.

Private Attributes
DatabaseInstance &	db

unique_ptr< StoredDatabasePath >	stored_database_path

unique_ptr< StorageManager >	storage

unique_ptr< Catalog >	catalog

unique_ptr< TransactionManager >	transaction_manager

AttachedDatabaseType	type

optional_ptr< Catalog >	parent_catalog

optional_ptr< StorageExtension >	storage_extension

RecoveryMode	recovery_mode = RecoveryMode::DEFAULT

AttachVisibility	visibility = AttachVisibility::SHOWN

bool	is_initial_database = false

bool	is_closed = false

shared_ptr< mutex >	close_lock

unordered_map< string, Value >	attach_options

Additional Inherited Members
Public Attributes inherited from duckdb::CatalogEntry
idx_t	oid
	The oid of the entry.

CatalogType	type
	The type of this catalog entry.

optional_ptr< CatalogSet >	set
	Reference to the catalog set this entry is stored in.

string	name
	The name of the entry.

bool	deleted
	Whether or not the object is deleted.

bool	temporary
	Whether or not the object is temporary and should not be added to the WAL.

bool	internal
	Whether or not the entry is an internal entry (cannot be deleted, not dumped, etc)

atomic< transaction_t >	timestamp
	Timestamp at which the catalog entry was created.

Value	comment
	(optional) comment on this entry

InsertionOrderPreservingMap< string >	tags
	(optional) extra data associated with this entry

Protected Member Functions inherited from duckdb::enable_shared_from_this< AttachedDatabase >
	enable_shared_from_this (enable_shared_from_this const &) noexcept

enable_shared_from_this &	operator= (enable_shared_from_this const &) noexcept

Detailed Description

The AttachedDatabase represents an attached database instance.

Member Function Documentation

◆ ParentCatalog() [1/2]

Catalog & duckdb::AttachedDatabase::ParentCatalog ( )

overridevirtual

Reimplemented from duckdb::CatalogEntry.

◆ ParentCatalog() [2/2]

const Catalog & duckdb::AttachedDatabase::ParentCatalog ( ) const

overridevirtual

Reimplemented from duckdb::CatalogEntry.

◆ GetDatabase()

DatabaseInstance & duckdb::AttachedDatabase::GetDatabase ( )

inline

                                    {
        return db;
    }

◆ GetStorageExtension()

optional_ptr< StorageExtension > duckdb::AttachedDatabase::GetStorageExtension ( )

inline

                                                         {
        return storage_extension;
    }

◆ GetName()

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

inline

                                  {
        return name;
    }

◆ SetName()

void duckdb::AttachedDatabase::SetName ( const string & new_name )

inline

                                         {
        name = new_name;
    }

◆ GetRecoveryMode()

RecoveryMode duckdb::AttachedDatabase::GetRecoveryMode ( ) const

inline

                                         {
        return recovery_mode;
    }

◆ GetVisibility()

AttachVisibility duckdb::AttachedDatabase::GetVisibility ( ) const

inline

                                           {
        return visibility;
    }

◆ GetAttachOptions()

const unordered_map< string, Value > & duckdb::AttachedDatabase::GetAttachOptions ( ) const

inline

                                                                 {
        return attach_options;
    }

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

external/duckdb/duckdb.hpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ParentCatalog() [1/2]

◆ ParentCatalog() [2/2]

◆ GetDatabase()

◆ GetStorageExtension()

◆ GetName()

◆ SetName()

◆ GetRecoveryMode()

◆ GetVisibility()

◆ GetAttachOptions()