Libmu dbm - Revision history

Gray at 13:33, 16 October 2023

2023-10-16T13:33:44Z

2015-07-11T11:33:46Z

2015-07-07T13:38:07Z

Opening a Database

2011-11-21T15:32:38Z

Creating a Database Object

2011-11-21T15:30:15Z

Creating a Database Object

2011-11-09T21:44:45Z

2011-10-28T12:54:13Z

Global Variables

2011-10-28T12:53:42Z

Global Variables

2011-10-28T12:50:41Z

API for Backend Implementors

2011-10-28T12:49:24Z

Additional Functions

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:libmu_dbm}}
-The library <tt>libmu_dbm</tt> provides a uniform and consistent interface to various <tt>DBM</tt>-like database managers.  Presently (as of version 2.99.93), the following backend libraries are supported:
+The library <tt>libmu_dbm</tt> provides a uniform and consistent interface to various <tt>DBM</tt>-like database managers.  Presently (as of version 2.99.99), the following backend libraries are supported:
 * [http://www.gnu.org/software/gdbm GDBM]
@@ Line 123: / Line 123: @@
 :Create an empty database and open it for reading and writing.  If the database file already exists, all existing records will be removed from it.
-The '''mode''' argument supplies the file mode for newly created files.  Its meaning is the same as in [http://man.gnu.org.ua/2/chmod chmod(2)] call.
+The '''mode''' argument supplies the file mode for newly created files.  Its meaning is the same as in {{man|2|chmod}} call.
 ==Database Lookups==

@@ Line 123: / Line 123: @@
 :Create an empty database and open it for reading and writing.  If the database file already exists, all existing records will be removed from it.
-The '''mode''' argument supplies the file mode for newly created files.  Its meaning is the same as in [http://www.manpagez.com/man/2/chmod/ chmod(2)] call.
+The '''mode''' argument supplies the file mode for newly created files.  Its meaning is the same as in [http://man.gnu.org.ua/2/chmod chmod(2)] call.
 ==Database Lookups==

← Older revision		Revision as of 15:32, 21 November 2011
Line 77:		Line 77:

	The former function creates a database object from an URL supplied as its first argument. The latter one creates a database object from a file name or a [[Database URL\|URL]] in string form. On success both functions store a pointer to the initialized <tt>struct _mu_dbm_file</tt> in the memory location pointed to by the '''db''' parameter and return 0. On error, they return a [[Error Code\|Mailutils error code]] and do not touch '''db'''.		The former function creates a database object from an URL supplied as its first argument. The latter one creates a database object from a file name or a [[Database URL\|URL]] in string form. On success both functions store a pointer to the initialized <tt>struct _mu_dbm_file</tt> in the memory location pointed to by the '''db''' parameter and return 0. On error, they return a [[Error Code\|Mailutils error code]] and do not touch '''db'''.
		+
		+	The '''default_safety_flags''' argument specifies the default safety criteria to apply to the database unless explicitly stated in its [[Database_URL#param\|URL parameters]]

	== Safety Checking ==		== Safety Checking ==

@@ Line 72: / Line 72: @@
 <source lang="C">
-   int mu_dbm_create_from_url (mu_url_t url, mu_dbm_file_t *db);
+   int mu_dbm_create_from_url (mu_url_t url, mu_dbm_file_t *db, int default_safety_flags);
-   int mu_dbm_create (char *name, mu_dbm_file_t *db);
+   int mu_dbm_create (char *name, mu_dbm_file_t *db, int default_safety_flags);
 </source>

@@ Line 6: / Line 6: @@
 * [http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html Berkeley DB] (BDB)
 * Traditional [http://en.wikipedia.org/wiki/Ndbm NDBM]
+* [http://fallabs.com/tokyocabinet/ Tokyo Cabinet]
-{{Note|The [http://fallabs.com/tokyocabinet/ Tokyo Cabinet] support was available in previous versions.  It is not yet re-implemented via <tt>libmu_dbm</tt>, but it will probably be in the future.}}
+* [http://fallabs.com/kyotocabinet/ Kyoto Cabinet]
 == Header Files and Libraries ==

@@ Line 59: / Line 59: @@
 <div id="mu_dbm_get_hint"></div>
-Therefore it is not recommended to use this variable directly.  The preferred way is to use the the [[#mu_dbm_get_hint|<tt>mu_dbm_get_hint</tt>]] function instead:
+Therefore it is not recommended to use this variable directly.  The preferred way is to use the the <tt>mu_dbm_get_hint</tt> function instead:
 <source lang="C">

@@ Line 56: / Line 56: @@
 This variable keeps an [[URL hint]] which is used to supply missing URL parts for <tt>mu_dbm_create_from_url</tt> and <tt>mu_dbm_create</tt> calls (see next section).  By default it contains only a scheme part pointing to the first available '''DBM''' implementation.
-This variable is <tt>NULL</tt> before any of the following functions is called: [[#mu_dbm_init|<tt>mu_dbm_init</tt>]], [[#mu_dbm_get_hint|<tt>mu_dbm_get_hint</tt>]], [[#mu_dbm_register|<tt>mu_dbm_register</tt>]], [[#mu_dbm_impl_iterator|<tt>mu_dbm_impl_iterator</tt>]], [[#Creating a Database Object|<tt>mu_dbm_create_from_url</tt>]] or [[#Creating a Database Object|<tt>mu_dbm_create</tt>]].
+This variable is <tt>NULL</tt> before any of the following functions is called: [[#mu_dbm_init|<tt>mu_dbm_init</tt>]], <tt>mu_dbm_get_hint</tt>, [[#mu_dbm_register|<tt>mu_dbm_register</tt>]], [[#mu_dbm_impl_iterator|<tt>mu_dbm_impl_iterator</tt>]], [[#Creating a Database Object|<tt>mu_dbm_create_from_url</tt>]] or [[#Creating a Database Object|<tt>mu_dbm_create</tt>]].
-Therefore it is not recommended to use this variable directly.  The preferred way is to use the the [[#mu_dbm_get_hint|<tt>mu_dbm_get_hint</tt>]] function instead.  This function makes sure the variable is initialized before returning it.
+<div id="mu_dbm_get_hint"></div>
 == Creating a Database Object ==

← Older revision		Revision as of 12:50, 28 October 2011
Line 402:		Line 402:
	Once done, it becomes avaiable for use by the API.		Once done, it becomes avaiable for use by the API.

		+	<div id="mu_dbm_impl_iterator"></div>
	Registered implementations can be accessed via an [[iterator]] returned by the <tt>mu_dbm_impl_iterator</tt> function:		Registered implementations can be accessed via an [[iterator]] returned by the <tt>mu_dbm_impl_iterator</tt> function:

@@ Line 236: / Line 236: @@
 </source>
-Normally it is not necessary to call this function because it is called automatically by any of the following functions:
+Normally it is not necessary to call this function because it is called automatically by any of the following functions: [[#mu_dbm_get_hint|<tt>mu_dbm_get_hint</tt>]], [[#mu_dbm_register|<tt>mu_dbm_register</tt>]], [[#mu_dbm_impl_iterator|<tt>mu_dbm_impl_iterator</tt>]], [[#Creating a Database Object|<tt>mu_dbm_create_from_url</tt>]] and [[#Creating a Database Object|<tt>mu_dbm_create</tt>]].
 ==Return Codes==