updated documentation

This commit is contained in:
Evan Tschannen 2021-05-04 09:26:09 -07:00
parent a1436406b7
commit 3175e82393
3 changed files with 4 additions and 4 deletions

View File

@ -74,7 +74,8 @@ private:
SnapshotCache::iterator cache;
WriteMap::iterator writes;
KeyValueRef temp;
bool bypassUnreadable;
bool bypassUnreadable; // When set, allows read from sections of keyspace that have become unreadable because of
// versionstamp operations
void updateCmp();
};

View File

@ -2242,7 +2242,6 @@ void ReadYourWritesTransaction::setOptionImpl(FDBTransactionOptions::Option opti
break;
case FDBTransactionOptions::BYPASS_UNREADABLE:
validateOptionValue(value, false);
TraceEvent("ReadVersionStampValueOptionSet");
options.bypassUnreadable = true;
break;
default:

View File

@ -193,7 +193,7 @@ description is not currently required but encouraged.
<Option name="distributed_transaction_trace_disable" code="601"
description="Disable tracing for all transactions." />
<Option name="transaction_bypass_unreadable" code="700"
description="Allows ``get`` operations to read from sections of keyspace that have become unreadable because of versionstamp operations."
description="Allows ``get`` operations to read from sections of keyspace that have become unreadable because of versionstamp operations. This sets the ``bypass_unreadable`` option of each transaction created by this database. See the transaction option description for more information."
defaultFor="1100"/>
</Scope>
@ -288,7 +288,7 @@ description is not currently required but encouraged.
<Option name="expensive_clear_cost_estimation_enable" code="1000"
description="Asks storage servers for how many bytes a clear key range contains. Otherwise uses the location cache to roughly estimate this." />
<Option name="bypass_unreadable" code="1100"
description="Allows ``get`` operations to read from sections of keyspace that have become unreadable because of versionstamp operations." />
description="Allows ``get`` operations to read from sections of keyspace that have become unreadable because of versionstamp operations. These reads will view versionstamp operations as if they were set operations." />
</Scope>
<!-- The enumeration values matter - do not change them without