foundationdb icon indicating copy to clipboard operation
foundationdb copied to clipboard

Documentation: Identifying Experimental Features across versions

Open PierreZ opened this issue 1 year ago • 5 comments

In recent updates, FoundationDB has introduced a series of experimental features. These innovations offer users new functionalities, though they remain in experimental stages in relation to their specific FDB versions. Notable among these are:

  • getMappedRanges
  • Tenant
  • MetaCluster
  • idempotent txn
  • ChangeFeed

Examples

Tenant metadata

A notable change has been observed in Tenant metadata from version 7.1 to 7.2. However, there's a lack of accessible documentation to ascertain the reliability of this feature in version 7.3.

Idempotent IDs

This is actually what triggered the issue, as I would like to use them, but I'm unsure about their current state. Are they safe to use in 7.3?

Proposal

To address these questions, I would like to add a new page in the documentation dedicated to these experimental features. This section would include a comprehensive matrix correlating each feature with its respective FDB version. A suggested format for this matrix is a Markdown table, like this one:

7.1 7.2 7.3
GetMappedRange experimental experimental experimental
Tenant highly experimental highly experimental stable
Idempotency IDs experimental stable stable

What do you think of this? I would be happy to write the documentation :smile:

PierreZ avatar Jan 17 '24 15:01 PierreZ

I think this is a good idea. Thanks!

jzhou77 avatar Jan 17 '24 22:01 jzhou77

@jzhou77 Is GetMappedRange still considered experimental in 7.3?

rajivr avatar Jan 18 '24 01:01 rajivr

How can I identify the status of each features?

PierreZ avatar Jan 18 '24 14:01 PierreZ

@jzhou77 Is GetMappedRange still considered experimental in 7.3?

Yes

jzhou77 avatar Jan 20 '24 18:01 jzhou77

If that's ok with you @jzhou77, I will create the documentation page, and try to find core-contributors to give their insights about the features :smile:

PierreZ avatar Jan 26 '24 14:01 PierreZ