You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: foundationdb-gen/include/620/fdb.options
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -158,7 +158,7 @@ description is not currently required but encouraged.
158
158
defaultFor="500"/>
159
159
<Optionname="transaction_retry_limit"code="501"
160
160
paramType="Int"paramDescription="number of times to retry"
161
-
description="Set a timeout in milliseconds which, when elapsed, will cause a transaction automatically to be cancelled. This sets the ``retry_limit`` option of each transaction created by this database. See the transaction option description for more information."
161
+
description="Set a maximum number of retries after which additional calls to ``onError`` will throw the most recently seen error code. This sets the ``retry_limit`` option of each transaction created by this database. See the transaction option description for more information."
paramType="Int"paramDescription="value in milliseconds of maximum delay"
@@ -172,7 +172,7 @@ description is not currently required but encouraged.
172
172
description="The read version will be committed, and usually will be the latest committed, but might not be the latest committed in the event of a simultaneous fault and misbehaving clock."
description="Addresses returned by get_addresses_for_key include the port when enabled. This will be enabled by default in api version 700, and this option will be deprecated."
175
+
description="Addresses returned by get_addresses_for_key include the port when enabled. This will be enabled by default in api version 630, and this option will be deprecated."
176
176
defaultFor="23"/>
177
177
</Scope>
178
178
@@ -183,7 +183,7 @@ description is not currently required but encouraged.
183
183
description="The read version will be committed, and usually will be the latest committed, but might not be the latest committed in the event of a simultaneous fault and misbehaving clock."/>
184
184
<Optionname="causal_read_disable"code="21" />
185
185
<Optionname="include_port_in_address"code="23"
186
-
description="Addresses returned by get_addresses_for_key include the port when enabled. This will be enabled by default in api version 700, and this option will be deprecated." />
186
+
description="Addresses returned by get_addresses_for_key include the port when enabled. This will be enabled by default in api version 630, and this option will be deprecated." />
description="The next write performed on this transaction will not generate a write conflict range. As a result, other transactions which read the key(s) being modified by the next write will not conflict with this transaction. Care needs to be taken when using this option on a transaction that is shared between multiple threads. When setting this option, write conflict ranges will be disabled on the next write operation, regardless of what thread it is on." />
189
189
<Optionname="commit_on_first_proxy"code="40"
@@ -217,7 +217,7 @@ description is not currently required but encouraged.
217
217
<Optionname="debug_transaction_identifier"code="403"paramType="String"paramDescription="String identifier to be used when tracing or profiling this transaction. The identifier must not exceed 100 characters."
218
218
description="Sets a client provided identifier for the transaction that will be used in scenarios like tracing or profiling. Client trace logging or transaction profiling must be separately enabled." />
219
219
<Optionname="log_transaction"code="404"
220
-
description="Enables tracing for this transaction and logs results to the client trace logs. The DEBUG_TRANSACTION_IDENTIFIER option must be set before using this option, and client trace logging must be enabled and to get log output." />
220
+
description="Enables tracing for this transaction and logs results to the client trace logs. The DEBUG_TRANSACTION_IDENTIFIER option must be set before using this option, and client trace logging must be enabled to get log output." />
221
221
<Optionname="transaction_logging_max_field_length"code="405"paramType="Int"paramDescription="Maximum length of escaped key and value fields."
222
222
description="Sets the maximum escaped length of key and value fields to be logged to the trace file via the LOG_TRANSACTION option, after which the field will be truncated. A negative value disables truncation." />
223
223
<Optionname="timeout"code="500"
@@ -240,7 +240,7 @@ description is not currently required but encouraged.
240
240
<Optionname="snapshot_ryw_disable"code="601"
241
241
description="Snapshot read operations will not see the results of writes done in the same transaction. This was the default behavior prior to API version 300." />
242
242
<Optionname="lock_aware"code="700"
243
-
description="The transaction can read and write to locked databases, and is resposible for checking that it took the lock."/>
243
+
description="The transaction can read and write to locked databases, and is responsible for checking that it took the lock."/>
description="By default, operations that are performed on a transaction while it is being committed will not only fail themselves, but they will attempt to fail other in-flight operations (such as the commit) as well. This behavior is intended to help developers discover situations where operations could be unintentionally executed after the transaction has been reset. Setting this option removes that protection, causing only the offending operation to fail."/>
246
246
<Optionname="read_lock_aware"code="702"
@@ -258,7 +258,7 @@ description is not currently required but encouraged.
258
258
<Optionname="want_all"code="-2"
259
259
description="Client intends to consume the entire range and would like it all transferred as early as possible." />
260
260
<Optionname="iterator"code="-1"
261
-
description="The default. The client doesn't know how much of the range it is likely to used and wants different performance concerns to be balanced. Only a small portion of data is transferred to the client initially (in order to minimize costs if the client doesn't read the entire range), and as the caller iterates over more items in the range larger batches will be transferred in order to minimize latency." />
261
+
description="The default. The client doesn't know how much of the range it is likely to used and wants different performance concerns to be balanced. Only a small portion of data is transferred to the client initially (in order to minimize costs if the client doesn't read the entire range), and as the caller iterates over more items in the range larger batches will be transferred in order to minimize latency. After enough iterations, the iterator mode will eventually reach the same byte limit as ``WANT_ALL``" />
262
262
<Optionname="exact"code="0"
263
263
description="Infrequently used. The client has passed a specific row limit and wants that many rows delivered in a single batch. Because of iterator operation in client drivers make request batches transparent to the user, consider ``WANT_ALL`` StreamingMode instead. A row limit must be specified if this mode is used." />
Copy file name to clipboardExpand all lines: foundationdb-sys/include/620/fdb_c_options.g.h
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -186,7 +186,7 @@ typedef enum {
186
186
// Parameter: (Int) value in milliseconds of timeout
187
187
FDB_DB_OPTION_TRANSACTION_TIMEOUT=500,
188
188
189
-
// Set a timeout in milliseconds which, when elapsed, will cause a transaction automatically to be cancelled. This sets the ``retry_limit`` option of each transaction created by this database. See the transaction option description for more information.
189
+
// Set a maximum number of retries after which additional calls to ``onError`` will throw the most recently seen error code. This sets the ``retry_limit`` option of each transaction created by this database. See the transaction option description for more information.
190
190
// Parameter: (Int) number of times to retry
191
191
FDB_DB_OPTION_TRANSACTION_RETRY_LIMIT=501,
192
192
@@ -202,7 +202,7 @@ typedef enum {
202
202
// Parameter: Option takes no parameter
203
203
FDB_DB_OPTION_TRANSACTION_CAUSAL_READ_RISKY=504,
204
204
205
-
// Addresses returned by get_addresses_for_key include the port when enabled. This will be enabled by default in api version 700, and this option will be deprecated.
205
+
// Addresses returned by get_addresses_for_key include the port when enabled. This will be enabled by default in api version 630, and this option will be deprecated.
// Addresses returned by get_addresses_for_key include the port when enabled. This will be enabled by default in api version 700, and this option will be deprecated.
223
+
// Addresses returned by get_addresses_for_key include the port when enabled. This will be enabled by default in api version 630, and this option will be deprecated.
224
224
// Parameter: Option takes no parameter
225
225
FDB_TR_OPTION_INCLUDE_PORT_IN_ADDRESS=23,
226
226
@@ -280,7 +280,7 @@ typedef enum {
280
280
// Parameter: (String) String identifier to be used when tracing or profiling this transaction. The identifier must not exceed 100 characters.
281
281
FDB_TR_OPTION_DEBUG_TRANSACTION_IDENTIFIER=403,
282
282
283
-
// Enables tracing for this transaction and logs results to the client trace logs. The DEBUG_TRANSACTION_IDENTIFIER option must be set before using this option, and client trace logging must be enabled and to get log output.
283
+
// Enables tracing for this transaction and logs results to the client trace logs. The DEBUG_TRANSACTION_IDENTIFIER option must be set before using this option, and client trace logging must be enabled to get log output.
284
284
// Parameter: Option takes no parameter
285
285
FDB_TR_OPTION_LOG_TRANSACTION=404,
286
286
@@ -312,7 +312,7 @@ typedef enum {
312
312
// Parameter: Option takes no parameter
313
313
FDB_TR_OPTION_SNAPSHOT_RYW_DISABLE=601,
314
314
315
-
// The transaction can read and write to locked databases, and is resposible for checking that it took the lock.
315
+
// The transaction can read and write to locked databases, and is responsible for checking that it took the lock.
316
316
// Parameter: Option takes no parameter
317
317
FDB_TR_OPTION_LOCK_AWARE=700,
318
318
@@ -333,7 +333,7 @@ typedef enum {
333
333
// Client intends to consume the entire range and would like it all transferred as early as possible.
334
334
FDB_STREAMING_MODE_WANT_ALL=-2,
335
335
336
-
// The default. The client doesn't know how much of the range it is likely to used and wants different performance concerns to be balanced. Only a small portion of data is transferred to the client initially (in order to minimize costs if the client doesn't read the entire range), and as the caller iterates over more items in the range larger batches will be transferred in order to minimize latency.
336
+
// The default. The client doesn't know how much of the range it is likely to used and wants different performance concerns to be balanced. Only a small portion of data is transferred to the client initially (in order to minimize costs if the client doesn't read the entire range), and as the caller iterates over more items in the range larger batches will be transferred in order to minimize latency. After enough iterations, the iterator mode will eventually reach the same byte limit as ``WANT_ALL``
337
337
FDB_STREAMING_MODE_ITERATOR=-1,
338
338
339
339
// Infrequently used. The client has passed a specific row limit and wants that many rows delivered in a single batch. Because of iterator operation in client drivers make request batches transparent to the user, consider ``WANT_ALL`` StreamingMode instead. A row limit must be specified if this mode is used.
0 commit comments