API reference - Class QSql

Notation used in Ruby API documentation

Description: This class represents the QSql namespace

Public methods

voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference

Public static methods and constants

QSql_TableTypeAllTablesEnum constant QSql::AllTables
QSql_ParamTypeFlagBinaryEnum constant QSql::Binary
QSql_NumericalPrecisionPolicyHighPrecisionEnum constant QSql::HighPrecision
QSql_ParamTypeFlagInEnum constant QSql::In
QSql_ParamTypeFlagInOutEnum constant QSql::InOut
QSql_NumericalPrecisionPolicyLowPrecisionDoubleEnum constant QSql::LowPrecisionDouble
QSql_NumericalPrecisionPolicyLowPrecisionInt32Enum constant QSql::LowPrecisionInt32
QSql_NumericalPrecisionPolicyLowPrecisionInt64Enum constant QSql::LowPrecisionInt64
QSql_ParamTypeFlagOutEnum constant QSql::Out
QSql_TableTypeSystemTablesEnum constant QSql::SystemTables
QSql_TableTypeTablesEnum constant QSql::Tables
QSql_TableTypeViewsEnum constant QSql::Views

Detailed description

[static] QSql_TableType AllTables

Description: Enum constant QSql::AllTables

[static] QSql_ParamTypeFlag Binary

Description: Enum constant QSql::Binary

[static] QSql_NumericalPrecisionPolicy HighPrecision

Description: Enum constant QSql::HighPrecision

[static] QSql_ParamTypeFlag In

Description: Enum constant QSql::In

[static] QSql_ParamTypeFlag InOut

Description: Enum constant QSql::InOut

[static] QSql_NumericalPrecisionPolicy LowPrecisionDouble

Description: Enum constant QSql::LowPrecisionDouble

[static] QSql_NumericalPrecisionPolicy LowPrecisionInt32

Description: Enum constant QSql::LowPrecisionInt32

[static] QSql_NumericalPrecisionPolicy LowPrecisionInt64

Description: Enum constant QSql::LowPrecisionInt64

[static] QSql_ParamTypeFlag Out

Description: Enum constant QSql::Out

[static] QSql_TableType SystemTables

Description: Enum constant QSql::SystemTables

[static] QSql_TableType Tables

Description: Enum constant QSql::Tables

[static] QSql_TableType Views

Description: Enum constant QSql::Views

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.

void destroy

Description: Explicitly destroy the object

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

[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.

[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.