| Top |  |
 |
 |
 |
Functions
Properties
| GdaConnection * | connection | Read / Write / Construct Only |
| gint | op-type | Read / Write / Construct Only |
| GdaServerProvider * | provider | Read / Write / Construct Only |
| gchar * | spec-filename | Write / Construct Only |
| gchar * | spec-resource | Write / Construct Only |
Object Hierarchy
GBoxed ├── GdaServerOperationCreateTableArg ├── GdaServerOperationCreateTableArgFKeyRefField ╰── GdaServerOperationNode GObject ╰── GdaServerOperation
Description
This object is basically just a data store: it can store named values, the values being
organized hierarchically by their name which are similar to a Unix file path. For example a value can be read from its path
using the gda_server_operation_get_value_at() method, or set using the gda_server_operation_set_value_at() method.
Each GdaServerOperation contains some structure which is usually defined by a database provider to implement a specific operation. The structure is composed of the following building blocks:
Named values (internally represented as a GdaHolder object)
Named values in a vector (internally represented as a GdaSet object)
Values in an array (internally represented as a GdaDataModel object)
Sequences of one or more of the previous blocks. A sequence can contain any number of instances of the template block (there may be lower and upper boundaries to the number of instances)
Important note: GdaServerOperation objects are usually not created
manually using gda_server_operation_new(), but
using a GdaServerProvider object with gda_server_provider_create_operation().
See the global introduction about DDL for more information.
Alternatively one can use the Convenience functions
which internally manipulate GdaServerOperation objects.
Functions
gda_server_operation_node_copy ()
GdaServerOperationNode *
gda_server_operation_node_copy (GdaServerOperationNode *src);
gda_server_operation_node_free ()
void
gda_server_operation_node_free (GdaServerOperationNode *src);
gda_server_operation_new ()
GdaServerOperation * gda_server_operation_new (GdaServerOperationType op_type,const gchar *xml_file);
IMPORTANT NOTE: Using this funtion is not the recommended way of creating a GdaServerOperation object, the
correct way is to use gda_server_provider_create_operation(); this method is reserved for the database provider's
implementation.
Creates a new GdaServerOperation object from the xml_file
specifications
The xml_file
must respect the DTD described in the "libgda-server-operation.dtd" file: its top
node must be a <serv_op> tag.
gda_server_operation_get_op_type ()
GdaServerOperationType
gda_server_operation_get_op_type (GdaServerOperation *op);
Get the type of operation op
is for
gda_server_operation_op_type_to_string ()
const gchar *
gda_server_operation_op_type_to_string
(GdaServerOperationType type);
Get a string version of type
gda_server_operation_string_to_op_type ()
GdaServerOperationType
gda_server_operation_string_to_op_type
(const gchar *str);
Performs the reverse of gda_server_operation_op_type_to_string()
Returns
the GdaServerOperationType represented by str
, or G_MAXINT if str
is not a valid representation
of a GdaServerOperationType
Since: 4.2
gda_server_operation_get_node_info ()
GdaServerOperationNode * gda_server_operation_get_node_info (GdaServerOperation *op,const gchar *path_format,...);
Get information about the node identified by path
. The returned GdaServerOperationNode structure can be
copied but not modified; it may change or cease to exist if op
changes
Parameters
op |
a GdaServerOperation object |
|
path_format |
a complete path to a node (starting with "/") as a format string, similar to |
|
... |
the arguments to insert into the format string |
Returns
a GdaServerOperationNode structure, or NULL if the node was not found.
[transfer none][nullable]
gda_server_operation_get_value_at ()
const GValue * gda_server_operation_get_value_at (GdaServerOperation *op,const gchar *path_format,...);
Get the value for the node at the path formed using path_format
and ... (the rules are the same as
for g_strdup_printf())
Parameters
op |
a GdaServerOperation object |
|
path_format |
a complete path to a node (starting with "/") |
|
... |
arguments to use with |
gda_server_operation_get_value_at_path ()
const GValue * gda_server_operation_get_value_at_path (GdaServerOperation *op,const gchar *path);
Get the value for the node at the path
path
[rename-to gda_server_operation_get_value_at]
Returns
a constant GValue if a value has been defined, or NULL if the value is undefined or if the path
is not defined or path
does not hold any value.
[transfer none][nullable]
Since: 4.2.6
gda_server_operation_get_sql_identifier_at ()
gchar * gda_server_operation_get_sql_identifier_at (GdaServerOperation *op,GdaConnection *cnc,GdaServerProvider *prov,const gchar *path_format,GError **error,...);
This method is similar to gda_server_operation_get_value_at(), but for SQL identifiers: a new string
is returned instead of a GValue. Also the returned string is assumed to represents an SQL identifier
and will correctly be quoted to be used with cnc
, or prov
if cnc
is NULL (a generic quoting rule
will be applied if both are NULL).
Parameters
op |
a GdaServerOperation object |
|
cnc |
a GdaConnection, or |
[nullable] |
prov |
a GdaServerProvider, or |
[nullable] |
path_format |
a complete path to a node (starting with "/") |
|
error |
a place to store errors, or |
[nullable] |
... |
arguments to use with |
Returns
a new string, or NULL if the value is undefined or
if the path
is not defined or path
does not hold any value, or if the value held is not a string
(in that last case a warning is shown).
[transfer full]
Since: 4.0.3
gda_server_operation_get_sql_identifier_at_path ()
gchar * gda_server_operation_get_sql_identifier_at_path (GdaServerOperation *op,GdaConnection *cnc,GdaServerProvider *prov,const gchar *path,GError **error);
This method is similar to gda_server_operation_get_value_at(), but for SQL identifiers: a new string
is returned instead of a GValue. Also the returned string is assumed to represents an SQL identifier
and will correctly be quoted to be used with cnc
, or prov
if cnc
is NULL (a generic quoting rule
will be applied if both are NULL).
[rename-to gda_server_operation_get_sql_identifier_at]
Parameters
op |
a GdaServerOperation object |
|
cnc |
a GdaConnection, or |
[nullable] |
prov |
a GdaServerProvider, or |
[nullable] |
path |
a complete path to a node (starting with "/") |
|
error |
a place to store errors, or |
[nullable] |
Returns
a new string, or NULL if the value is undefined or
if the path
is not defined or path
does not hold any value, or if the value held is not a string or
a valid SQL identifier.
[transfer full]
Since: 4.2.6
gda_server_operation_set_value_at ()
gboolean gda_server_operation_set_value_at (GdaServerOperation *op,const gchar *value,GError **error,const gchar *path_format,...);
Set the value for the node at the path formed using path_format
and the ... ellipse (the rules are the same as
for g_strdup_printf()).
Note that trying to set a value for a path which is not used by the current provider, such as "/TABLE_OPTIONS_P/TABLE_ENGINE" for a PostgreSQL connection (this option is only supported for MySQL), will not generate any error; this allows one to give values to a superset of the parameters and thus use the same code for several providers.
Here are the possible formats of path_format
:
If the path corresponds to a GdaHolder, then the parameter is set to "<parameter>value</parameter>"
-
If the path corresponds to a sequence item like for example "/SEQUENCE_NAME/5/NAME" for the "NAME" value of the 6th item of the "SEQUENCE_NAME" sequence then:
if the sequence already has 6 or more items, then the value is just set to the corresponding value in the 6th item of the sequence
if the sequence has less then 6 items, then items are added up to the 6th one before setting the value to the corresponding in the 6th item of the sequence
-
If the path corresponds to a GdaDataModel, like for example "/ARRAY/@
COLUMN/5" for the value at the 6th row of the "COLUMN" column of the "ARRAY" data model, then:if the data model already contains 6 or more rows, then the value is just set
if the data model has less than 6 rows, then rows are added up to the 6th one before setting the value
Parameters
op |
a GdaServerOperation object |
|
value |
a string. |
[nullable] |
error |
a place to store errors or |
|
path_format |
a complete path to a node (starting with "/") |
|
... |
arguments to use with |
gda_server_operation_set_value_at_path ()
gboolean gda_server_operation_set_value_at_path (GdaServerOperation *op,const gchar *value,const gchar *path,GError **error);
Set the value for the node at the path formed using path_format
and the ... ellipse (the rules are the same as
for g_strdup_printf()).
Note that trying to set a value for a path which is not used by the current provider, such as "/TABLE_OPTIONS_P/TABLE_ENGINE" for a PostgreSQL connection (this option is only supported for MySQL), will not generate any error; this allows one to give values to a superset of the parameters and thus use the same code for several providers.
Here are the possible formats of path_format
:
If the path corresponds to a GdaHolder, then the parameter is set to "<parameter>value</parameter>"
-
If the path corresponds to a sequence item like for example "/SEQUENCE_NAME/5/NAME" for the "NAME" value of the 6th item of the "SEQUENCE_NAME" sequence then:
if the sequence already has 6 or more items, then the value is just set to the corresponding value in the 6th item of the sequence
if the sequence has less then 6 items, then items are added up to the 6th one before setting the value to the corresponding in the 6th item of the sequence
-
If the path corresponds to a GdaDataModel, like for example "/ARRAY/@
COLUMN/5" for the value at the 6th row of the "COLUMN" column of the "ARRAY" data model, then:if the data model already contains 6 or more rows, then the value is just set
if the data model has less than 6 rows, then rows are added up to the 6th one before setting the value
[rename-to gda_server_operation_set_value_at]
Parameters
op |
a GdaServerOperation object |
|
value |
a string. |
[nullable] |
path |
a complete path to a node (starting with "/") |
|
error |
a place to store errors or |
Since: 4.2.6
gda_server_operation_save_data_to_xml ()
xmlNodePtr gda_server_operation_save_data_to_xml (GdaServerOperation *op,GError **error);
Creates a new xmlNodePtr tree which can be used to save the op object. This XML structure can then be saved to disk if necessary. Use xmlFreeNode to free the associated memory when not needed anymore.
[skip]
gda_server_operation_save_data_to_xml_string ()
gchar *
gda_server_operation_save_data_to_xml_string
(GdaServerOperation *op);
gda_server_operation_load_data_from_xml ()
gboolean gda_server_operation_load_data_from_xml (GdaServerOperation *op,xmlNodePtr node,GError **error);
Loads the contents of node
into op
. The XML tree passed through the node
argument must correspond to an XML tree saved using gda_server_operation_save_data_to_xml().
Parameters
op |
a GdaServerOperation object |
|
node |
a xmlNodePtr |
|
error |
a place to store errors or |
[nullable] |
gda_server_operation_get_root_nodes ()
gchar **
gda_server_operation_get_root_nodes (GdaServerOperation *op);
Get an array of strings containing the paths of nodes situated at the root of op
.
gda_server_operation_get_node_type ()
GdaServerOperationNodeType gda_server_operation_get_node_type (GdaServerOperation *op,const gchar *path,GdaServerOperationNodeStatus *status);
Convenience function to get the type of a node.
Parameters
op |
a GdaServerOperation object |
|
path |
a complete path to a node (starting with "/") |
|
status |
a place to store the status of the node, or |
[nullable] |
gda_server_operation_get_node_parent ()
gchar * gda_server_operation_get_node_parent (GdaServerOperation *op,const gchar *path);
Get the complete path to the parent of the node defined by path
Returns
a new string or NULL if the node does not have any parent or does not exist.
[transfer full]
gda_server_operation_get_node_path_portion ()
gchar * gda_server_operation_get_node_path_portion (GdaServerOperation *op,const gchar *path);
Get the last part of path
gda_server_operation_get_sequence_name ()
const gchar * gda_server_operation_get_sequence_name (GdaServerOperation *op,const gchar *path);
Parameters
op |
a GdaServerOperation object |
|
path |
a complete path to a sequence node (starting with "/") |
gda_server_operation_get_sequence_size ()
guint gda_server_operation_get_sequence_size (GdaServerOperation *op,const gchar *path);
Parameters
op |
a GdaServerOperation object |
|
path |
a complete path to a sequence node (starting with "/") |
gda_server_operation_get_sequence_max_size ()
guint gda_server_operation_get_sequence_max_size (GdaServerOperation *op,const gchar *path);
Parameters
op |
a GdaServerOperation object |
|
path |
a complete path to a sequence node (starting with "/") |
gda_server_operation_get_sequence_min_size ()
guint gda_server_operation_get_sequence_min_size (GdaServerOperation *op,const gchar *path);
Parameters
op |
a GdaServerOperation object |
|
path |
a complete path to a sequence node (starting with "/") |
gda_server_operation_get_sequence_item_names ()
gchar ** gda_server_operation_get_sequence_item_names (GdaServerOperation *op,const gchar *path);
Fetch the contents of a sequence. path
can describe either a sequence (for example "/SEQNAME") or an item in a sequence
(for example "/SEQNAME/3")
Parameters
op |
a GdaServerOperation object |
|
path |
a complete path to a sequence node (starting with "/") |
Returns
a array of strings containing the complete paths of the nodes contained at path
(free with g_strfreev()).
[transfer full]
gda_server_operation_add_item_to_sequence ()
guint gda_server_operation_add_item_to_sequence (GdaServerOperation *op,const gchar *seq_path);
Parameters
op |
a GdaServerOperation object |
|
seq_path |
the path to the sequence to which an item must be added (like "/SEQ_NAME" for instance) |
gda_server_operation_del_item_from_sequence ()
gboolean gda_server_operation_del_item_from_sequence (GdaServerOperation *op,const gchar *item_path);
Parameters
op |
a GdaServerOperation object |
|
item_path |
the path to the sequence's item to remove (like "/SEQ_NAME/5" for instance) |
gda_server_operation_is_valid ()
gboolean gda_server_operation_is_valid (GdaServerOperation *op,const gchar *xml_file,GError **error);
Tells if all the required values in op
have been defined.
if xml_file
is not NULL, the validity of op
is tested against that specification,
and not against the current op
's specification.
Parameters
op |
a GdaServerOperation widget |
|
xml_file |
an XML specification file (see |
[nullable] |
error |
a place to store an error, or |
Since: 6.0
gda_server_operation_is_valid_from_resource ()
gboolean gda_server_operation_is_valid_from_resource (GdaServerOperation *op,const gchar *resource,GError **error);
Tells if all the required values in op
have been defined.
if xml_data
is not NULL, the validity of op
is tested against that specification,
and not against the current op
's specification.
Parameters
op |
a GdaServerOperation widget |
|
resource |
the name of a resource containing an XML specification data (see |
[nullable] |
error |
a place to store an error, or |
gda_server_operation_prepare_create_database ()
GdaServerOperation * gda_server_operation_prepare_create_database (const gchar *provider,const gchar *db_name,GError **error);
Creates a new GdaServerOperation object which contains the specifications required
to create a database. Once these specifications are 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().
Returns
new GdaServerOperation object, or NULL if the provider does not support database
creation.
[transfer full][nullable]
Since: 4.2.3
gda_server_operation_perform_create_database ()
gboolean gda_server_operation_perform_create_database (GdaServerOperation *op,const gchar *provider,GError **error);
Creates a new database using the specifications in op
. op
can be obtained using
gda_server_provider_create_operation(), or gda_server_operation_prepare_create_database().
Parameters
provider |
the database provider to use, or |
[nullable] |
op |
a GdaServerOperation object obtained using |
|
error |
a place to store en error, or |
Since: 4.2.3
gda_server_operation_prepare_drop_database ()
GdaServerOperation * gda_server_operation_prepare_drop_database (const gchar *provider,const gchar *db_name,GError **error);
Creates a new GdaServerOperation object which contains the specifications required
to drop a database. Once these specifications provided, use
gda_server_operation_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().
Returns
new GdaServerOperation object, or NULL if the provider does not support database
destruction.
[transfer full][nullable]
Since: 4.2.3
gda_server_operation_perform_drop_database ()
gboolean gda_server_operation_perform_drop_database (GdaServerOperation *op,const gchar *provider,GError **error);
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().
Parameters
provider |
the database provider to use, or |
[nullable] |
op |
a GdaServerOperation object obtained using |
|
error |
a place to store en error, or |
Since: 4.2.3
gda_server_operation_perform ()
gboolean gda_server_operation_perform (GdaServerOperation *op,GError **error);
Performs the operation described by op
. Note that op
is not destroyed by this method
and can be reused.
gda_server_operation_render ()
gchar * gda_server_operation_render (GdaServerOperation *op,GError **error);
Creates an SQL statement (possibly using some specific extensions of the DBMS) corresponding to the
op
operation. Note that the returned string may actually contain more than one SQL statement.
This function's purpose is mainly informative to get the actual SQL code which would be executed to perform
the operation; to actually perform the operation, use gda_server_operation_perform().
Returns
a new string, or NULL if an error occurred or operation cannot be rendered as SQL.
[transfer full][allow-none]
gda_server_operation_create_table_arg_new ()
GdaServerOperationCreateTableArg *
gda_server_operation_create_table_arg_new
(void);
gda_server_operation_create_table_arg_copy ()
GdaServerOperationCreateTableArg *
gda_server_operation_create_table_arg_copy
(GdaServerOperationCreateTableArg *src);
gda_server_operation_create_table_arg_free ()
void
gda_server_operation_create_table_arg_free
(GdaServerOperationCreateTableArg *arg);
gda_server_operation_create_table_arg_set_column_name ()
void gda_server_operation_create_table_arg_set_column_name (GdaServerOperationCreateTableArg *arg,const gchar *name);
Sets column name to be created with the new table.
gda_server_operation_create_table_arg_get_column_name ()
gchar *
gda_server_operation_create_table_arg_get_column_name
(GdaServerOperationCreateTableArg *arg);
gda_server_operation_create_table_arg_set_column_type ()
void gda_server_operation_create_table_arg_set_column_type (GdaServerOperationCreateTableArg *arg,GType ctype);
gda_server_operation_create_table_arg_get_column_type ()
GType
gda_server_operation_create_table_arg_get_column_type
(GdaServerOperationCreateTableArg *arg);
gda_server_operation_create_table_arg_set_flags ()
void gda_server_operation_create_table_arg_set_flags (GdaServerOperationCreateTableArg *arg,GdaServerOperationCreateTableFlag flags);
Sets flags for new column to create with the table.
gda_server_operation_create_table_arg_get_flags ()
GdaServerOperationCreateTableFlag
gda_server_operation_create_table_arg_get_flags
(GdaServerOperationCreateTableArg *arg);
gda_server_operation_create_table_arg_set_fkey_table ()
void gda_server_operation_create_table_arg_set_fkey_table (GdaServerOperationCreateTableArg *arg,const gchar *name);
You should set this if you use a GDA_SERVER_OPERATION_CREATE_TABLE_FKEY_FLAG flag.
gda_server_operation_create_table_arg_get_fkey_table ()
gchar *
gda_server_operation_create_table_arg_get_fkey_table
(GdaServerOperationCreateTableArg *arg);
gda_server_operation_create_table_arg_set_fkey_ondelete ()
void gda_server_operation_create_table_arg_set_fkey_ondelete (GdaServerOperationCreateTableArg *arg,const gchar *action);
You should set this if you use a GDA_SERVER_OPERATION_CREATE_TABLE_FKEY_FLAG flag.
gda_server_operation_create_table_arg_get_fkey_ondelete ()
gchar *
gda_server_operation_create_table_arg_get_fkey_ondelete
(GdaServerOperationCreateTableArg *arg);
gda_server_operation_create_table_arg_set_fkey_ondupdate ()
void gda_server_operation_create_table_arg_set_fkey_ondupdate (GdaServerOperationCreateTableArg *arg,const gchar *action);
gda_server_operation_create_table_arg_get_fkey_onupdate ()
gchar *
gda_server_operation_create_table_arg_get_fkey_onupdate
(GdaServerOperationCreateTableArg *arg);
gda_server_operation_create_table_arg_set_fkey_refs ()
void gda_server_operation_create_table_arg_set_fkey_refs (GdaServerOperationCreateTableArg *arg,GList *refs);
You should set this if you use a GDA_SERVER_OPERATION_CREATE_TABLE_FKEY_FLAG flag.
gda_server_operation_create_table_arg_get_fkey_refs ()
GList *
gda_server_operation_create_table_arg_get_fkey_refs
(GdaServerOperationCreateTableArg *arg);
Returns
a list of references from local to foreign fields type GdaServerOperationCreateTableArgFKeyRefField.
[transfer none][element-type GdaServerOperationCreateTableArgFKeyRefField]
gda_server_operation_create_table_arg_fkey_ref_field_new ()
GdaServerOperationCreateTableArgFKeyRefField *
gda_server_operation_create_table_arg_fkey_ref_field_new
(void);
gda_server_operation_create_table_arg_fkey_ref_field_copy ()
GdaServerOperationCreateTableArgFKeyRefField *
gda_server_operation_create_table_arg_fkey_ref_field_copy
(GdaServerOperationCreateTableArgFKeyRefField *src);
gda_server_operation_create_table_arg_fkey_ref_field_free ()
void
gda_server_operation_create_table_arg_fkey_ref_field_free
(GdaServerOperationCreateTableArgFKeyRefField *ref);
gda_server_operation_create_table_arg_fkey_ref_field_set_local_field ()
void gda_server_operation_create_table_arg_fkey_ref_field_set_local_field (GdaServerOperationCreateTableArgFKeyRefField *ref,const gchar *name);
gda_server_operation_create_table_arg_fkey_ref_field_get_local_field ()
gchar *
gda_server_operation_create_table_arg_fkey_ref_field_get_local_field
(GdaServerOperationCreateTableArgFKeyRefField *ref);
gda_server_operation_create_table_arg_fkey_ref_field_set_referenced_field ()
void gda_server_operation_create_table_arg_fkey_ref_field_set_referenced_field (GdaServerOperationCreateTableArgFKeyRefField *ref,const gchar *name);
gda_server_operation_create_table_arg_fkey_ref_field_get_referenced_field ()
gchar *
gda_server_operation_create_table_arg_fkey_ref_field_get_referenced_field
(GdaServerOperationCreateTableArgFKeyRefField *ref);
gda_server_operation_prepare_create_table_v ()
GdaServerOperation * gda_server_operation_prepare_create_table_v (GdaConnection *cnc,const gchar *table_name,GError **error,...);
Convenient funtion for table creation.
For details about arguments see gda_server_operation_prepare_create_table_v().
Parameters
cnc |
an opened connection |
|
table_name |
name of the table to create |
|
error |
a place to store errors, or |
|
... |
group of three arguments for column's name, column's GType
and a GdaServerOperationCreateTableFlag flag, finished with |
Since: 4.2.3
gda_server_operation_prepare_create_table ()
GdaServerOperation * gda_server_operation_prepare_create_table (GdaConnection *cnc,const gchar *table_name,GList *arguments,GError **error);
Add more arguments if the flag needs them:
GDA_SERVER_OPERATION_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 column's name the column's GType and GdaServerOperationCreateTableFlag
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 finished call gda_server_operation_perform_create_table or gda_server_provider_perform_operation in order to execute the operation.
Parameters
cnc |
an opened connection |
|
table_name |
name of the table to create |
|
arguments |
list of arguments as GdaServerOperationPrepareCreateTableArg containing column's name, column's GType and a GdaServerOperationCreateTableFlag flag. |
[element-type GdaServerOperationCreateTableArg] |
error |
a place to store errors, or |
Since: 6.0.0
gda_server_operation_perform_create_table ()
gboolean gda_server_operation_perform_create_table (GdaServerOperation *op,GError **error);
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.
Since: 4.2.3
gda_server_operation_prepare_drop_table ()
GdaServerOperation * gda_server_operation_prepare_drop_table (GdaConnection *cnc,const gchar *table_name,GError **error);
This is just a convenient function to create a GdaServerOperation to drop a table in an opened connection.
Parameters
cnc |
an opened connection |
|
table_name |
name of the table to drop |
|
error |
a place to store errors, or |
Returns
a new GdaServerOperation or NULL if couldn't create the opereration.
[transfer full][nullable]
Since: 4.2.3
gda_server_operation_perform_drop_table ()
gboolean gda_server_operation_perform_drop_table (GdaServerOperation *op,GError **error);
This is just a convenient function to perform a drop a table operation.
Since: 4.2.3
Types and Values
GdaServerOperationClass
typedef struct {
GObjectClass parent_class;
/* signals */
void (*seq_item_added) (GdaServerOperation *op, const gchar *seq_path, gint item_index);
void (*seq_item_remove) (GdaServerOperation *op, const gchar *seq_path, gint item_index);
} GdaServerOperationClass;
Property Details
The “connection” property
“connection” GdaConnection *
Connection to use.
Flags: Read / Write / Construct Only
The “op-type” property
“op-type” gint
Type of operation to be done.
Flags: Read / Write / Construct Only
Allowed values: [0,15]
Default value: 0
The “provider” property
“provider” GdaServerProvider *
Database provider which created the object.
Flags: Read / Write / Construct Only
The “spec-filename” property
“spec-filename” gchar *
XML file which contains the object's data structure.
Flags: Write / Construct Only
Default value: NULL
The “spec-resource” property
“spec-resource” gchar *
Name of the resource which contains the XML data representing the object's data structure.
Flags: Write / Construct Only
Default value: NULL
Signal Details
The “sequence-item-added” signal
void user_function (GdaServerOperation *op, gchar *seq_path, gint item_index, gpointer user_data)
Gets emitted whenever a new sequence item (from a sequence template) has been added
[virtual seq_item_added]
Parameters
op |
||
seq_path |
the path to the new sequence item |
|
item_index |
the index (starting from 0) of the new sequence item in the sequence |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
The “sequence-item-remove” signal
void user_function (GdaServerOperation *op, gchar *seq_path, gint item_index, gpointer user_data)
Gets emitted whenever a sequence item is about to be removed
[virtual seq_item_remove]
Parameters
op |
||
seq_path |
the path to the sequence item to be removed |
|
item_index |
the index (starting from 0) of the sequence item in the sequence |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First