From 780b92ada9afcf1d58085a83a0b9e6bc982203d1 Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Tue, 17 Feb 2015 17:25:57 +0000 Subject: Imported from /home/lorry/working-area/delta_berkeleydb/db-6.1.23.tar.gz. --- docs/api_reference/C/set_blob_threshold.html | 204 +++++++++++++++++++++++++++ 1 file changed, 204 insertions(+) create mode 100644 docs/api_reference/C/set_blob_threshold.html (limited to 'docs/api_reference/C/set_blob_threshold.html') diff --git a/docs/api_reference/C/set_blob_threshold.html b/docs/api_reference/C/set_blob_threshold.html new file mode 100644 index 00000000..7a79ad57 --- /dev/null +++ b/docs/api_reference/C/set_blob_threshold.html @@ -0,0 +1,204 @@ + + + + + + DB->set_blob_threshold() + + + + + + + + + +
+
+
+
+

DB->set_blob_threshold()

+
+
+
+
#include <db.h>
+
+int
+DB->set_blob_threshold(DB *db, u_int32_t bytes, u_int32_t flags);  
+

+ The DB->set_blob_threshold() method sets + a size which is used to determine when a data item will be + stored as a BLOB. Data items sized less than this threshold are + stored as normal data within the database. Data items larger than + this size are stored on-disk in a subdirectory set aside for the + purpose. +

+

+ If this threshold value is set to 0, then BLOBs + will never be used by the database. +

+

+ It is illegal to set a BLOB threshold if any of the following flags + were specified for the database: + DB_CHKSUM, + DB_ENCRYPT, + DB_DUP, and + DB_DUPSORT. +

+

+ It is also illegal to set a BLOB threshold if compression is + turned on for the database. That is, if DB->set_bt_compress() has + been called for the database handle. +

+

+ This method configures the underlying database. The BLOB threshold + is stored in the database at database creation time. Any BLOB + threshold set after creating the database is ignored. +

+

+ This method may not be called after DB->open() is called. +

+

+ Unless otherwise specified, the + DB->set_blob_threshold() + + method returns a non-zero error value on failure and 0 on success. + + + +

+
+
+
+
+

Parameters

+
+
+
+
+
+
+
+

bytes

+
+
+
+

+ The bytes parameter + identifies the threshold size, in bytes, beyond which a + data item is stored as a BLOB. +

+
+
+
+
+
+

flags

+
+
+
+

+ The flags parameter must be set to 0. +

+
+
+
+
+
+
+

Errors

+
+
+
+

+ The DB->set_blob_threshold() + + method may fail and return one of the following non-zero errors: + + + +

+
+
+
+
+

EINVAL

+
+
+
+

+ If the method was called after DB->open() was called; or if + an invalid flag or parameter was specified; or if + compression is turned on for the database; or if the + database is configured with one or more of the following + flags: + DB_CHKSUM, + DB_ENCRYPT, + DB_DUP, and + DB_DUPSORT. +

+
+
+
+
+
+
+

Class

+
+
+
+

+ DB +

+
+
+
+
+
+

See Also

+
+
+
+

+ BLOBs and Related Methods +

+
+
+ + + -- cgit v1.2.1