[libgda] Added gda_connection_new_from_dsn() and gda_connection_new_from_string()
- From: Vivien Malerba <vivien src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgda] Added gda_connection_new_from_dsn() and gda_connection_new_from_string()
- Date: Wed, 9 Nov 2011 21:43:28 +0000 (UTC)
commit 722edc0ce116466e2193304b539a632d6478f6ce
Author: Vivien Malerba <malerba gnome-db org>
Date: Wed Nov 9 22:43:18 2011 +0100
Added gda_connection_new_from_dsn() and gda_connection_new_from_string()
doc/C/libgda-5.0-docs.sgml | 3 +
doc/C/libgda-sections.txt | 2 +
libgda/gda-connection.c | 168 +++++++++++++++++++++++++++++---------------
libgda/gda-connection.h | 5 ++
libgda/libgda.symbols | 2 +
5 files changed, 122 insertions(+), 58 deletions(-)
---
diff --git a/doc/C/libgda-5.0-docs.sgml b/doc/C/libgda-5.0-docs.sgml
index 1b3e331..66fb3b9 100644
--- a/doc/C/libgda-5.0-docs.sgml
+++ b/doc/C/libgda-5.0-docs.sgml
@@ -1646,6 +1646,9 @@ g_object_unref (eng);
<index id="index-5-0" role="5.0">
<title>Index of new symbols in 5.0</title>
</index>
+ <index id="index-5-0-2" role="5.0.2">
+ <title>Index of new symbols in 5.0.2</title>
+ </index>
<index id="index-deprecated" role="deprecated">
<title>Index of deprecated symbols</title>
</index>
diff --git a/doc/C/libgda-sections.txt b/doc/C/libgda-sections.txt
index 4268810..7f6c5f9 100644
--- a/doc/C/libgda-sections.txt
+++ b/doc/C/libgda-sections.txt
@@ -110,6 +110,8 @@ GdaConnectionError
GDA_CONNECTION_ERROR
gda_connection_open_from_dsn
gda_connection_open_from_string
+gda_connection_new_from_dsn
+gda_connection_new_from_string
gda_connection_open
gda_connection_close
gda_connection_close_no_warning
diff --git a/libgda/gda-connection.c b/libgda/gda-connection.c
index 8a21318..3d4c184 100644
--- a/libgda/gda-connection.c
+++ b/libgda/gda-connection.c
@@ -1020,39 +1020,23 @@ _gda_connection_get_internal_thread_provider (void)
return _gda_thread_wrapper_provider;
}
+
/**
- * gda_connection_open_from_dsn:
+ * gda_connection_new_from_dsn:
* @dsn: data source name.
* @auth_string: (allow-none): authentication string, or %NULL
* @options: options for the connection (see #GdaConnectionOptions).
* @error: a place to store an error, or %NULL
*
- * This function is the way of opening database connections with libgda, using a pre-defined data source (DSN),
- * see gda_config_define_dsn() for more information about how to define a DSN. If you don't want to define
- * a DSN, it is possible to use gda_connection_open_from_string() instead of this method.
- *
- * The @dsn string must have the following format: "[<username>[:<password>] ]<DSN>"
- * (if <username> and/or <password> are provided, and @auth_string is %NULL, then these username
- * and passwords will be used). Note that if provided, <username> and <password>
- * must be encoded as per RFC 1738, see gda_rfc1738_encode() for more information.
- *
- * The @auth_string can contain the authentication information for the server
- * to accept the connection. It is a string containing semi-colon seperated named value, usually
- * like "USERNAME=...;PASSWORD=..." where the ... are replaced by actual values. Note that each
- * name and value must be encoded as per RFC 1738, see gda_rfc1738_encode() for more information.
- *
- * The actual named parameters required depend on the provider being used, and that list is available
- * as the <parameter>auth_params</parameter> member of the #GdaProviderInfo structure for each installed
- * provider (use gda_config_get_provider_info() to get it). Also one can use the "gda-sql-5.0 -L" command to
- * list the possible named parameters.
- *
- * This method may fail with a GDA_CONNECTION_ERROR domain error (see the #GdaConnectionError error codes)
- * or a %GDA_CONFIG_ERROR domain error (see the #GdaConfigError error codes).
+ * This function is similar to gda_connection_open_from_dsn(), except it does not actually open the
+ * connection, you have to open it using gda_connection_open().
*
* Returns: (transfer full): a new #GdaConnection if connection opening was successful or %NULL if there was an error.
+ *
+ * Since: 5.0.2
*/
GdaConnection *
-gda_connection_open_from_dsn (const gchar *dsn, const gchar *auth_string,
+gda_connection_new_from_dsn (const gchar *dsn, const gchar *auth_string,
GdaConnectionOptions options, GError **error)
{
GdaConnection *cnc = NULL;
@@ -1138,12 +1122,6 @@ gda_connection_open_from_dsn (const gchar *dsn, const gchar *auth_string,
"dsn", real_dsn,
"auth-string", auth_string ? auth_string : real_auth_string,
"options", options, NULL);
-
- /* open connection */
- if (!gda_connection_open (cnc, error)) {
- g_object_unref (cnc);
- cnc = NULL;
- }
}
}
else
@@ -1158,47 +1136,30 @@ gda_connection_open_from_dsn (const gchar *dsn, const gchar *auth_string,
}
/**
- * gda_connection_open_from_string:
- * @provider_name: (allow-none): provider ID to connect to, or %NULL
- * @cnc_string: connection string.
+ * gda_connection_open_from_dsn:
+ * @dsn: data source name.
* @auth_string: (allow-none): authentication string, or %NULL
* @options: options for the connection (see #GdaConnectionOptions).
* @error: a place to store an error, or %NULL
*
- * Opens a connection given a provider ID and a connection string. This
- * allows applications to open connections without having to create
- * a data source (DSN) in the configuration. The format of @cnc_string is
- * similar to PostgreSQL and MySQL connection strings. It is a semicolumn-separated
- * series of <key>=<value> pairs, where each key and value are encoded as per RFC 1738,
- * see gda_rfc1738_encode() for more information.
- *
- * The possible keys depend on the provider, the "gda-sql-5.0 -L" command
- * can be used to list the actual keys for each installed database provider.
- *
- * For example the connection string to open an SQLite connection to a database
- * file named "my_data.db" in the current directory would be <constant>"DB_DIR=.;DB_NAME=my_data"</constant>.
+ * This function is the way of opening database connections with libgda, using a pre-defined data source (DSN),
+ * see gda_config_define_dsn() for more information about how to define a DSN. If you don't want to define
+ * a DSN, it is possible to use gda_connection_open_from_string() instead of this method.
*
- * The @cnc_string string must have the following format:
- * "[<provider>://][<username>[:<password>] ]<connection_params>"
+ * The @dsn string must have the following format: "[<username>[:<password>] ]<DSN>"
* (if <username> and/or <password> are provided, and @auth_string is %NULL, then these username
- * and passwords will be used, and if <provider> is provided and @provider_name is %NULL then this
- * provider will be used). Note that if provided, <username>, <password> and <provider>
+ * and passwords will be used). Note that if provided, <username> and <password>
* must be encoded as per RFC 1738, see gda_rfc1738_encode() for more information.
*
- * The @auth_string must contain the authentication information for the server
- * to accept the connection. It is a string containing semi-colon seperated named values, usually
+ * The @auth_string can contain the authentication information for the server
+ * to accept the connection. It is a string containing semi-colon seperated named value, usually
* like "USERNAME=...;PASSWORD=..." where the ... are replaced by actual values. Note that each
* name and value must be encoded as per RFC 1738, see gda_rfc1738_encode() for more information.
*
* The actual named parameters required depend on the provider being used, and that list is available
* as the <parameter>auth_params</parameter> member of the #GdaProviderInfo structure for each installed
- * provider (use gda_config_get_provider_info() to get it). Similarly to the format of the connection
- * string, use the "gda-sql-5.0 -L" command to list the possible named parameters.
- *
- * Additionally, it is possible to have the connection string
- * respect the "<provider_name>://<real cnc string>" format, in which case the provider name
- * and the real connection string will be extracted from that string (note that if @provider_name
- * is not %NULL then it will still be used as the provider ID).\
+ * provider (use gda_config_get_provider_info() to get it). Also one can use the "gda-sql-5.0 -L" command to
+ * list the possible named parameters.
*
* This method may fail with a GDA_CONNECTION_ERROR domain error (see the #GdaConnectionError error codes)
* or a %GDA_CONFIG_ERROR domain error (see the #GdaConfigError error codes).
@@ -1206,7 +1167,36 @@ gda_connection_open_from_dsn (const gchar *dsn, const gchar *auth_string,
* Returns: (transfer full): a new #GdaConnection if connection opening was successful or %NULL if there was an error.
*/
GdaConnection *
-gda_connection_open_from_string (const gchar *provider_name, const gchar *cnc_string, const gchar *auth_string,
+gda_connection_open_from_dsn (const gchar *dsn, const gchar *auth_string,
+ GdaConnectionOptions options, GError **error)
+{
+ GdaConnection *cnc;
+ cnc = gda_connection_new_from_dsn (dsn, auth_string, options, error);
+ if (cnc && !gda_connection_open (cnc, error)) {
+ g_object_unref (cnc);
+ cnc = NULL;
+ }
+ return cnc;
+}
+
+
+/**
+ * gda_connection_new_from_string:
+ * @provider_name: (allow-none): provider ID to connect to, or %NULL
+ * @cnc_string: connection string.
+ * @auth_string: (allow-none): authentication string, or %NULL
+ * @options: options for the connection (see #GdaConnectionOptions).
+ * @error: a place to store an error, or %NULL
+ *
+ * This function is similar to gda_connection_open_from_string(), except it does not actually open the
+ * connection, you have to open it using gda_connection_open().
+ *
+ * Returns: (transfer full): a new #GdaConnection if connection opening was successful or %NULL if there was an error.
+ *
+ * Since: 5.0.2
+ */
+GdaConnection *
+gda_connection_new_from_string (const gchar *provider_name, const gchar *cnc_string, const gchar *auth_string,
GdaConnectionOptions options, GError **error)
{
GdaConnection *cnc = NULL;
@@ -1313,6 +1303,68 @@ gda_connection_open_from_string (const gchar *provider_name, const gchar *cnc_st
return cnc;
}
+/**
+ * gda_connection_open_from_string:
+ * @provider_name: (allow-none): provider ID to connect to, or %NULL
+ * @cnc_string: connection string.
+ * @auth_string: (allow-none): authentication string, or %NULL
+ * @options: options for the connection (see #GdaConnectionOptions).
+ * @error: a place to store an error, or %NULL
+ *
+ * Opens a connection given a provider ID and a connection string. This
+ * allows applications to open connections without having to create
+ * a data source (DSN) in the configuration. The format of @cnc_string is
+ * similar to PostgreSQL and MySQL connection strings. It is a semicolumn-separated
+ * series of <key>=<value> pairs, where each key and value are encoded as per RFC 1738,
+ * see gda_rfc1738_encode() for more information.
+ *
+ * The possible keys depend on the provider, the "gda-sql-5.0 -L" command
+ * can be used to list the actual keys for each installed database provider.
+ *
+ * For example the connection string to open an SQLite connection to a database
+ * file named "my_data.db" in the current directory would be <constant>"DB_DIR=.;DB_NAME=my_data"</constant>.
+ *
+ * The @cnc_string string must have the following format:
+ * "[<provider>://][<username>[:<password>] ]<connection_params>"
+ * (if <username> and/or <password> are provided, and @auth_string is %NULL, then these username
+ * and passwords will be used, and if <provider> is provided and @provider_name is %NULL then this
+ * provider will be used). Note that if provided, <username>, <password> and <provider>
+ * must be encoded as per RFC 1738, see gda_rfc1738_encode() for more information.
+ *
+ * The @auth_string must contain the authentication information for the server
+ * to accept the connection. It is a string containing semi-colon seperated named values, usually
+ * like "USERNAME=...;PASSWORD=..." where the ... are replaced by actual values. Note that each
+ * name and value must be encoded as per RFC 1738, see gda_rfc1738_encode() for more information.
+ *
+ * The actual named parameters required depend on the provider being used, and that list is available
+ * as the <parameter>auth_params</parameter> member of the #GdaProviderInfo structure for each installed
+ * provider (use gda_config_get_provider_info() to get it). Similarly to the format of the connection
+ * string, use the "gda-sql-5.0 -L" command to list the possible named parameters.
+ *
+ * Additionally, it is possible to have the connection string
+ * respect the "<provider_name>://<real cnc string>" format, in which case the provider name
+ * and the real connection string will be extracted from that string (note that if @provider_name
+ * is not %NULL then it will still be used as the provider ID).\
+ *
+ * This method may fail with a GDA_CONNECTION_ERROR domain error (see the #GdaConnectionError error codes)
+ * or a %GDA_CONFIG_ERROR domain error (see the #GdaConfigError error codes).
+ *
+ * Returns: (transfer full): a new #GdaConnection if connection opening was successful or %NULL if there was an error.
+ */
+GdaConnection *
+gda_connection_open_from_string (const gchar *provider_name, const gchar *cnc_string, const gchar *auth_string,
+ GdaConnectionOptions options, GError **error)
+{
+ GdaConnection *cnc;
+ cnc = gda_connection_new_from_string (provider_name, cnc_string, auth_string, options, error);
+ if (cnc && !gda_connection_open (cnc, error)) {
+ g_object_unref (cnc);
+ cnc = NULL;
+ }
+ return cnc;
+}
+
+
/*
* Uses _gda_config_sqlite_provider to open a connection
*/
diff --git a/libgda/gda-connection.h b/libgda/gda-connection.h
index 8509f9f..e854c9c 100644
--- a/libgda/gda-connection.h
+++ b/libgda/gda-connection.h
@@ -274,6 +274,11 @@ GdaConnection *gda_connection_open_from_dsn (const gchar *dsn, cons
GdaConnection *gda_connection_open_from_string (const gchar *provider_name,
const gchar *cnc_string, const gchar *auth_string,
GdaConnectionOptions options, GError **error);
+GdaConnection *gda_connection_new_from_dsn (const gchar *dsn, const gchar *auth_string,
+ GdaConnectionOptions options, GError **error);
+GdaConnection *gda_connection_new_from_string (const gchar *provider_name,
+ const gchar *cnc_string, const gchar *auth_string,
+ GdaConnectionOptions options, GError **error);
gboolean gda_connection_open (GdaConnection *cnc, GError **error);
void gda_connection_close (GdaConnection *cnc);
void gda_connection_close_no_warning (GdaConnection *cnc);
diff --git a/libgda/libgda.symbols b/libgda/libgda.symbols
index dda8b0f..5094075 100644
--- a/libgda/libgda.symbols
+++ b/libgda/libgda.symbols
@@ -151,6 +151,8 @@
gda_connection_internal_transaction_started
gda_connection_is_opened
gda_connection_meta_type_get_type
+ gda_connection_new_from_dsn
+ gda_connection_new_from_string
gda_connection_open
gda_connection_open_from_dsn
gda_connection_open_from_string
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
