GETTEXT_PACKAGE

#define GETTEXT_PACKAGE "midgard"

MidgardConnection

typedef struct {
	gint errnum;
	gchar *errstr;
	GError *err;
} MidgardConnection;

MidgardConnectionClass

typedef struct MidgardConnectionClass MidgardConnectionClass;

midgard_connection_new ()

MidgardConnection * midgard_connection_new              (void);

Initializes new instance of MidgardConnection object type.

MidgardConnectionClass has no properties registered as class members. Every internal data of MidgardConnection object is accessible with API functions, and is not settable or gettable as property's value. Particular methods should be implemented for language bindings.

MidgardConnection objects holds runtime ( or request ) non persistent data like authentication type, debug level, etc.

Persistent data like database name, blobs directory are associated with MidgardConfig object.

midgard_connection_open ()

gboolean            midgard_connection_open             (MidgardConnection *self,
                                                         const gchar *name,
                                                         GError **error);

Opens a connection to the database, which is defined in named configuration. The configuration file is read from the system configuration directory and is used as the configuration for the created connection. For example: `/etc` directory is taken into account if library is compiled with `/usr' prefix, `/usr/local/etc` if compiled with `/usr/local` prefix, etc.

Consider using midgard_connection_open_config(), if you need to open connection to database which is configured in user's home directory.

If the named database configuration can not be read or the connection fails, then FALSE is returned and an error message is written to the global midgard error state.

It also initializes MidgardSchema object (which is encapsulated by implementation ) and register all MgdSchema, MidgardObject derived classes defined by user. This happens only when basic Midgard classes are not registered in GType system. This is recommended way to initialize MgdSchema types.

midgard_connection_close ()

void                midgard_connection_close            (MidgardConnection *self);

Closes connection to underlying storage. All private and public data remains unchanged, so connection might be reopened at any time. After closing connection, 'disconnected' signal is emitted.

Since 10.05.1

midgard_connection_open_config ()

gboolean            midgard_connection_open_config      (MidgardConnection *self,
                                                         MidgardConfig *config);

Opens a MidgardConnection with the given configuration.

Take a look at midgard_connection_open() wrt MidgardSchema.

If MidgardConnection is already associated with given config, method returns TRUE. If associated with another one, FALSE is returned and MGD_ERR_INTERNAL error is set.

midgard_connection_set_loglevel ()

gboolean            midgard_connection_set_loglevel     (MidgardConnection *self,
                                                         const gchar *level,
                                                         GLogFunc log_func);

Sets log level of the given MidgardConnection. Overwrites internal MidgardConnection's log level defined in configuration file. By default MidgardConnection holds loglevel which is associated with ( and duplicated from ) MidgardConfig. MidgardConfig object's log level isn't changed by this function

This method is a shortcut which sets correctly loghandler,loglevel and GLib's log function. Default log function will be used if NULL is defined. Core's default function is midgard_error_default_log.

Available levels: error, warn, warning, info, message, debug. warn is default loglevel, SQL queries are logged with debug level. With info level, function names ( and classes' names ) are ( at least should be) logged in language bindings

midgard_connection_get_loglevel ()

guint               midgard_connection_get_loglevel     (MidgardConnection *self);

midgard_connection_set_loghandler ()

void                midgard_connection_set_loghandler   (MidgardConnection *self,
                                                         guint loghandler);

Sets internal loghandler id associated with G_LOG_DOMAIN and loglevel. Caller is responsible to remove loghandler using g_log_remove_handler when new loglevel for G_LOG_DOMAIN is set.

See also: midgard_connection_set_loglevel

midgard_connection_get_loghandler ()

guint               midgard_connection_get_loghandler   (MidgardConnection *self);

midgard_connection_get_error ()

gint                midgard_connection_get_error        (MidgardConnection *self);

Error id may be one of set by midgard_error.

midgard_connection_get_error_string ()

const gchar *       midgard_connection_get_error_string (MidgardConnection *self);

Error string may be one set by midgard_error.

midgard_connection_set_error ()

void                midgard_connection_set_error        (MidgardConnection *self,
                                                         gint errcode);

Valid errcode is one defined in MidgardErrorGeneric.

midgard_connection_get_user ()

MidgardUser *       midgard_connection_get_user         (MidgardConnection *self);

NULL is explicitly returned if there's no midgard_user logged in for the given MidgardConnection. See also MidgardUser methods if you need midgard_person associated with user.

midgard_connection_copy ()

MidgardConnection * midgard_connection_copy             (MidgardConnection *self);

This function duplicates given MidgardConnection. It doesn't make deep copy. All persistant data are kept unchanged, but runtime related members are reset to default state. This function is helpful if application is forking and new processes might have different environment variables.

Call g_object_unref if returned object is no longer needed.

midgard_connection_reopen ()

gboolean            midgard_connection_reopen           (MidgardConnection *self);

This is MySQL optimized workaround for lost connection event.

midgard_connection_list_auth_types ()

gchar **            midgard_connection_list_auth_types  (MidgardConnection *self,
                                                         guint *n_types);

List available and registered authentication types. Use g_free() to free returned array.

midgard_connection_enable_replication ()

void                midgard_connection_enable_replication
                                                        (MidgardConnection *self,
                                                         gboolean toggle);

Enable or disable repligard table usage. If enabled, every base operation (create, update, delete) will be recorded in repligard table.

Since 10.05

midgard_connection_enable_quota ()

void                midgard_connection_enable_quota     (MidgardConnection *self,
                                                         gboolean toggle);

Enable or disable quota table usage. If enabled, every base operation (create, update, delete) will be recorded in quota table, limiting particular types usage.

Since 10.05

midgard_connection_enable_dbus ()

void                midgard_connection_enable_dbus      (MidgardConnection *self,
                                                         gboolean toggle);

Enable or disable dbus messages send for basic operation

Since 10.05

midgard_connection_enable_workspace ()

void                midgard_connection_enable_workspace (MidgardConnection *self,
                                                         gboolean toggle);

Enable or disable workspace (and contexts) support

Since 10.05.5

midgard_connection_is_enabled_replication ()

gboolean            midgard_connection_is_enabled_replication
                                                        (MidgardConnection *self);

Since 10.05

midgard_connection_is_enabled_quota ()

gboolean            midgard_connection_is_enabled_quota (MidgardConnection *self);

Since 10.05

midgard_connection_is_enabled_dbus ()

gboolean            midgard_connection_is_enabled_dbus  (MidgardConnection *self);

Since 10.05

midgard_connection_is_enabled_workspace ()

gboolean            midgard_connection_is_enabled_workspace
                                                        (MidgardConnection *self);

Since 10.05.5

midgard_connection_get_workspace ()

const MidgardWorkspaceStorage * midgard_connection_get_workspace
                                                        (MidgardConnection *self);

Since 10.05.5

midgard_connection_set_workspace ()

gboolean            midgard_connection_set_workspace    (MidgardConnection *self,
                                                         MidgardWorkspaceStorage *workspace);

Actual workspace scope depends on MidgardWorkspaceStorage implementation. For example, if MidgardWorkspaceContext is passed as workspace argument, Midgard environmental workspace is a tree context, which is the opposite of MidgardWorkspace which limits workspace scope to given one only.

Since 10.05.5

The "config" property

  "config"                   MidgardConfig*        : Read

A deep copy of config with empty database username and password values.

The "auth-changed" signal

void                user_function                      (MidgardConnection *midgardconnection,
                                                        gpointer           user_data)              : No Hooks

The "connected" signal

void                user_function                      (MidgardConnection *midgardconnection,
                                                        gpointer           user_data)              : No Hooks

The "disconnected" signal

void                user_function                      (MidgardConnection *midgardconnection,
                                                        gpointer           user_data)              : No Hooks

The "error" signal

void                user_function                      (MidgardConnection *arg0,
                                                        gpointer           user_data)      : No Hooks

error signal is emitted every time when error set is different than MGD_ERR_OK

The "lost-provider" signal

void                user_function                      (MidgardConnection *midgardconnection,
                                                        gpointer           user_data)              : No Hooks