Skip to content

Commit 9e12238

Browse files
Document sentinel values for array open end timestamps. (#5162)
[SC-49672](https://app.shortcut.com/tiledb-inc/story/49672/document-sentinel-values-for-array-open-timestamps) This PR updates the documentation of `tiledb_array_set_open_timestamp_end` to mention the sentinel values of `0` and `UINT64_MAX`. Documentation was taken from the internal `Array::set_timestamps` method. https://github.com/TileDB-Inc/TileDB/blob/3d73cf616c1f1e6f1ec541ad2ecf3759727277a9/tiledb/sm/array/array.h#L716-L732 --- TYPE: NO_HISTORY DESC: Update the documentation of `tiledb_array_set_open_timestamp_end` to mention the sentinel values of `0` and `UINT64_MAX`. --------- Co-authored-by: KiterLuc <[email protected]>
1 parent 3d73cf6 commit 9e12238

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

tiledb/sm/c_api/tiledb.h

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2402,9 +2402,16 @@ TILEDB_EXPORT int32_t tiledb_array_set_open_timestamp_start(
24022402

24032403
/**
24042404
* Sets the ending timestamp to use when opening (and reopening) the array.
2405-
* This is an inclusive bound. The UINT64_MAX timestamp is a reserved timestamp
2406-
* that will be interpretted as the current timestamp when an array is opened.
2407-
* The default value is `UINT64_MAX`.
2405+
* This is an inclusive bound. The default value is `UINT64_MAX`.
2406+
*
2407+
* When opening the array for reads, this value will be used to determine the
2408+
* ending timestamp of fragments to load. A value of `UINT64_MAX` will be
2409+
* translated to the current timestamp at which the array is opened.
2410+
*
2411+
* When opening the array for writes, this value will be used to determine the
2412+
* timestamp to write new fragments. A value of `UINT64_MAX` will use the
2413+
* current timestamp at which the array is opened. A value of 0 will use the
2414+
* current timestamp at which the fragment is written.
24082415
*
24092416
* **Example:**
24102417
*

0 commit comments

Comments
 (0)