---
title: cbft-bleve for Scorch Indexes
description: The <code>cbft-bleve</code> tool supports commands that return
  information on <em>Scorch</em> index partitions.
pubDate: 2026-08-17T09:53:44.266Z
antora:
  editUrl: https://github.com/couchbase/docs-server/edit/release/8.0/modules/cli/pages/cbft-bleve-scorch.adoc
  xref: xref:server:cli:cbft-bleve-scorch.adoc[]
---

[Consult the llms.txt file for a full list of contents](/llms.txt)
[View original HTML](/server/current/cli/cbft-bleve-scorch.html)

# cbft-bleve for Scorch Indexes

> The `cbft-bleve` tool supports commands that return information on _Scorch_ index partitions. 

## [](#using-cbft-bleve-on-scorch-indexes)Using cbft-bleve on Scorch indexes.

The `cbft-bleve` tool can be used to retrieve information on a _Scorch_ index partition in either of the following ways:

* By means of the subset of _top level_ command-values that can also be used on _Moss_ index partitions.
* Specifically by means of the `scorch` top level command-value, which entails additional syntax, and can be used on _Scorch_ index partitions only.

These options are described below. Examples are for MacOS.

### [](#using-top-level-command-values)Using Top Level Command-Values

The top-level [Syntax](cbft-bleve.md#syntax) for `cbft-bleve` permits the following to be specified as values for the principal `command`, and to be used alike on _Moss_ index partitions (on all Couchbase-Server supported platforms) and on _Scorch_ index partitions (on all platforms except _Red Hat-based distributions_ and _Ubuntu_): [check](cbft-bleve-moss.md#check), [count](cbft-bleve-moss.md#count), [dictionary](cbft-bleve-moss.md#dictionary), [fields](cbft-bleve-moss.md#fields), [mapping](cbft-bleve-moss.md#mapping), [query](cbft-bleve-moss.md#query), and [registry](cbft-bleve-moss.md#registry).

For a description of the syntax entailed by each value, and instances of command-output, see the examples provided for _Moss_ index partitions, in [cbft-bleve for Moss Indexes](cbft-bleve-moss.md).

### [](#using-the-scorch-command-value)Using the `scorch` Command-Value

The `scorch` command-value specifies that the target index-partition is a _Scorch_ index. The basic syntax is as follows:

cbft-bleve scorch [command] [index-store-path] [snapshot] [flags]

The available `commands` are listed in the sections below. A `command` _must_ be specified. Note that a command summary can be printed to standard output, by entering `cbft-bleve scorch --help` (or `-h`).

The `index-store-path`, which is mandatory, is the filesystem path of the `store` subdirectory, located under the directory for the _Scorch_ index partition. See [Specifying Index Partitions](cbft-bleve.md#specifying-index-partitions).

The `snapshot` is a reference to a particular _snapshot_, within a _Scorch_\-index partition, on which information is to be retrieved. See immediately below.

The `flags` argument can always be `--help`, which prints help text to standard output. Additional values are indicated as appropriate, below.

## [](#understanding-snapshots)Understanding Snapshots

Each _Scorch_ index contains a number of _snapshots_, each of which represents the state of all indexed data at a particular point in time: this supports _high-performance rollbacks_ of the index. By default, three snapshots are simultaneously available: each is referred to by a unique integer known as the _snapshot epoch_. To change the number of available snapshots, include the `numSnapshotsToKeep` key to the `store` object within the index-definition, specifying an appropriate integer as the value. For example, the following establishes `4` snapshots to be made simultaneously available:

   "store": {
     "kvStoreName": "scorchStore",
     "indexType": "scorch",
     "numSnapshotsToKeep": 4
   }

For more information, see [Index-Creation with the REST API](../search/create-search-indexes.md#index-creation-with-the-rest-api).

Some `commands` used by `cbft-bleve scorch` refer to and return information on a specific snapshot epoch. Information on currently available snapshot epochs and their unique identifying integers is returned by means of the `snapshot` command.

## [](#snapshot)snapshot

The `snapshot` command prints a list of _snapshot epochs_ that currently exist for a specified Scorch index partition. The syntax is as follows:

cbft-bleve scorch snapshot [index-store-path] [flags]

### [](#example-print-snapshot-epochs)Example: Print Snapshot Epochs

The following example prints the snapshot epochs for the specified index partition:

/Applications/Couchbase\ Server.app/Contents/Resources/couchbase-core/bin\
/cbft-bleve scorch snapshot \
/Users/<username>/Library/Application\ Support/Couchbase\
/var/lib/couchbase/data/@fts/scorchIndex_fdcb47f176931043_13aa53f3.pindex/store/

If successful, the command prints the following:

snapshot epoch: 37
snapshot epoch: 36
snapshot epoch: 1

## [](#ascii)ascii

The `ascii` command prints an ascii representation of the _segments_ in a snapshot. Each segment is a batch of items from the snapshot. The syntax is as follows:

cbft-bleve scorch ascii [index-store-path] [snapshot]

The `snapshot` argument, which is required, must be the unique integer associated with a _snapshot epoch_ for the specified index, as returned by the `snapshot` command.

### [](#example-print-an-ascii-representation)Example: Print an ASCII Representation

The following example prints an ascii representation of the segments in the snapshot specified for an index partition.

/Applications/Couchbase\ Server.app/Contents/Resources/couchbase-core/bin\
/cbft-bleve scorch ascii \
/Users/<username>/Library/Application\ Support/Couchbase\
/var/lib/couchbase/data/@fts/scorchIndex_fdcb47f176931043_13aa53f3.pindex/store/ \
37

If successful, the command returns the following:

37    37:  5433 / 5433 -   .........................

## [](#deleted)deleted

The `deleted` command prints a bitmap that represents items that have been _deleted_ from each segment of a specified snapshot, during the course of the segment's existence. The syntax is as follows:

cbft-bleve scorch deleted [index-store-path] [snapshot] [flags]

The `snapshot` argument, which is required, must be the unique integer associated with a _snapshot epoch_ for the specified index partition, as returned by the `snapshot` command.

### [](#example-print-the-deleted-bitmap)Example: Print the Deleted Bitmap

The following example prints the bitmap of deleted items for the segments in snapshot `67`:

/Applications/Couchbase\ Server.app/Contents/Resources/couchbase-core/bin\
/cbft-bleve scorch deleted \
/Users/<username>/Library/Application\ Support/Couchbase\
/var/lib/couchbase/data/@fts/scorchIndex_fdcb47f176931043_13aa53f3.pindex/store/ \
67

If successful, the command returns a list that contains deleted items, if any exist:

0 <nil>
1 <nil>
2 <nil>

## [](#info)info

The `info` command prints information on a specified index partition. The syntax is as follows:

cbft-bleve scorch info [index-store-path] [flags]

### [](#example-print-info-on-an-index-partition)Example: Print Info on an Index Partition

The following example prints information on the specified Scorch index partition.

/Applications/Couchbase\ Server.app/Contents/Resources/couchbase-core/bin\
/cbft-bleve scorch info \
/Users/<username>/Library/Application\ Support/Couchbase/var/lib/couchbase/data/@fts\
/scorchIndex_fdcb47f176931043_13aa53f3.pindex/store/

If successful, the command returns the following:

doc count: 5433

## [](#internal)internal

The `internal` command prints the internal `kv` pairs within a snapshot — these constitute _meta data_ for the snapshot. The syntax is as follows:

cbft-bleve scorch internal [index-store-path] [snapshot] [flags]

The `snapshot`, which is mandatory, must be the unique integer associated with a _snapshot epoch_ for the specified index, as returned by the `snapshot` command.

The `flags` argument can be `-a` or `--ascii`; which indicates that the values are to be printed in ascii.

### [](#example-print-kv-pairs)Example: Print KV Pairs

The following example provides an ascii print-out of the `kv` pairs for the specified index-snapshot:

/Applications/Couchbase\ Server.app/Contents/Resources/couchbase-core/bin/\
cbft-bleve scorch internal \
/Users/<username>/Library/Application\ Support/Couchbase/var/lib/couchbase/data/@fts\
/scorchIndex_fdcb47f176931043_13aa53f3.pindex/store/ 37 -a

If successful, the command provides the following output:

42 ?
43 ?
_mapping {"types":{"product":{"enabled":true,"dynamic":true,"properties":{"price":{"enabled":true,"dynamic":false,"fields":[{"name":"price","type":"number","index":true,"include_term_vectors":true,"include_in_all":true}]}}}},"default_mapping":{"enabled":false,"dynamic":true},"type_field":"_type","default_type":"_default","default_analyzer":"standard","default_datetime_parser":"dateTimeOptional","default_field":"_all","store_dynamic":false,"index_dynamic":true,"docvalues_dynamic":true,"analysis":{}}
o:39 {"seqStart":0,"seqEnd":0,"snapStart":0,"snapEnd":501,"failOverLog":[[149680438380220,0]]}
36 ?
41 ?
38 ?
o:33 {"seqStart":0,"seqEnd":0,"snapStart":0,"snapEnd":484,"failOverLog":[[81822404584738,0]]}
o:36 {"seqStart":0,"seqEnd":0,"snapStart":0,"snapEnd":492,"failOverLog":[[174103028649261,0]]}
o:37 {"seqStart":0,"seqEnd":0,"snapStart":0,"snapEnd":486,"failOverLog":[[110924524680780,0]]}
o:41 {"seqStart":0,"seqEnd":0,"snapStart":0,"snapEnd":497,"failOverLog":[[155103402616817,0]]}
o:43 {"seqStart":0,"seqEnd":0,"snapStart":0,"snapEnd":507,"failOverLog":[[217538306806458,0]]}
33 ?
37 ?
o:42 {"seqStart":0,"seqEnd":0,"snapStart":0,"snapEnd":492,"failOverLog":[[47136605887494,0]]}
34 ?
o:35 {"seqStart":0,"seqEnd":0,"snapStart":0,"snapEnd":485,"failOverLog":[[181174121062964,0]]}
40 ?
o:34 {"seqStart":0,"seqEnd":0,"snapStart":0,"snapEnd":499,"failOverLog":[[128188523546156,0]]}
o:38 {"seqStart":0,"seqEnd":0,"snapStart":0,"snapEnd":486,"failOverLog":[[161601347095991,0]]}
o:40 {"seqStart":0,"seqEnd":0,"snapStart":0,"snapEnd":504,"failOverLog":[[38787600199365,0]]}
35 ?
39 ?