summaryrefslogtreecommitdiff
path: root/bdb/docs/api_java/env_set_tmp_dir.html
blob: 8c3c4b899c0c6650807c46c042c5117a13071835 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<!--$Id: env_set_tmp_dir.so,v 10.3 2000/05/20 16:29:12 bostic Exp $-->
<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<html>
<head>
<title>Berkeley DB: DbEnv.set_tmp_dir</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
        <a name="2"><!--meow--></a>    
<table><tr valign=top>
<td>
<h1>DbEnv.set_tmp_dir</h1>
</td>
<td width="1%">
<a href="../api_java/java_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
import com.sleepycat.db.*;
<p>
public void set_tmp_dir(String dir)
	throws DbException;
</pre></h3>
<h1>Description</h1>
<p>The path of a directory to be used as the location of temporary files.
The files created to back in-memory access method databases will be
created relative to this path.  These temporary files can be quite large,
depending on the size of the database.
<p>If no directories are specified, the following alternatives are checked
in the specified order.  The first existing directory path is used for
all temporary files.
<p><ol>
<p><li>The value of the environment variable <b>TMPDIR</b>.
<li>The value of the environment variable <b>TEMP</b>.
<li>The value of the environment variable <b>TMP</b>.
<li>The value of the environment variable <b>TempFolder</b>.
<li>The value returned by the GetTempPath interface.
<li>The directory <b>/var/tmp</b>.
<li>The directory <b>/usr/tmp</b>.
<li>The directory <b>/temp</b>.
<li>The directory <b>/tmp</b>.
<li>The directory <b>C:/temp</b>.
<li>The directory <b>C:/tmp</b>.
</ol>
<p>Note: environment variables are only checked if one of the
<a href="../api_java/env_open.html#DB_USE_ENVIRON">Db.DB_USE_ENVIRON</a> or <a href="../api_java/env_open.html#DB_USE_ENVIRON_ROOT">Db.DB_USE_ENVIRON_ROOT</a> flags were
specified.
<p>Note: the GetTempPath interface is only checked on Win/32 platforms.
<p>The DbEnv.set_tmp_dir interface may only be used to configure Berkeley DB before
the <a href="../api_java/env_open.html">DbEnv.open</a> interface is called.
<p>The DbEnv.set_tmp_dir method throws an exception that encapsulates a non-zero error value on
failure.
<p>The database environment's temporary file directory may also be set using the environment's
<b>DB_CONFIG</b> file.  The syntax of the entry in that file is a
single line with the string "set_tmp_dir", one or more whitespace characters,
and the directory name.  Because the <b>DB_CONFIG</b> file is read when the database
environment is opened, it will silently overrule configuration done
before that time.
<h1>Errors</h1>
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>Called after <a href="../api_java/env_open.html">DbEnv.open</a> was called.
</dl>
<h3>Class</h3>
<a href="../api_java/dbenv_class.html">DbEnv</a>
<h1>See Also</h1>
<a href="../api_java/env_close.html">DbEnv.close</a>,
<a href="../api_java/env_open.html">DbEnv.open</a>,
<a href="../api_java/env_remove.html">DbEnv.remove</a>,
<a href="../api_java/env_strerror.html">DbEnv.strerror</a>,
<a href="../api_java/env_version.html">DbEnv.get_version_string</a>
<a href="../api_java/env_set_cachesize.html">DbEnv.set_cachesize</a>,
<a href="../api_java/env_set_errcall.html">DbEnv.set_errcall</a>,
<a href="../api_java/env_set_error_stream.html">DbEnv.set_error_stream</a>,
<a href="../api_java/env_set_errpfx.html">DbEnv.set_errpfx</a>,
<a href="../api_java/env_set_flags.html">DbEnv.set_flags</a>,
<a href="../api_java/env_set_mutexlocks.html">DbEnv.set_mutexlocks</a>,
and
<a href="../api_java/env_set_verbose.html">DbEnv.set_verbose</a>.
</tt>
<table><tr><td><br></td><td width="1%">
<a href="../api_java/java_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>