![]() |
![]() |
![]() |
GNOME Data Access 4 manual | ![]() |
---|---|---|---|---|
Top | Description |
GdaServerOperation * gda_prepare_create_database (const gchar *provider
,const gchar *db_name
,GError **error
); gboolean gda_perform_create_database (const gchar *provider
,GdaServerOperation *op
,GError **error
); GdaServerOperation * gda_prepare_drop_database (const gchar *provider
,const gchar *db_name
,GError **error
); gboolean gda_perform_drop_database (const gchar *provider
,GdaServerOperation *op
,GError **error
); GdaDataModel * gda_execute_select_command (GdaConnection *cnc
,const gchar *sql
,GError **error
); gint gda_execute_non_select_command (GdaConnection *cnc
,const gchar *sql
,GError **error
); GdaServerOperation * gda_prepare_create_table (GdaConnection *cnc
,const gchar *table_name
,GError **error
,...
); gboolean gda_perform_create_table (GdaServerOperation *op
,GError **error
); GdaServerOperation * gda_prepare_drop_table (GdaConnection *cnc
,const gchar *table_name
,GError **error
); gboolean gda_perform_drop_table (GdaServerOperation *op
,GError **error
); gboolean gda_insert_row_into_table (GdaConnection *cnc
,const gchar *table
,GError **error
,...
); gboolean gda_update_row_in_table (GdaConnection *cnc
,const gchar *table
,const gchar *condition_column_name
,GValue *condition_value
,GError **error
,...
); gboolean gda_delete_row_from_table (GdaConnection *cnc
,const gchar *table
,const gchar *condition_column_name
,GValue *condition_value
,GError **error
); GdaStatement * gda_parse_sql_string (GdaConnection *cnc
,const gchar *sql
,GdaSet **params
,GError **error
); GdaDataHandler * gda_get_default_handler (GType for_type
);
GdaServerOperation * gda_prepare_create_database (const gchar *provider
,const gchar *db_name
,GError **error
);
gda_prepare_create_database
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_server_operation_prepare_create_database()
instead.
Creates a new GdaServerOperation object which contains the specifications required
to create a database. Once these specifications provided, use
gda_server_operation_perform_create_database()
to perform the database creation.
If db_name
is left NULL
, then the name of the database to create will have to be set in the
returned GdaServerOperation using gda_server_operation_set_value_at()
.
|
the database provider to use |
|
the name of the database to create, or NULL
|
|
a place to store errors, or NULL
|
Returns : |
new GdaServerOperation object, or NULL if the provider does not support database
creation. [transfer full][allow-none]
|
gboolean gda_perform_create_database (const gchar *provider
,GdaServerOperation *op
,GError **error
);
gda_perform_create_database
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_server_operation_perform_create_database()
instead.
Creates a new database using the specifications in op
. op
can be obtained using
gda_server_provider_create_operation()
, or gda_prepare_create_database()
.
|
the database provider to use, or NULL if op has been created using gda_server_operation_prepare_create_database()
|
|
a GdaServerOperation object obtained using gda_prepare_create_database()
|
|
a place to store en error, or NULL
|
Returns : |
TRUE if no error occurred and the database has been created, FALSE otherwise |
GdaServerOperation * gda_prepare_drop_database (const gchar *provider
,const gchar *db_name
,GError **error
);
gda_prepare_drop_database
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_server_operation_prepare_drop_database()
instead.
Creates a new GdaServerOperation object which contains the specifications required
to drop a database. Once these specifications provided, use
gda_perform_drop_database()
to perform the database creation.
If db_name
is left NULL
, then the name of the database to drop will have to be set in the
returned GdaServerOperation using gda_server_operation_set_value_at()
.
|
the database provider to use |
|
the name of the database to drop, or NULL
|
|
a place to store errors, or NULL
|
Returns : |
new GdaServerOperation object, or NULL if the provider does not support database
destruction. [transfer full][allow-none]
|
gboolean gda_perform_drop_database (const gchar *provider
,GdaServerOperation *op
,GError **error
);
gda_perform_drop_database
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_server_operation_perform_drop_database()
instead.
Destroys an existing database using the specifications in op
. op
can be obtained using
gda_server_provider_create_operation()
, or gda_server_operation_prepare_drop_database()
.
|
the database provider to use, or NULL if op has been created using gda_server_operation_prepare_drop_database()
|
|
a GdaServerOperation object obtained using gda_server_operation_prepare_drop_database()
|
|
a place to store en error, or NULL
|
Returns : |
TRUE if no error occurred and the database has been destroyed, FALSE otherwise |
GdaDataModel * gda_execute_select_command (GdaConnection *cnc
,const gchar *sql
,GError **error
);
gda_execute_select_command
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_connection_execute_select_command()
instead.
Execute a SQL SELECT command over an opened connection.
|
an opened connection |
|
a query statement must begin with "SELECT" |
|
a place to store errors, or NULL
|
Returns : |
a new GdaDataModel if successful, NULL otherwise. [transfer full][allow-none] |
gint gda_execute_non_select_command (GdaConnection *cnc
,const gchar *sql
,GError **error
);
gda_execute_non_select_command
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_connection_execute_non_select_command()
instead.
This is a convenience function to execute a SQL command over the opened connection.
|
an opened connection |
|
a query statement must begin with "SELECT" |
|
a place to store errors, or NULL
|
Returns : |
the number of rows affected or -1. |
GdaServerOperation * gda_prepare_create_table (GdaConnection *cnc
,const gchar *table_name
,GError **error
,...
);
gda_prepare_create_table
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_server_operation_prepare_create_table()
instead.
Add more arguments if the flag needs then:
GDA_EASY_CREATE_TABLE_FKEY_FLAG:
string with the table's name referenced
an integer with the number pairs "local_field", "referenced_field" used in the reference
Pairs of "local_field", "referenced_field" to use, must match the number specified above.
a string with the action for ON DELETE; can be: "RESTRICT", "CASCADE", "NO ACTION", "SET NULL" and "SET DEFAULT". Example: "ON UPDATE CASCADE".
a string with the action for ON UPDATE (see above).
Create a GdaServerOperation object using an opened connection, taking three arguments, a colum's name the column's GType and GdaEasyCreateTableFlag flag, you need to finish the list using NULL.
You'll be able to modify the GdaServerOperation object to add custom options to the operation. When finish call gda_perform_create_table or gda_server_operation_perform_operation in order to execute the operation.
|
an opened connection |
|
name of the table to create |
|
a place to store errors, or NULL
|
|
group of three arguments for column's name, column's GType and a GdaEasyCreateTableFlag flag, finished with NULL |
Returns : |
a GdaServerOperation if no errors; NULL and set error otherwise. [transfer full][allow-none]
|
gboolean gda_perform_create_table (GdaServerOperation *op
,GError **error
);
gda_perform_create_table
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_server_operation_perform_create_table()
instead.
Performs a prepared GdaServerOperation to create a table. This could perform
an operation created by gda_server_operation_prepare_create_table()
or any other using the
the GdaServerOperation API.
|
a valid GdaServerOperation |
|
a place to store errors, or NULL
|
Returns : |
TRUE if the table was created; FALSE and set error otherwise |
GdaServerOperation * gda_prepare_drop_table (GdaConnection *cnc
,const gchar *table_name
,GError **error
);
gda_prepare_drop_table
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_server_operation_prepare_drop_table()
instead.
This is just a convenient function to create a GdaServerOperation to drop a table in an opened connection.
|
an opened connection |
|
name of the table to drop |
|
a place to store errors, or NULL
|
Returns : |
a new GdaServerOperation or NULL if couldn't create the opereration. [transfer full][allow-none] |
gboolean gda_perform_drop_table (GdaServerOperation *op
,GError **error
);
gda_perform_drop_table
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_server_operation_perform_drop_table()
instead.
This is just a convenient function to perform a drop a table operation.
|
a GdaServerOperation object |
|
a place to store errors, or NULL
|
Returns : |
TRUE if the table was dropped, FALSE otherwise |
gboolean gda_insert_row_into_table (GdaConnection *cnc
,const gchar *table
,GError **error
,...
);
gda_insert_row_into_table
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_connection_insert_row_into_table()
instead.
This is a convenience function, which creates an INSERT statement and executes it using the values provided. It internally relies on variables which makes it immune to SQL injection problems.
The equivalent SQL command is: INSERT INTO <table> (<column_name> [,...]) VALUES (<column_name> = <new_value> [,...]).
|
an opened connection |
|
table's name to insert into |
|
a place to store errors, or NULL
|
|
a list of string/GValue pairs with the name of the column to use and the
GValue pointer containing the value to insert for the column (value can be NULL ), finished by a NULL . There must be
at least one column name and value |
Returns : |
TRUE if no error occurred, FALSE otherwise |
gboolean gda_update_row_in_table (GdaConnection *cnc
,const gchar *table
,const gchar *condition_column_name
,GValue *condition_value
,GError **error
,...
);
gda_update_row_in_table
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_connection_update_row_in_table()
instead.
This is a convenience function, which creates an UPDATE statement and executes it using the values provided. It internally relies on variables which makes it immune to SQL injection problems.
The equivalent SQL command is: UPDATE <table> SET <column_name> = <new_value> [,...] WHERE <condition_column_name> = <condition_value>.
|
an opened connection |
|
the table's name with the row's values to be updated |
|
the name of the column to used in the WHERE condition clause |
|
the condition_column_type 's GType |
|
a place to store errors, or NULL
|
|
a list of string/GValue pairs with the name of the column to use and the
GValue pointer containing the value to update the column to (value can be NULL ), finished by a NULL . There must be
at least one column name and value |
Returns : |
TRUE if no error occurred, FALSE otherwise |
gboolean gda_delete_row_from_table (GdaConnection *cnc
,const gchar *table
,const gchar *condition_column_name
,GValue *condition_value
,GError **error
);
gda_delete_row_from_table
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_connection_delete_row_from_table()
instead.
This is a convenience function, which creates a DELETE statement and executes it using the values provided. It internally relies on variables which makes it immune to SQL injection problems.
The equivalent SQL command is: DELETE FROM <table> WHERE <condition_column_name> = <condition_value>.
|
an opened connection |
|
the table's name with the row's values to be updated |
|
the name of the column to used in the WHERE condition clause |
|
the condition_column_type 's GType |
|
a place to store errors, or NULL
|
Returns : |
TRUE if no error occurred, FALSE otherwise |
GdaStatement * gda_parse_sql_string (GdaConnection *cnc
,const gchar *sql
,GdaSet **params
,GError **error
);
gda_parse_sql_string
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_connection_parse_sql_string()
instead.
This function helps to parse a SQL witch use paramenters and store them at params
.
|
a GdaConnection object, or NULL . [allow-none]
|
|
an SQL command to parse, not NULL
|
|
a place to store a new GdaSet, for parameters used in SQL command, or NULL . [out][allow-none][transfer full]
|
|
a place to store errors, or NULL
|
Returns : |
a GdaStatement representing the SQL command, or NULL if an error occurred. [transfer full][allow-none]
|
Since 4.2
GdaDataHandler * gda_get_default_handler (GType for_type
);
gda_get_default_handler
has been deprecated since version 4.2.3 and should not be used in newly-written code. Use gda_data_handler_get_default()
instead.
Obtain a pointer to a GdaDataHandler which can manage GValue values of type for_type
. The returned
data handler will be adapted to use the current locale information (for example dates will be formatted
taking into account the locale).
The returned pointer is NULL
if there is no default data handler available for the for_type
data type
|
a GType type |
Returns : |
a GdaDataHandler which must not be modified or destroyed. [transfer none] |