|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>JSDoc: Source: db/ldb.js</title>
|
|
|
|
|
|
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
|
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
|
|
|
<!--[if lt IE 9]>
|
|
|
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
|
|
|
<![endif]-->
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
|
|
<h1 class="page-title">Source: db/ldb.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
<article>
|
|
|
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
|
|
|
* ldb.js - database backend for bcoin
|
|
|
|
|
* Copyright (c) 2014-2015, Fedor Indutny (MIT License)
|
|
|
|
|
* Copyright (c) 2014-2017, Christopher Jeffrey (MIT License).
|
|
|
|
|
* https://github.com/bcoin-org/bcoin
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
'use strict';
|
|
|
|
|
|
|
|
|
|
var assert = require('assert');
|
|
|
|
|
var LowlevelUp = require('./lowlevelup');
|
|
|
|
|
var util = require('../utils/util');
|
|
|
|
|
var backends = require('./backends');
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Create a database.
|
|
|
|
|
* @alias module:db.LDB
|
|
|
|
|
* @param {Object} options
|
|
|
|
|
* @param {Boolean} options.compression
|
|
|
|
|
* @param {Number} options.cacheSize
|
|
|
|
|
* @param {Number} options.writeBufferSize
|
|
|
|
|
* @param {Number} options.maxOpenFiles
|
|
|
|
|
* @param {Boolean} options.sync
|
|
|
|
|
* @param {Number} options.mapSize
|
|
|
|
|
* @param {Boolean} options.writeMap
|
|
|
|
|
* @param {String} options.db - Database backend (`"leveldb"` by default).
|
|
|
|
|
* @param {String} options.name - Database name.
|
|
|
|
|
* @param {String} options.location - Database location (overrides `name`).
|
|
|
|
|
* @returns {LowlevelUp}
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
function LDB(options) {
|
|
|
|
|
var target = LDB.getTarget(options);
|
|
|
|
|
var cacheSize = options.cacheSize;
|
|
|
|
|
|
|
|
|
|
if (target.backend !== 'rbt')
|
|
|
|
|
util.mkdir(target.location, true);
|
|
|
|
|
|
|
|
|
|
if (!cacheSize)
|
|
|
|
|
cacheSize = 16 << 20;
|
|
|
|
|
|
|
|
|
|
return new LowlevelUp(target.location, {
|
|
|
|
|
// Generic
|
|
|
|
|
createIfMissing: options.createIfMissing !== false,
|
|
|
|
|
errorIfExists: options.errorIfExists === true,
|
|
|
|
|
|
|
|
|
|
// LevelDB
|
|
|
|
|
compression: options.compression === true,
|
|
|
|
|
cacheSize: cacheSize / 2 | 0,
|
|
|
|
|
writeBufferSize: cacheSize / 4 | 0,
|
|
|
|
|
maxOpenFiles: options.maxFiles || 64,
|
|
|
|
|
paranoidChecks: false,
|
|
|
|
|
memory: false,
|
|
|
|
|
|
|
|
|
|
// LMDB
|
|
|
|
|
sync: options.sync || false,
|
|
|
|
|
mapSize: options.mapSize || 256 * (1024 << 20),
|
|
|
|
|
writeMap: options.writeMap || false,
|
|
|
|
|
noSubdir: options.noSubdir !== false,
|
|
|
|
|
|
|
|
|
|
// Browser
|
|
|
|
|
bufferKeys: options.bufferKeys,
|
|
|
|
|
|
|
|
|
|
db: target.db
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get database name and extension based on options.
|
|
|
|
|
* @param {String} db
|
|
|
|
|
* @returns {Object}
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
LDB.getBackend = function getBackend(db) {
|
|
|
|
|
var name, ext;
|
|
|
|
|
|
|
|
|
|
if (!db)
|
|
|
|
|
db = 'memory';
|
|
|
|
|
|
|
|
|
|
switch (db) {
|
|
|
|
|
case 'ldb':
|
|
|
|
|
case 'leveldb':
|
|
|
|
|
case 'leveldown':
|
|
|
|
|
name = 'leveldown';
|
|
|
|
|
ext = 'ldb';
|
|
|
|
|
break;
|
|
|
|
|
case 'rdb':
|
|
|
|
|
case 'rocksdb':
|
|
|
|
|
case 'rocksdown':
|
|
|
|
|
name = 'rocksdown';
|
|
|
|
|
ext = 'rdb';
|
|
|
|
|
break;
|
|
|
|
|
case 'mdb':
|
|
|
|
|
case 'lmdb':
|
|
|
|
|
name = 'lmdb';
|
|
|
|
|
ext = 'mdb';
|
|
|
|
|
break;
|
|
|
|
|
case 'mem':
|
|
|
|
|
case 'memory':
|
|
|
|
|
case 'rbt':
|
|
|
|
|
name = 'rbt';
|
|
|
|
|
ext = 'mem';
|
|
|
|
|
break;
|
|
|
|
|
default:
|
|
|
|
|
name = db;
|
|
|
|
|
ext = 'db';
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return { name: name, ext: ext };
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get target backend and location.
|
|
|
|
|
* @param {Object} options
|
|
|
|
|
* @returns {Object}
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
LDB.getTarget = function getTarget(options) {
|
|
|
|
|
var backend = LDB.getBackend(options.db);
|
|
|
|
|
var location = options.location;
|
|
|
|
|
var db = backends.get(backend.name);
|
|
|
|
|
|
|
|
|
|
if (typeof location !== 'string') {
|
|
|
|
|
assert(backend.name === 'rbt', 'Location required.');
|
|
|
|
|
location = 'rbt';
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return {
|
|
|
|
|
db: db,
|
|
|
|
|
backend: backend.name,
|
|
|
|
|
location: location + '.' + backend.ext
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Expose
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
module.exports = LDB;
|
|
|
|
|
</code></pre>
|
|
|
|
|
</article>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<nav>
|
|
|
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bcoin.html">bcoin</a></li><li><a href="module-bip70.html">bip70</a></li><li><a href="module-bip70_pk.html">bip70/pk</a></li><li><a href="module-bip70_x509.html">bip70/x509</a></li><li><a href="module-blockchain.html">blockchain</a></li><li><a href="module-blockchain_common.html">blockchain/common</a></li><li><a href="module-btc.html">btc</a></li><li><a href="module-coins.html">coins</a></li><li><a href="module-crypto.html">crypto</a></li><li><a href="module-crypto_chachapoly.html">crypto/chachapoly</a></li><li><a href="module-crypto_ec.html">crypto/ec</a></li><li><a href="module-crypto_pk.html">crypto/pk</a></li><li><a href="module-crypto_schnorr.html">crypto/schnorr</a></li><li><a href="module-crypto_siphash.html">crypto/siphash</a></li><li><a href="module-db.html">db</a></li><li><a href="module-hd.html">hd</a></li><li><a href="module-http.html">http</a></li><li><a href="module-mempool.html">mempool</a></li><li><a href="module-mining.html">mining</a></li><li><a href="module-net.html">net</a></li><li><a href="module-net_bip152.html">net/bip152</a></li><li><a href="module-net_common.html">net/common</a></li><li><a href="module-net_dns.html">net/dns</a></li><li><a href="module-net_packets.html">net/packets</a></li><li><a href="module-net_socks.html">net/socks</a></li><li><a href="module-net_tcp.html">net/tcp</a></li><li><a href="module-node.html">node</a></li><li><a href="module-node_config.html">node/config</a></li><li><a href="module-primitives.html">primitives</a></li><li><a href="module-protocol.html">protocol</a></li><li><a href="module-protocol_consensus.html">protocol/consensus</a></li><li><a href="module-protocol_errors.html">protocol/errors</a></li><li><a href="module-protocol_networks.html">protocol/networks</a></li><li><a href="module-protocol_policy.html">protocol/policy</a></li><li><a href="module-script.html">script</a></li><li><a href="module-script_common.html">script/common</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_asn1.html">utils/asn1</a></li><li><a href="module-utils_base32.html">utils/base32</a></li><li><a href="module-utils_base58.html">utils/base58</a></li><li><a href="module-utils_co.html">utils/co</a></li><li><a href="module-utils_encoding.html">utils/encoding</a></li><li><a href="module-utils_ip.html">utils/ip</a></li><li><a href="module-utils_pem.html">utils/pem</a></li><li><a href="module-utils_protobuf.html">utils/protobuf</a></li><li><a href="module-utils_util.html">utils/util</a></li><li><a href="module-wallet.html">wallet</a></li><li><a href="module-wallet_common.html">wallet/common</a></li><li><a href="module-wallet_records.html">wallet/records</a></li><li><a href="module-workers.html">workers</a></li><li><a href="module-workers_jobs.html">workers/jobs</a></li><li><a href="module-workers_packets.html">workers/packets</a></li></ul><h3>Classes</h3><ul><li><a href="Environment.html">Environment</a></li><li><a href="module-bip70.Payment.html">Payment</a></li><li><a href="module-bip70.PaymentACK.html">PaymentACK</a></li><li><a href="module-bip70.PaymentDetails.html">PaymentDetails</a></li><li><a href="module-bip70.PaymentRequest.html">PaymentRequest</a></li><li><a href="module-blockchain.Chain.html">Chain</a></li><li><a href="module-blockchain.ChainDB.html">ChainDB</a></li><li><a href="module-blockchain.ChainEntry.html">ChainEntry</a></li><li><a href="module-blockchain.ChainFlags.html">ChainFlags</a></li><li><a href="module-blockchain.ChainOptions.html">ChainOptions</a></li><li><a href="module-blockchain.ChainState.html">ChainState</a></li><li><a href="module-blockchain.DeploymentState.html">DeploymentState</a></li><li><a href="module-blockchain.StateCache.html">StateCache</a></li><li><a href="module-btc.Amount.html">Amount</a></li><li><a href="module-btc.URI.html">URI</a></li><li><a href="module-coins.CoinEntry.html">CoinEntry</a></li><li><a href="module-coins.Coins.html">Coins</a></li><li><a href="module-coins.CoinView.html">CoinView</a></li><li><a href="module-coins.UndoCoi
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<br class="clear">
|
|
|
|
|
|
|
|
|
|
<footer>
|
|
|
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Feb 10 2017 09:40:23 GMT-0800 (PST)
|
|
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
<script> prettyPrint(); </script>
|
|
|
|
|
<script src="scripts/linenumber.js"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
