API reference - Class QSql

Notation used in Ruby API documentation

Module: QtSql

Description: This class represents the QSql namespace

Sub-classes: Location, QFlags_Location, NumericalPrecisionPolicy, QFlags_NumericalPrecisionPolicy, ParamTypeFlag, QFlags_ParamTypeFlag, TableType, QFlags_TableType

Public constructors

new QSql ptrnewCreates a new object of this class

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const QSql other)Assigns another object to self
[const]new QSql ptrdupCreates a copy of self

Public static methods and constants

[static,const]QSql_LocationAfterLastRowEnum constant QSql::AfterLastRow
[static,const]QSql_TableTypeAllTablesEnum constant QSql::AllTables
[static,const]QSql_LocationBeforeFirstRowEnum constant QSql::BeforeFirstRow
[static,const]QSql_ParamTypeFlagBinaryEnum constant QSql::Binary
[static,const]QSql_NumericalPrecisionPolicyHighPrecisionEnum constant QSql::HighPrecision
[static,const]QSql_ParamTypeFlagInEnum constant QSql::In
[static,const]QSql_ParamTypeFlagInOutEnum constant QSql::InOut
[static,const]QSql_NumericalPrecisionPolicyLowPrecisionDoubleEnum constant QSql::LowPrecisionDouble
[static,const]QSql_NumericalPrecisionPolicyLowPrecisionInt32Enum constant QSql::LowPrecisionInt32
[static,const]QSql_NumericalPrecisionPolicyLowPrecisionInt64Enum constant QSql::LowPrecisionInt64
[static,const]QSql_ParamTypeFlagOutEnum constant QSql::Out
[static,const]QSql_TableTypeSystemTablesEnum constant QSql::SystemTables
[static,const]QSql_TableTypeTablesEnum constant QSql::Tables
[static,const]QSql_TableTypeViewsEnum constant QSql::Views

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

AfterLastRow

Signature: [static,const] QSql_Location AfterLastRow

Description: Enum constant QSql::AfterLastRow

Python specific notes:
The object exposes a readable attribute 'AfterLastRow'. This is the getter.

AllTables

Signature: [static,const] QSql_TableType AllTables

Description: Enum constant QSql::AllTables

Python specific notes:
The object exposes a readable attribute 'AllTables'. This is the getter.

BeforeFirstRow

Signature: [static,const] QSql_Location BeforeFirstRow

Description: Enum constant QSql::BeforeFirstRow

Python specific notes:
The object exposes a readable attribute 'BeforeFirstRow'. This is the getter.

Binary

Signature: [static,const] QSql_ParamTypeFlag Binary

Description: Enum constant QSql::Binary

Python specific notes:
The object exposes a readable attribute 'Binary'. This is the getter.

HighPrecision

Signature: [static,const] QSql_NumericalPrecisionPolicy HighPrecision

Description: Enum constant QSql::HighPrecision

Python specific notes:
The object exposes a readable attribute 'HighPrecision'. This is the getter.

In

Signature: [static,const] QSql_ParamTypeFlag In

Description: Enum constant QSql::In

Python specific notes:
The object exposes a readable attribute 'In'. This is the getter.

InOut

Signature: [static,const] QSql_ParamTypeFlag InOut

Description: Enum constant QSql::InOut

Python specific notes:
The object exposes a readable attribute 'InOut'. This is the getter.

LowPrecisionDouble

Signature: [static,const] QSql_NumericalPrecisionPolicy LowPrecisionDouble

Description: Enum constant QSql::LowPrecisionDouble

Python specific notes:
The object exposes a readable attribute 'LowPrecisionDouble'. This is the getter.

LowPrecisionInt32

Signature: [static,const] QSql_NumericalPrecisionPolicy LowPrecisionInt32

Description: Enum constant QSql::LowPrecisionInt32

Python specific notes:
The object exposes a readable attribute 'LowPrecisionInt32'. This is the getter.

LowPrecisionInt64

Signature: [static,const] QSql_NumericalPrecisionPolicy LowPrecisionInt64

Description: Enum constant QSql::LowPrecisionInt64

Python specific notes:
The object exposes a readable attribute 'LowPrecisionInt64'. This is the getter.

Out

Signature: [static,const] QSql_ParamTypeFlag Out

Description: Enum constant QSql::Out

Python specific notes:
The object exposes a readable attribute 'Out'. This is the getter.

SystemTables

Signature: [static,const] QSql_TableType SystemTables

Description: Enum constant QSql::SystemTables

Python specific notes:
The object exposes a readable attribute 'SystemTables'. This is the getter.

Tables

Signature: [static,const] QSql_TableType Tables

Description: Enum constant QSql::Tables

Python specific notes:
The object exposes a readable attribute 'Tables'. This is the getter.

Views

Signature: [static,const] QSql_TableType Views

Description: Enum constant QSql::Views

Python specific notes:
The object exposes a readable attribute 'Views'. This is the getter.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: void assign (const QSql other)

Description: Assigns another object to self

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QSql ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

Signature: [static] new QSql ptr new

Description: Creates a new object of this class

Python specific notes:
This method is the default initializer of the object.