Product Documentation

FairCom RTG V3 Update Guide

Previous Topic

Next Topic

<keycompress> Option to Create Files with Key Compression

The <keycompress> option now defaults to the new index compression. In internal testing, FairCom has observed a 6X reduction in index sizes, which led to a 2X increase in transaction throughput.

The following <keycompress> sub-options specify which compression type to use:

  • <rle> - Indicate to compress the whole key using a simple RLE algorithm.
  • <padding> - Indicate to compress the padding characters of the key.

The new index compression does not support the <leading> compression type.

The <rle> and <padding> sub-options are mutually exclusive unlike the old index compression where it was possible to combine <leading> and <padding>. The new index compression does not support <leading> compression type.

The old index compression can still be used to create files by disabling the <keycompress vlennod> attribute which is enabled by default. When <keycompress vlennod> attribute is disabled, the old index compression sub-options <leading> and <padding> can be specified. Of course the new <rle> cannot be specified when the <keycompress vlennod> attribute is disabled.

The following example turn on the new index compression:

<keycompress/>

<keycompress>1</keycompress>

<keycompress><rle/></keycompress>

<keycompression><padding>1</padding></keycompression>

The following examples enabled the old index compression:

<keycompress vlennod="no"/>

<keycompress vlennod="0">1</keycompress>

<keycompress vlennod="false"><leading>1</leading></keycompress>

<keycompression vlennod="n"><leading/><padding/></keycompression>

TOCIndex