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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/*-
* See the file LICENSE for redistribution information.
*
* Copyright (c) 2011, 2015 Oracle and/or its affiliates. All rights reserved.
*
*/
using System;
using System.Collections.Generic;
using System.Text;
namespace BerkeleyDB {
/// <summary>
/// A class representing configuration parameters for
/// <see cref="HeapDatabase"/>
/// </summary>
public class HeapDatabaseConfig : DatabaseConfig {
/// <summary>
/// The path of the directory where blobs are stored.
/// <para>
/// If the database is opened within <see cref="DatabaseEnvironment"/>,
/// this path setting will be ignored during
/// <see cref="HeapDatabase.Open"/>. Use
/// <see cref="HeapDatabase.BlobDir"/> to identify the current storage
/// location of blobs after opening the database.
/// </para>
/// </summary>
public string BlobDir;
internal bool blobThresholdIsSet;
private uint blobThreshold;
/// <summary>
/// The size in bytes which is used to determine when a data item
/// will be stored as a blob.
/// <para>
/// Any data item that is equal to or larger in size than the
/// threshold value is automatically stored as a blob.
/// </para>
/// <para>
/// If the threshold value is 0, blobs are never used by the
/// database.
/// </para>
/// <para>
/// It is illegal to enable blob support in the database which is configured
/// as in-memory database or with chksum, encryption, duplicates,
/// sorted duplicates, compression, multiversion concurrency control
/// and transactional read operations with degree 1 isolation.
/// </para>
/// </summary>
public uint BlobThreshold {
get { return blobThreshold; }
set {
blobThresholdIsSet = true;
blobThreshold = value;
}
}
/// <summary>
/// The policy for how to handle database creation.
/// </summary>
/// <remarks>
/// If the database does not already exist and
/// <see cref="CreatePolicy.NEVER"/> is set,
/// <see cref="HeapDatabase.Open"/> fails.
/// </remarks>
public CreatePolicy Creation;
internal new uint openFlags {
get {
uint flags = base.openFlags;
flags |= (uint)Creation;
return flags;
}
}
private uint _gbytes;
private uint _bytes;
internal bool maxSizeIsSet;
/// <summary>
/// The gigabytes component of the maximum on-disk database file size.
/// </summary>
public uint MaxSizeGBytes { get { return _gbytes; } }
/// <summary>
/// The bytes component of the maximum on-disk database file size.
/// </summary>
public uint MaxSizeBytes { get { return _bytes; } }
/// <summary>
/// Set the maximum on-disk database file size used by the database. Attempts
/// to update or create records in a database that have reached this file size
/// limit throw a <see cref="HeapFullException"/>. If this value is not set,
/// the database file size can grow infinitely.
/// </summary>
///<remarks>
/// The size specified must be at least three times the
/// database page size. The database must contain at least
/// three database pages. You can set the database page size using
/// <see cref="DatabaseConfig.PageSize"/>.
///
/// If this value is set for an existing database, the size specified
/// here must match the size used to create the database. Specifying an
/// incorrect size does not result in an error until the database is opened.
/// </remarks>
/// <param name="GBytes">The size of the database is set to GBytes
/// gigabytes plus Bytes.</param>
/// <param name="Bytes">The size of the database is set to GBytes
/// gigabytes plus Bytes.</param>
public void MaxSize(uint GBytes, uint Bytes) {
maxSizeIsSet = true;
_gbytes = GBytes;
_bytes = Bytes;
}
private uint _regionsz;
internal bool regionszIsSet;
/// <summary>
/// The number of pages in a region of the database. If this value is
/// never set, the default region size for the database's page size is
/// used. You can set the database page size using
/// <see cref="DatabaseConfig.PageSize"/>.
///
/// If the database already exists, this value is ignored. If the
/// specified region size is larger than the maximum region size for the
/// database's page size, an error is returned when
/// <see cref="Database.Open"/> is called. The maximum allowable region
/// size is included in the error message.
/// </summary>
public uint RegionSize {
get { return _regionsz; }
set {
_regionsz = value;
regionszIsSet = true;
}
}
/// <summary>
/// Instantiate a new HeapDatabaseConfig object
/// </summary>
public HeapDatabaseConfig() {
blobThresholdIsSet = false;
Creation = CreatePolicy.NEVER;
}
}
}
|
