~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_java/env_set_data_dir.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: DbEnv.set_data_dir</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>DbEnv.set_data_dir</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
import com.sleepycat.db.*;
24
 
<p>
25
 
public void set_data_dir(String dir)
26
 
    throws DbException;
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<p>Set the path of a directory to be used as the location of the access
30
 
method database files.  Paths specified to the <a href="../api_java/db_open.html">Db.open</a> function
31
 
will be searched relative to this path.  Paths set using this interface
32
 
are additive, and specifying more than one will result in each specified
33
 
directory being searched for database files.  If any directories are
34
 
specified, created database files will always be created in the first path
35
 
specified.
36
 
<p>If no database directories are specified, database files can exist only
37
 
in the environment home directory.   See <a href="../ref/env/naming.html">Berkeley DB File Naming</a> for more information.
38
 
<p>For the greatest degree of recoverability from system or application
39
 
failure, database files and log files should be located on separate
40
 
physical devices.
41
 
<p>The DbEnv.set_data_dir method configures operations performed using the specified
42
 
<a href="../api_java/env_class.html">DbEnv</a> handle, not all operations performed on the underlying
43
 
database environment.
44
 
<p>The DbEnv.set_data_dir interface may not be called after the <a href="../api_java/env_open.html">DbEnv.open</a>
45
 
interface is called.
46
 
If the database environment already exists when
47
 
<a href="../api_java/env_open.html">DbEnv.open</a> is called, the information specified to DbEnv.set_data_dir
48
 
must be consistent with the existing environment or corruption can
49
 
occur.
50
 
<p>The DbEnv.set_data_dir method throws an exception that encapsulates a non-zero error value on
51
 
failure.
52
 
<p>The database environment's data directory may also be set using the environment's
53
 
<b>DB_CONFIG</b> file.  The syntax of the entry in that file is a
54
 
single line with the string "set_data_dir", one or more whitespace characters,
55
 
and the directory name.  Because the <b>DB_CONFIG</b> file is read when the database
56
 
environment is opened, it will silently overrule configuration done
57
 
before that time.
58
 
<h1>Errors</h1>
59
 
<p>The DbEnv.set_data_dir method may fail and throw an exception encapsulating a non-zero error for the following conditions:
60
 
<p><dl compact>
61
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
62
 
<p>Called after <a href="../api_java/env_open.html">DbEnv.open</a> was called.
63
 
</dl>
64
 
<p>The DbEnv.set_data_dir method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
65
 
If a catastrophic error has occurred, the DbEnv.set_data_dir method may fail and
66
 
throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>,
67
 
in which case all subsequent Berkeley DB calls will fail in the same way.
68
 
<h1>Class</h1>
69
 
<a href="../api_java/env_class.html">DbEnv</a>
70
 
<h1>See Also</h1>
71
 
<a href="../api_java/env_list.html">Database Environments and Related Methods</a>
72
 
</tt>
73
 
<table width="100%"><tr><td><br></td><td align=right>
74
 
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
75
 
</td></tr></table>
76
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
77
 
</body>
78
 
</html>