logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

OpenDBX::Stmt - Statement object.

Author

       Generated automatically by Doxygen for opendbx from the source code.

Version 1.4.6                                Wed Jan 8 2025 18:03:29                            OpenDBX::Stmt(3)

Constructor & Destructor Documentation

OpenDBX::Stmt::Stmt()[inline],[protected]
       Default constructor. The default constructor isn't part of the public interface as the object must not be
       created manually. Instead, the Conn::create() method is a factory for instances of the Stmt class.

       Returns
           Statement instance

   OpenDBX::Stmt::Stmt(Stmt_Iface*impl)std::exception[protected]
       Creates a statement instance. The constructor isn't part of the public interface as the object must not
       be created manually. Instead, the Conn::create() method is a factory for instances of the Stmt class.

       Parametersimpl Pointer to private implementation

       Exceptionsstd::exception If an error occures

       Returns
           Statement instance

   OpenDBX::Stmt::~Stmt()
       Destroys the statement instance if no other references exist. Each statement object uses a reference
       counter to remember if the internal variables are shared with other objects. If this isn't the case or if
       this object is the last one referencing the variables, the object is cleaned up and the allocated memory
       freed.

   OpenDBX::Stmt::Stmt(constStmt&ref)
       Copy constructor. Enables the transfer of the internal state of an object ref of the same type to this
       object. Both objects share the same variables and the reference counter afterwards. The reference counter
       is incremented each time an object is copied and will be decremented if it is destroyed.

       Parametersref Original statement object instance

Detailed Description

       Statement object.

       Author
           Norbert Sendetzky norbert@linuxnetworks.deVersion
           1.0

Member Enumeration Documentation

enumOpenDBX::Stmt::Type
       Statement objects which can be created. Currently, only simple processing of statements is supported
       which means that the statement sent to the database server consists of the statement and the parameters
       in text form. Later on, also prepared statements will be available which separates parsing and execution
       with different parameters.

Member Function Documentation

ResultOpenDBX::Stmt::execute()std::exception
       Executes a statement and returns a Result instance. Sends the necessary data to the database server which
       will execute the statement and return one or more result sets afterwards. The result sets can be fetched
       via the returned Result object.

       ReturnsResult instance

       ExceptionsOpenDBX::ExceptionIftheunderlyingdatabaselibraryreturnsanerrorSeealsoResultStmt&OpenDBX::Stmt::operator=(constStmt&ref)
       Assigns a statement instance to another one. Assigns the internal state of an object ref of the same type
       to this object. Both objects share the same variables and the reference counter afterwards. The reference
       counter is incremented each time an object is copied and will be decremented if it is destroyed.

       ParametersrefStmt instance

       Returns
           Statement reference of this instance

Name

       OpenDBX::Stmt - Statement object.

Synopsis

PublicTypes
       enum Type
           Statement objects which can be created.

   PublicMemberFunctionsResultexecute ()  throw ( std::exception )
           Executes a statement and returns a Result instance.
       Stmt & operator= (const Stmt &ref)  throw ()
           Assigns a statement instance to another one.
       Stmt (const Stmt &ref)  throw ()
           Copy constructor.
       ~Stmt ()  throw ()
           Destroys the statement instance if no other references exist.

   ProtectedMemberFunctionsStmt ()  throw ()
           Default constructor.
       Stmt (Stmt_Iface *impl)  throw ( std::exception )
           Creates a statement instance.

See Also