LogoLogo
Back to Speedb.io⭐ GitHubDiscord
  • 👋About
    • Speedb Use Cases
    • Speedb Communication Channels
    • Release Cadence
    • Releases
    • Roadmap
  • 💻Getting started
    • Speedb Quick Start Example
    • Dependencies
    • How to Compile Speedb
    • Drop-in Replacement
    • Use prebuilt binaries
    • How to contribute
      • Contribute code
      • Feature request process
      • Submit a pull request
      • Add or update documentation
      • Report bugs and other issues
      • Help with new and ongoing feature development
    • Kafka Streams: How to use Speedb instead of RocksDB?
  • ✨Speedb Features
    • Memory Tracking
    • Speedb Tuning Function
    • Table Pinning Policy
    • Snapshot Optimization
    • On Thread Start Callback
    • Write Flow
    • Global Delayed write
    • Live Configuration Changes
    • Report Index Size per Column Family
    • Proactive Flushing
    • Sorted Hash Memtable
    • Paired Bloom Filter
  • ➕Enhancements
    • Range Delete Improvement
    • Dynamic Delayed Writes
    • Reduce switch memtable latency
  • 🛠️Tools
    • Log Parser
    • DB_bench: Groups
    • Beezcli Tool
  • 🔦RocksDB Basics
  • 📈Performance testing
Powered by GitBook
On this page
  • Compile in Release mode
  • Compile in Debug mode

Was this helpful?

Edit on GitHub
  1. Getting started

How to Compile Speedb

This page describes how to clone, compile and use the library.

PreviousDependenciesNextDrop-in Replacement

Last updated 2 years ago

Was this helpful?

Check the prerequisites before you start compiling in the page.

Compile in Release mode

  • Recommended: make static_lib will compile the Speedb static library (librocksdb.a) in release mode.

  • make shared_lib will compile the Speedb shared library (librocksdb.so) in release mode.

Compile in Debug mode

Important: If you plan to run Speedb in production, don't compile using the default make or make all invocations. This will compile Speedb in debug mode, which is much slower than release mode.

  • make check will compile Speedb in debug mode and run all the unit tests.

  • make all will compile Speedb's static library, and all tools and unit tests. These tools depend on gflags, so you'll need to have gflags installed to run make all. This will compile Speedb in debug mode. Also, please don't use binaries compiled by make all in production.

💻
dependencies