# GdaExport

## Name

GdaExport -- Exporting of databases

## Synopsis

    struct      GdaExportPrivate;
    enum        GdaExportFlags;
    GdaExport*  gda_export_new                  (GdaConnection *cnc);
    GList*      gda_export_get_tables           (GdaExport *exp);
    GList*      gda_export_get_selected_tables  (GdaExport *exp);
    void        gda_export_select_table         (GdaExport *exp,
                                                 const gchar *table);
    void        gda_export_select_table_list    (GdaExport *exp,
                                                 GList *tables);
    void        gda_export_unselect_table       (GdaExport *exp,
                                                 const gchar *table);
    void        gda_export_run                  (GdaExport *exp,
                                                 GdaExportFlags flags);
    void        gda_export_stop                 (GdaExport *exp);
    GdaConnection* gda_export_get_connection    (GdaExport *exp);
    void        gda_export_set_connection       (GdaExport *exp,
                                                 GdaConnection *cnc);

## Description

## Details

### struct GdaExportPrivate

    struct GdaExportPrivate;

### enum GdaExportFlags

    typedef enum {
    	GDA_EXPORT_FLAGS_TABLE_DATA = 1
    } GdaExportFlags;

### gda_export_new ()

    GdaExport*  gda_export_new                  (GdaConnection *cnc);

Create a new GdaExport object, which allows you to easily add exporting functionality to your programs.

It works by first having a GdaConnection object associated to it, and then allowing you to retrieve information about all the objects present in the database, and also to add/remove those objects from a list of selected objects.

When you're done, you just run the export (gda_export_run), first connecting to the different signals that will let you be informed of the export process progress

`cnc` : | a GdaConnection object
Returns : | a newly allocated GdaExport object

### gda_export_get_tables ()

    GList*      gda_export_get_tables           (GdaExport *exp);

Return a list of all tables that exist in the GdaConnection being used. This function is useful when you're building, for example, a list for the user to select which tables he/she wants in the export process.

You are responsible to free the returned value yourself.

`exp` : |
Returns : | a GList containing the names of all the tables

### gda_export_get_selected_tables ()

    GList*      gda_export_get_selected_tables  (GdaExport *exp);

Return a list with the names of all the currently selected objects in the given GdaExport object.

You are responsible to free the returned value yourself.

`exp` : |
Returns : | a GList containing the names of the selected tables

### gda_export_select_table ()

    void        gda_export_select_table         (GdaExport *exp,
                                                 const gchar *table);

Add the given table to the list of selected tables

`exp` : |
`table` : | name of the table

### gda_export_select_table_list ()

    void        gda_export_select_table_list    (GdaExport *exp,
                                                 GList *tables);

Adds all the tables contained in the given list to the list of selected tables

`exp` : | a GdaExport object
`tables` : |

### gda_export_unselect_table ()

    void        gda_export_unselect_table       (GdaExport *exp,
                                                 const gchar *table);

Remove the given table name from the list of selected tables

`exp` : | a GdaExport object
`table` : | name of the table

### gda_export_run ()

    void        gda_export_run                  (GdaExport *exp,
                                                 GdaExportFlags flags);

Starts the execution of the given export object. This means that, after calling this function, your application will lose control about the export process and will only receive notifications via the class signals

`exp` : |
`flags` : | execution flags

### gda_export_stop ()

    void        gda_export_stop                 (GdaExport *exp);

`exp` : |

### gda_export_get_connection ()

    GdaConnection* gda_export_get_connection    (GdaExport *exp);

Return the GdaConnection object associated with the given GdaExport

`exp` : |
Returns : | the GdaConnection object being used

### gda_export_set_connection ()

    void        gda_export_set_connection       (GdaExport *exp,
                                                 GdaConnection *cnc);

`exp` : |
`cnc` : |