QSqlResult#

The QSqlResult class provides an abstract interface for accessing data from specific SQL databases. More…

Synopsis#

Functions#

def addBindValue (val, type)
def at ()
def bindValueType (placeholder)
def bindValueType (pos)
def bindingSyntax ()
def boundValue (placeholder)
def boundValue (pos)
def boundValueCount ()
def boundValueName (pos)
def boundValues ()
def clear ()
def driver ()
def exec_ ()
def executedQuery ()
def hasOutValues ()
def isActive ()
def isForwardOnly ()
def isSelect ()
def isValid ()
def lastError ()
def lastQuery ()
def numericalPrecisionPolicy ()
def resetBindCount ()

Virtual functions#

def bindValue (placeholder, val, type)
def bindValue (pos, val, type)
def data (i)
def detachFromResultSet ()
def exec ()
def execBatch ([arrayBind=false])
def fetch (i)
def fetchFirst ()
def fetchLast ()
def fetchNext ()
def fetchPrevious ()
def handle ()
def isNull (i)
def lastInsertId ()
def nextResult ()
def numRowsAffected ()
def prepare (query)
def record ()
def reset (sqlquery)
def savePrepare (sqlquery)
def setActive (a)
def setAt (at)
def setForwardOnly (forward)
def setLastError (e)
def setNumericalPrecisionPolicy (policy)
def setQuery (query)
def setSelect (s)
def size ()

Detailed Description#

Normally, you would use QSqlQuery instead of QSqlResult , since QSqlQuery provides a generic wrapper for database-specific implementations of QSqlResult .

If you are implementing your own SQL driver (by subclassing QSqlDriver ), you will need to provide your own QSqlResult subclass that implements all the pure virtual functions and other virtual functions that you need.

See also

QSqlDriver

class PySide6.QtSql.QSqlResult(db)#

Parameters: db – PySide6.QtSql.QSqlDriver

Creates a QSqlResult using database driver db. The object is initialized to an inactive state.

See also

isActive() driver()

PySide6.QtSql.QSqlResult.BindingSyntax#

This enum type specifies the different syntaxes for specifying placeholders in prepared queries.

Constant

Description

QSqlResult.PositionalBinding

Use the ODBC-style positional syntax, with “?” as placeholders.

QSqlResult.NamedBinding

Use the Oracle-style syntax with named placeholders (e.g., “:id”)

See also

bindingSyntax()

Constant	Description
QSqlResult.PositionalBinding	Use the ODBC-style positional syntax, with “?” as placeholders.
QSqlResult.NamedBinding	Use the Oracle-style syntax with named placeholders (e.g., “:id”)

PySide6.QtSql.QSqlResult.VirtualHookOperation#

PySide6.QtSql.QSqlResult.addBindValue(val, type)#

Parameters

val – object
type – ParamType

Binds the value val of parameter type paramType to the next available position in the current record (row).

See also

bindValue()

PySide6.QtSql.QSqlResult.at()#

Return type: int

Returns the current (zero-based) row position of the result. May return the special values BeforeFirstRow or AfterLastRow .

See also

setAt() isValid()

PySide6.QtSql.QSqlResult.bindValue(placeholder, val, type)#

Parameters

placeholder – str
val – object
type – ParamType

This is an overloaded function.

Binds the value val of parameter type paramType to the placeholder name in the current record (row).

Note

Binding an undefined placeholder will result in undefined behavior.

See also

bindValue()

PySide6.QtSql.QSqlResult.bindValue(pos, val, type)

Parameters

pos – int
val – object
type – ParamType

Binds the value val of parameter type paramType to position index in the current record (row).

See also

addBindValue()

PySide6.QtSql.QSqlResult.bindValueType(placeholder)#

Parameters: placeholder – str
Return type: ParamType

This is an overloaded function.

Returns the parameter type for the value bound with the given placeholder name.

PySide6.QtSql.QSqlResult.bindValueType(pos)

Parameters: pos – int
Return type: ParamType

Returns the parameter type for the value bound at position index.

See also

boundValue()

PySide6.QtSql.QSqlResult.bindingSyntax()#

Return type: BindingSyntax

Returns the binding syntax used by prepared queries.

PySide6.QtSql.QSqlResult.boundValue(placeholder)#

Parameters: placeholder – str
Return type: object

This is an overloaded function.

Returns the value bound by the given placeholder name in the current record (row).

See also

bindValueType()

PySide6.QtSql.QSqlResult.boundValue(pos)

Parameters: pos – int
Return type: object

Returns the value bound at position index in the current record (row).

See also

bindValue() boundValues()

PySide6.QtSql.QSqlResult.boundValueCount()#

Return type: int

Returns the number of bound values in the result.

See also

boundValues()

PySide6.QtSql.QSqlResult.boundValueName(pos)#

Parameters: pos – int
Return type: str

