#include <dictdatabase.h>
Inheritance diagram for Gnome::Gda::DictDatabase:
Public Member Functions | |
virtual | ~DictDatabase () |
GdaDictDatabase* | gobj () |
Provides access to the underlying C GObject. | |
const GdaDictDatabase* | gobj () const |
Provides access to the underlying C GObject. | |
GdaDictDatabase* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
Glib::RefPtr<Dict> | get_dict () |
Fetch the GdaDict object to which the GdaDictDatabase belongs. | |
Glib::RefPtr<const Dict> | get_dict () const |
Fetch the GdaDict object to which the GdaDictDatabase belongs. | |
bool | update_dbms_data (GType limit_to_type, const Glib::ustring& limit_obj_name, std::auto_ptr<Glib::Error>& error) |
Synchronises the database representation with the database structure which is stored in the DBMS. | |
void | stop_update_dbms_data () const |
When the database updates its internal lists of DBMS objects, a call to this function will stop that update process. | |
Glib::RefPtr<DictTable> | get_table_by_name (const Glib::ustring& name) |
Get a reference to a GdaDictTable using its name. | |
Glib::RefPtr<const DictTable> | get_table_by_name (const Glib::ustring& name) const |
Get a reference to a GdaDictTable using its name. | |
Glib::RefPtr<DictTable> | get_table_by_xml_id (const Glib::ustring& xml_id) |
Get a reference to a GdaDictTable using its XML id. | |
Glib::RefPtr<const DictTable> | get_table_by_xml_id (const Glib::ustring& xml_id) const |
Get a reference to a GdaDictTable using its XML id. | |
Glib::RefPtr<DictField> | get_field_by_name (const Glib::ustring& fullname) |
Get a reference to a GdaDictField specifying the full name (table_name.field_name) of the requested field. | |
Glib::RefPtr<const DictField> | get_field_by_name (const Glib::ustring& fullname) const |
Get a reference to a GdaDictField specifying the full name (table_name.field_name) of the requested field. | |
Glib::RefPtr<DictField> | get_field_by_xml_id (const Glib::ustring& xml_id) |
Get a reference to a GdaDictField specifying its XML id. | |
Glib::RefPtr<const DictField> | get_field_by_xml_id (const Glib::ustring& xml_id) const |
Get a reference to a GdaDictField specifying its XML id. | |
void | add_constraint (const Glib::RefPtr<DictConstraint>& cstr) |
Add the cstr constraint to the database. | |
Static Public Member Functions | |
static Glib::RefPtr<DictDatabase> | create () |
Protected Member Functions | |
DictDatabase () | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr<Gnome::Gda::DictDatabase> | wrap (GdaDictDatabase* object, bool take_copy=false) |
This object manages an internal dictionary mirroring the real database structure with objects such as DictTable (composed of Dictfield objects) and DictConstraint.
virtual Gnome::Gda::DictDatabase::~DictDatabase | ( | ) | [virtual] |
Gnome::Gda::DictDatabase::DictDatabase | ( | ) | [protected] |
void Gnome::Gda::DictDatabase::add_constraint | ( | const Glib::RefPtr<DictConstraint>& | cstr | ) |
Add the cstr constraint to the database.
The cstr constraint is a user-defined constraint (which is not part of the database structure itself).
cstr | A Gda::DictConstraint. |
static Glib::RefPtr<DictDatabase> Gnome::Gda::DictDatabase::create | ( | ) | [static] |
Reimplemented from Gnome::Gda::Object.
Glib::RefPtr<const Dict> Gnome::Gda::DictDatabase::get_dict | ( | ) | const |
Fetch the GdaDict object to which the GdaDictDatabase belongs.
Reimplemented from Gnome::Gda::Object.
Glib::RefPtr<Dict> Gnome::Gda::DictDatabase::get_dict | ( | ) |
Fetch the GdaDict object to which the GdaDictDatabase belongs.
Reimplemented from Gnome::Gda::Object.
Glib::RefPtr<const DictField> Gnome::Gda::DictDatabase::get_field_by_name | ( | const Glib::ustring & | fullname | ) | const |
Get a reference to a GdaDictField specifying the full name (table_name.field_name) of the requested field.
fullname | The name of the requested table field. |
0
if the requested field does not exist. Glib::RefPtr<DictField> Gnome::Gda::DictDatabase::get_field_by_name | ( | const Glib::ustring & | fullname | ) |
Get a reference to a GdaDictField specifying the full name (table_name.field_name) of the requested field.
fullname | The name of the requested table field. |
0
if the requested field does not exist. Glib::RefPtr<const DictField> Gnome::Gda::DictDatabase::get_field_by_xml_id | ( | const Glib::ustring & | xml_id | ) | const |
Get a reference to a GdaDictField specifying its XML id.
xml_id | The XML id of the requested table field. |
0
if the requested field does not exist. Glib::RefPtr<DictField> Gnome::Gda::DictDatabase::get_field_by_xml_id | ( | const Glib::ustring & | xml_id | ) |
Get a reference to a GdaDictField specifying its XML id.
xml_id | The XML id of the requested table field. |
0
if the requested field does not exist. Glib::RefPtr<const DictTable> Gnome::Gda::DictDatabase::get_table_by_name | ( | const Glib::ustring & | name | ) | const |
Get a reference to a GdaDictTable using its name.
name | The name of the requested table. |
0
if the requested table does not exist. Glib::RefPtr<DictTable> Gnome::Gda::DictDatabase::get_table_by_name | ( | const Glib::ustring & | name | ) |
Get a reference to a GdaDictTable using its name.
name | The name of the requested table. |
0
if the requested table does not exist. Glib::RefPtr<const DictTable> Gnome::Gda::DictDatabase::get_table_by_xml_id | ( | const Glib::ustring & | xml_id | ) | const |
Get a reference to a GdaDictTable using its XML id.
xml_id | The XML id of the requested table. |
0
if the requested table does not exist. Glib::RefPtr<DictTable> Gnome::Gda::DictDatabase::get_table_by_xml_id | ( | const Glib::ustring & | xml_id | ) |
Get a reference to a GdaDictTable using its XML id.
xml_id | The XML id of the requested table. |
0
if the requested table does not exist. const GdaDictDatabase* Gnome::Gda::DictDatabase::gobj | ( | ) | const [inline] |
GdaDictDatabase* Gnome::Gda::DictDatabase::gobj | ( | ) | [inline] |
GdaDictDatabase* Gnome::Gda::DictDatabase::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Reimplemented from Gnome::Gda::Object.
void Gnome::Gda::DictDatabase::stop_update_dbms_data | ( | ) | const |
When the database updates its internal lists of DBMS objects, a call to this function will stop that update process.
It has no effect when the database is not updating its DBMS data.
bool Gnome::Gda::DictDatabase::update_dbms_data | ( | GType | limit_to_type, | |
const Glib::ustring & | limit_obj_name, | |||
std::auto_ptr< Glib::Error > & | error | |||
) |
Synchronises the database representation with the database structure which is stored in the DBMS.
For this operation to succeed, the connection to the DBMS server MUST be opened (using the corresponding Gda::Connection object).
limit_to_type | Limit the DBMS update to this type, or 0 for no limit. | |
limit_obj_name | Limit the DBMS update to objects of this name, or 0 for no limit. | |
error | Location to store error, or 0 . |
true
if no error.
Glib::RefPtr<Gnome::Gda::DictDatabase> wrap | ( | GdaDictDatabase * | object, | |
bool | take_copy = false | |||
) | [related] |
object | The C instance | |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |