Skip to content

Commit 6c6639a

Browse files
committed
Include sqlite3 in documentation
1 parent f023b7c commit 6c6639a

File tree

4 files changed

+16
-4
lines changed

4 files changed

+16
-4
lines changed

doc/build-osx.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Then install [Homebrew](https://brew.sh).
1919

2020
## Dependencies
2121
```shell
22-
brew install automake berkeley-db4 libtool boost miniupnpc pkg-config python qt libevent qrencode
22+
brew install automake berkeley-db4 libtool boost miniupnpc pkg-config python qt libevent qrencode sqlite
2323
```
2424

2525
If you run into issues, check [Homebrew's troubleshooting page](https://docs.brew.sh/Troubleshooting).
@@ -79,7 +79,7 @@ compiled in `disable-wallet` mode with:
7979
./configure --disable-wallet
8080
```
8181

82-
In this case there is no dependency on Berkeley DB 4.8.
82+
In this case there is no dependency on Berkeley DB 4.8 and SQLite.
8383

8484
Mining is also possible in disable-wallet mode using the `getblocktemplate` RPC call.
8585

doc/build-unix.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Optional dependencies:
4646
libqrencode | QR codes in GUI | Optional for generating QR codes (only needed when GUI enabled)
4747
univalue | Utility | JSON parsing and encoding (bundled version will be used unless --with-system-univalue passed to configure)
4848
libzmq3 | ZMQ notification | Optional, allows generating ZMQ notifications (requires ZMQ version >= 4.0.0)
49+
sqlite3 | SQLite DB | Wallet storage (only needed when wallet enabled)
4950

5051
For the versions used, see [dependencies.md](dependencies.md)
5152

@@ -91,6 +92,10 @@ pass `--with-incompatible-bdb` to configure.
9192

9293
Otherwise, you can build from self-compiled `depends` (see above).
9394

95+
SQLite is required for the wallet:
96+
97+
sudo apt install libsqlite3-dev
98+
9499
To build Bitcoin Core without wallet, see [*Disable-wallet mode*](/doc/build-unix.md#disable-wallet-mode)
95100

96101

@@ -144,6 +149,10 @@ libqrencode (optional) can be installed with:
144149

145150
sudo dnf install qrencode-devel
146151

152+
SQLite can be installed with:
153+
154+
sudo dnf install sqlite-devel
155+
147156
Notes
148157
-----
149158
The release is built with GCC and then "strip bitcoind" to strip the debug
@@ -238,7 +247,7 @@ disable-wallet mode with:
238247

239248
./configure --disable-wallet
240249

241-
In this case there is no dependency on Berkeley DB 4.8.
250+
In this case there is no dependency on Berkeley DB 4.8 and SQLite.
242251

243252
Mining is also possible in disable-wallet mode using the `getblocktemplate` RPC call.
244253

doc/dependencies.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ These are the dependencies currently used by Bitcoin Core. You can find instruct
2121
| Python (tests) | | [3.5](https://www.python.org/downloads) | | | |
2222
| qrencode | [3.4.4](https://fukuchi.org/works/qrencode) | | No | | |
2323
| Qt | [5.9.8](https://download.qt.io/official_releases/qt/) | [5.5.1](https://github.com/bitcoin/bitcoin/issues/13478) | No | | |
24+
| SQLite | [3.32.1](https://sqlite.org/download.html) | [3.7.17](https://github.com/bitcoin/bitcoin/pull/19077) | | | |
2425
| XCB | | | | | [Yes](https://github.com/bitcoin/bitcoin/blob/master/depends/packages/qt.mk) (Linux only) |
2526
| xkbcommon | | | | | [Yes](https://github.com/bitcoin/bitcoin/blob/master/depends/packages/qt.mk) (Linux only) |
2627
| ZeroMQ | [4.3.1](https://github.com/zeromq/libzmq/releases) | 4.0.0 | No | | |
@@ -33,6 +34,7 @@ Some dependencies are not needed in all configurations. The following are some f
3334
#### Options passed to `./configure`
3435
* MiniUPnPc is not needed with `--with-miniupnpc=no`.
3536
* Berkeley DB is not needed with `--disable-wallet`.
37+
* SQLite is not needed with `--disable-wallet`.
3638
* Qt is not needed with `--without-gui`.
3739
* If the qrencode dependency is absent, QR support won't be added. To force an error when that happens, pass `--with-qrencode`.
3840
* ZeroMQ is needed only with the `--with-zmq` option.

doc/files.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,9 @@ Subdirectory | File(s) | Description
7272
-------------|-------------------|------------
7373
`database/` | BDB logging files | Part of BDB environment; created at start and deleted on shutdown; a user *must keep it as safe* as personal wallet `wallet.dat`
7474
`./` | `db.log` | BDB error file
75-
`./` | `wallet.dat` | Personal wallet (BDB) with keys and transactions
75+
`./` | `wallet.dat` | Personal wallet with keys and transactions. May be either a Berkeley DB or SQLite database file.
7676
`./` | `.walletlock` | Wallet lock file
77+
`./` | `wallet.dat-journal` | SQLite Rollback Journal file for `wallet.dat`. Usually created at start and deleted on shutdown. A user *must keep it as safe* as the `wallet.dat` file.
7778

7879
1. Each user-defined wallet named "wallet_name" resides in `wallets/wallet_name/` subdirectory.
7980

0 commit comments

Comments
 (0)