duckdb::ClientContextState Class Reference

Public Member Functions
virtual void	QueryBegin (ClientContext &context)
virtual void	QueryEnd ()
virtual void	QueryEnd (ClientContext &context)
virtual void	QueryEnd (ClientContext &context, optional_ptr< ErrorData > error)
virtual void	TransactionBegin (MetaTransaction &transaction, ClientContext &context)
virtual void	TransactionCommit (MetaTransaction &transaction, ClientContext &context)
virtual void	TransactionRollback (MetaTransaction &transaction, ClientContext &context)
virtual void	TransactionRollback (MetaTransaction &transaction, ClientContext &context, optional_ptr< ErrorData > error)
virtual bool	CanRequestRebind ()
virtual RebindQueryInfo	OnPlanningError (ClientContext &context, SQLStatement &statement, ErrorData &error)
virtual RebindQueryInfo	OnFinalizePrepare (ClientContext &context, PreparedStatementData &prepared_statement, PreparedStatementMode mode)
virtual RebindQueryInfo	OnExecutePrepared (ClientContext &context, PreparedStatementCallbackInfo &info, RebindQueryInfo current_rebind)
virtual RebindQueryInfo	OnRebindPreparedStatement (ClientContext &context, BindPreparedStatementCallbackInfo &info, RebindQueryInfo current_rebind)
virtual void	WriteProfilingInformation (std::ostream &ss)
virtual void	OnTaskStart (ClientContext &context)
virtual void	OnTaskStop (ClientContext &context)
template<class TARGET >
TARGET &	Cast ()
template<class TARGET >
const TARGET &	Cast () const

Detailed Description

ClientContextState is virtual base class for ClientContext-local (or Query-Local, using QueryEnd callback) state e.g. caches that need to live as long as a ClientContext or Query.

Member Function Documentation

QueryBegin()

virtual void duckdb::ClientContextState::QueryBegin ( ClientContext &  context )

inlinevirtual

                                                    {
    }

QueryEnd() [1/3]

virtual void duckdb::ClientContextState::QueryEnd ( )

inlinevirtual

                            {
    }

QueryEnd() [2/3]

virtual void duckdb::ClientContextState::QueryEnd ( ClientContext &  context )

inlinevirtual

                                                  {
        QueryEnd();
    }

QueryEnd() [3/3]

virtual void duckdb::ClientContextState::QueryEnd ( ClientContext &  context, optional_ptr< ErrorData >  error  )

inlinevirtual

                                                                                 {
        QueryEnd(context);
    }

TransactionBegin()

virtual void duckdb::ClientContextState::TransactionBegin ( MetaTransaction &  transaction, ClientContext &  context  )

inlinevirtual

                                                                                        {
    }

TransactionCommit()

virtual void duckdb::ClientContextState::TransactionCommit ( MetaTransaction &  transaction, ClientContext &  context  )

inlinevirtual

                                                                                         {
    }

TransactionRollback() [1/2]

virtual void duckdb::ClientContextState::TransactionRollback ( MetaTransaction &  transaction, ClientContext &  context  )

inlinevirtual

                                                                                           {
    }

TransactionRollback() [2/2]

virtual void duckdb::ClientContextState::TransactionRollback ( MetaTransaction &  transaction, ClientContext &  context, optional_ptr< ErrorData >  error  )

inlinevirtual

                                                                    {
        TransactionRollback(transaction, context);
    }

CanRequestRebind()

virtual bool duckdb::ClientContextState::CanRequestRebind ( )

inlinevirtual

                                    {
        return false;
    }

OnPlanningError()

virtual RebindQueryInfo duckdb::ClientContextState::OnPlanningError ( ClientContext &  context, SQLStatement &  statement, ErrorData &  error  )

inlinevirtual

                                                                                                               {
        return RebindQueryInfo::DO_NOT_REBIND;
    }

OnFinalizePrepare()

virtual RebindQueryInfo duckdb::ClientContextState::OnFinalizePrepare ( ClientContext &  context, PreparedStatementData &  prepared_statement, PreparedStatementMode  mode  )

inlinevirtual

                                                                          {
        return RebindQueryInfo::DO_NOT_REBIND;
    }

OnExecutePrepared()

virtual RebindQueryInfo duckdb::ClientContextState::OnExecutePrepared ( ClientContext &  context, PreparedStatementCallbackInfo &  info, RebindQueryInfo  current_rebind  )

inlinevirtual

                                                                              {
        return RebindQueryInfo::DO_NOT_REBIND;
    }

OnRebindPreparedStatement()

virtual RebindQueryInfo duckdb::ClientContextState::OnRebindPreparedStatement ( ClientContext &  context, BindPreparedStatementCallbackInfo &  info, RebindQueryInfo  current_rebind  )

inlinevirtual

                                                                                      {
        return RebindQueryInfo::DO_NOT_REBIND;
    }

WriteProfilingInformation()

virtual void duckdb::ClientContextState::WriteProfilingInformation ( std::ostream &  ss )

inlinevirtual

                                                           {
    }

OnTaskStart()

virtual void duckdb::ClientContextState::OnTaskStart ( ClientContext &  context )

inlinevirtual

                                                     {
    }

OnTaskStop()

virtual void duckdb::ClientContextState::OnTaskStop ( ClientContext &  context )

inlinevirtual

                                                    {
    }

Cast() [1/2]

template<class TARGET >

TARGET & duckdb::ClientContextState::Cast ( )

inline

                   {
        DynamicCastCheck<TARGET>(this);
        return reinterpret_cast<TARGET &>(*this);
    }

Cast() [2/2]

template<class TARGET >

const TARGET & duckdb::ClientContextState::Cast ( ) const

inline

                               {
        DynamicCastCheck<TARGET>(this);
        return reinterpret_cast<const TARGET &>(*this);
    }

---

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

• external/duckdb/duckdb.hpp