Returns the name of the bound value at position index in the current record (row).

See also

boundValue()

PySide6.QtSql.QSqlResult.boundValues()#

Return type

Returns a vector of the result’s bound values for the current record (row).

See also

boundValueCount()

PySide6.QtSql.QSqlResult.clear()#

Clears the entire result set and releases any associated resources.

abstract PySide6.QtSql.QSqlResult.data(i)#

Parameters: i – int
Return type: object

Returns the data for field index in the current row as a QVariant . This function is only called if the result is in an active state and is positioned on a valid record and index is non-negative. Derived classes must reimplement this function and return the value of field index, or QVariant() if it cannot be determined.

PySide6.QtSql.QSqlResult.detachFromResultSet()#

PySide6.QtSql.QSqlResult.driver()#

Return type: PySide6.QtSql.QSqlDriver

Returns the driver associated with the result. This is the object that was passed to the constructor.

PySide6.QtSql.QSqlResult.exec()#

Return type: bool

Executes the query, returning true if successful; otherwise returns false.

See also

prepare()

PySide6.QtSql.QSqlResult.execBatch([arrayBind=false])#

Parameters: arrayBind – bool
Return type: bool

PySide6.QtSql.QSqlResult.exec_()#

Return type: bool

PySide6.QtSql.QSqlResult.executedQuery()#

Return type: str

Returns the query that was actually executed. This may differ from the query that was passed, for example if bound values were used with a prepared query and the underlying database doesn’t support prepared queries.

See also

exec() setQuery()

abstract PySide6.QtSql.QSqlResult.fetch(i)#

Parameters: i – int
Return type: bool

Positions the result to an arbitrary (zero-based) row index.

This function is only called if the result is in an active state. Derived classes must reimplement this function and position the result to the row index, and call setAt() with an appropriate value. Return true to indicate success, or false to signify failure.

See also

isActive() fetchFirst() fetchLast() fetchNext() fetchPrevious()

abstract PySide6.QtSql.QSqlResult.fetchFirst()#

Return type: bool

Positions the result to the first record (row 0) in the result.

This function is only called if the result is in an active state. Derived classes must reimplement this function and position the result to the first record, and call setAt() with an appropriate value. Return true to indicate success, or false to signify failure.

See also

fetch() fetchLast()

abstract PySide6.QtSql.QSqlResult.fetchLast()#

Return type: bool

Positions the result to the last record (last row) in the result.

This function is only called if the result is in an active state. Derived classes must reimplement this function and position the result to the last record, and call setAt() with an appropriate value. Return true to indicate success, or false to signify failure.

See also

fetch() fetchFirst()

PySide6.QtSql.QSqlResult.fetchNext()#

Return type: bool

Positions the result to the next available record (row) in the result.

This function is only called if the result is in an active state. The default implementation calls fetch() with the next index. Derived classes can reimplement this function and position the result to the next record in some other way, and call setAt() with an appropriate value. Return true to indicate success, or false to signify failure.

See also

fetch() fetchPrevious()

PySide6.QtSql.QSqlResult.fetchPrevious()#

Return type: bool

Positions the result to the previous record (row) in the result.

This function is only called if the result is in an active state. The default implementation calls fetch() with the previous index. Derived classes can reimplement this function and position the result to the next record in some other way, and call setAt() with an appropriate value. Return true to indicate success, or false to signify failure.

PySide6.QtSql.QSqlResult.handle()#

Return type: object

Returns the low-level database handle for this result set wrapped in a QVariant or an invalid QVariant if there is no handle.

Warning

Use this with uttermost care and only if you know what you’re doing.

Warning

The handle returned here can become a stale pointer if the result is modified (for example, if you clear it).

Warning

The handle can be NULL if the result was not executed yet.

Warning

PostgreSQL: in forward-only mode, the handle of QSqlResult can change after calling fetch() , fetchFirst() , fetchLast() , fetchNext() , fetchPrevious() , nextResult().

The handle returned here is database-dependent, you should query the type name of the variant before accessing it.

This example retrieves the handle for a sqlite result:

db = QSqlDatabase.database("sales")
query = QSqlQuery("SELECT NAME, DOB FROM EMPLOYEES", db)
v = query.result().handle()
if v.isValid() and qstrcmp(v.typeName(), "sqlite3_stmt*") == 0:
    # v.data() returns a pointer to the handle
    sqlite3_stmt handle = sqlite3_stmt(v.data())
    if handle:
        # ...

This snippet returns the handle for PostgreSQL or MySQL:

if qstrcmp(v.typeName(), "PGresult*") == 0:
    handle = PGresult(v.data())
    if handle:
        # ...


if qstrcmp(v.typeName(), "MYSQL_STMT*") == 0:
    MYSQL_STMT handle = MYSQL_STMT(v.data())
    if handle:
        # ...