3.7. Compaction Configuration — Apache CouchDB® 2.3 Documentation

# 3.7. Compaction Configuration

## 3.7.1. Database Compaction Options

`[database_compaction]`
  `doc_buffer_size`

    Specifies the copy buffer’s maximum size in bytes:

        [database_compaction]
        doc_buffer_size = 524288

  `checkpoint_after`

    Triggers a checkpoint after the specified amount of bytes were successfully copied to the compacted database:

        [database_compaction]
        checkpoint_after = 5242880

## 3.7.2. Compaction Daemon Rules

`[compactions]`

  A list of rules to determine when to run automatic compaction. The `daemons/compaction_daemon` compacts databases and their respective view groups when all the condition parameters are satisfied. Configuration can be per-database or global, and it has the following format:

      [compactions]
      database_name = [ {ParamName, ParamValue}, {ParamName, ParamValue}, ... ]
      _default = [ {ParamName, ParamValue}, {ParamName, ParamValue}, ... ]

  For example:

      [compactions]
      _default = [{db_fragmentation, "70%"}, {view_fragmentation, "60%"}, {from, "23:00"}, {to, "04:00"}]

  - `db_fragmentation`: If the ratio of legacy data, including metadata, to current data in the database file size is equal to or greater than this value, this condition is satisfied. The percentage is expressed as an integer percentage. This value is computed as:

        (file_size - data_size) / file_size * 100

    The data_size and file_size values can be obtained when querying `GET /{db}`.

  - `view_fragmentation`: If the ratio of legacy data, including metadata, to current data in a view index file size is equal to or greater then this value, this database compaction condition is satisfied. The percentage is expressed as an integer percentage. This value is computed as:

        (file_size - data_size) / file_size * 100

    The data_size and file_size values can be obtained when querying a view group’s information URI.

  - `from` and `to`: The period for which a database (and its view group) compaction is allowed. The value for these parameters must obey the format:

        HH:MM - HH:MM  (HH in [0..23], MM in [0..59])

  - `strict_window`: If a compaction is still running after the end of the allowed period, it will be canceled if this parameter is set to true. It defaults to false and is meaningful only if the period parameter is also specified.

  - `parallel_view_compaction`: If set to true, the database and its views are compacted in parallel. This is only useful on certain setups, like for example when the database and view index directories point to different disks. It defaults to false.

  Before a compaction is triggered, an estimation of how much free disk space is needed is computed. This estimation corresponds to two times the data size of the database or view index. When there’s not enough free disk space to compact a particular database or view index, a warning message is logged.

  Examples:

  1. >     [{db_fragmentation, "70%"}, {view_fragmentation, "60%"}]

     The foo database is compacted if its fragmentation is 70% or more. Any view index of this database is compacted only if its fragmentation is 60% or more.

  2. >     [{db_fragmentation, "70%"}, {view_fragmentation, "60%"}, {from, "00:00"}, {to, "04:00"}]

     Similar to the preceding example but a compaction (database or view index) is only triggered if the current time is between midnight and 4 AM.

  3. >     [{db_fragmentation, "70%"}, {view_fragmentation, "60%"}, {from, "00:00"}, {to, "04:00"}, {strict_window, true}]

     Similar to the preceding example - a compaction (database or view index) is only triggered if the current time is between midnight and 4 AM. If at 4 AM the database or one of its views is still compacting, the compaction process will be canceled.

  4. >     [{db_fragmentation, "70%"}, {view_fragmentation, "60%"}, {from, "00:00"}, {to, "04:00"}, {strict_window, true}, {parallel_view_compaction, true}]

     Similar to the preceding example, but a database and its views can be compacted in parallel.

## 3.7.3. Configuration of Compaction Daemon

`[compaction_daemon]`
  `check_interval`

    The delay, in seconds, between each check for which database and view indexes need to be compacted. In other words, this delay will occur after all databases and views are compacted (or at least checked):

        [compaction_daemon]
        check_interval = 3600

  `min_file_size`

    If a database or view index file is smaller than this value (in bytes), compaction will not happen. Very small files always have high fragmentation, so compacting them is inefficient.

        [compaction_daemon]
        min_file_size = 131072

  `snooze_period_ms`

    With lots of databases and/or with lots of design docs in one or more databases, the compaction_daemon can create significant CPU load when checking whether databases and view indexes need compacting. The `snooze_period_ms` setting ensures a smoother CPU load. Defaults to 3000 milliseconds wait.

    > [compaction_daemon] snooze_period_ms = 3000

## 3.7.4. Views Compaction Options

`[view_compaction]`
  `keyvalue_buffer_size`

    Specifies maximum copy buffer size in bytes used during compaction:

        [view_compaction]
        keyvalue_buffer_size = 2097152