Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/couchbaselabs/sdk-rfcs
SDK RFCs
https://github.com/couchbaselabs/sdk-rfcs
Last synced: 1 day ago
JSON representation
SDK RFCs
- Host: GitHub
- URL: https://github.com/couchbaselabs/sdk-rfcs
- Owner: couchbaselabs
- Created: 2015-10-23T07:26:18.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T10:53:03.000Z (7 months ago)
- Last Synced: 2024-05-22T11:03:16.881Z (7 months ago)
- Homepage:
- Size: 1.15 MB
- Stars: 35
- Watchers: 50
- Forks: 15
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-list - sdk-rfcs
README
# The SDK RFCs
> _Begin with the end in mind._
>
> Steven Covey
The SDK RFCs are where we think through the mechanics and semantics of new API being added to Couchbase. The goal is to iterate on what the level of detail should be before writing a full implementation and to quickly surface things we may want to take into consideration in the design. As it grows from an idea to shipping in a supported release, an SDK RFC will traverse along:
1. **Identified**: A need has been identified for an SDK RFC, but there's little more than a filed issue to point to at the moment
2. **Draft**: The owner of the SDK RFC has started to draft up how the subject will be handled and may be reviewing with a core group. Comments are certainly welcome at this stage even though the owner hasn't worked through enough details to ask for...
3. **Review**: This SDK RFC is in a review period. Stakeholders and the owner may still be iterating on some final details before signoff. A minimum review period has been defined.
4. **Accepted**: All stakeholders have signed off and this SDK RFC is now or will be implemented soon.
Coding happens all the time and is encouraged. We just recognize there is a point where we will want to move from code having been written as a subproject or an experimental feature to a feature of the system. At that point we want the feature to take into consideration more use cases and development platforms than it had when it was merely experimental. We want the end result to feel like it's been designed, rather than merely written.
## SDK RFC Index
The following index represents the RFC numbers in their natural order, but then grouped according to their current status. As the index grows, and more SDK & Connector RFCs are added, we may add other sub-sections or a catalog to help focus on one logical topic in the future (e.g., Columnar SDK).
[comment]: # "RFC States: IDENTIFIED > DRAFT > REVIEW > ACCEPTED"
[comment]: # "Next RFC ID 84"
### Accepted RFCs
| RFC # | Description | Owner | Status |
|-------|------------------------------------------------------------------------|--------------|----------|
| 1 | [The RFC Process](rfc/0001-rfc-process.md) | Matt | ACCEPTED |
| 5 | [VBucket Retry Logic](rfc/0005-vbucket-retries.md) | Brett | ACCEPTED |
| 11 | [Connection String](rfc/0011-connection-string.md) | SDK | ACCEPTED |
| 13 | [KV Error Map](rfc/0013-kv-error-map.md) | Brett (Mark) | ACCEPTED |
| 20 | [Common Flags](rfc/0020-common-flags.md) | Brett | ACCEPTED |
| 24 | [Fast failover configuration and behavior](rfc/0024-fast-failover.md) | Jeff | ACCEPTED |
| 26 | [Ketama Hashing](rfc/0026-ketama-hashing.md) | Mike G | ACCEPTED |
| 30 | [Client-Side Compression](rfc/0030-compression.md) | Sergey | ACCEPTED |
| 32 | [Field-Level Encryption](rfc/0032-field-level-encryption.md) | Jeff | ACCEPTED |
| 48 | [SDK3 Bootstrapping](rfc/0048-sdk3-bootstrapping.md) | Brett | ACCEPTED |
| 49 | [SDK3 Retry Handling](rfc/0049-sdk3-retry-handling.md) | Michael | ACCEPTED |
| 50 | [SDK3 Datastructures](rfc/0050-sdk3-datastructures.md) | Brett | ACCEPTED |
| 51 | [SDK3 Views](rfc/0051-sdk3-views.md) | Sergey | ACCEPTED |
| 52 | [SDK3 Full Text Search](rfc/0052-sdk3-full-text-search.md) | Sergey | ACCEPTED |
| 53 | [SDK3 CRUD API](rfc/0053-sdk3-crud.md) | Jeff | ACCEPTED |
| 54 | [SDK3 Management APIs](rfc/0054-sdk3-management-apis.md) | Charles | ACCEPTED |
| 55 | [SDK3 Transcoders & Serializers](rfc/0055-serializers-transcoders.md) | Jeff | ACCEPTED |
| 56 | [SDK3 Query API](rfc/0056-sdk3-query.md) | Michael | ACCEPTED |
| 57 | [SDK3 Analytics API](rfc/0057-sdk3-analytics.md) | Michael | ACCEPTED |
| 58 | [SDK3 Error Handling](rfc/0058-error-handling.md) | Jeff | ACCEPTED |
| 59 | [SDK3 Foundation](rfc/0059-sdk3-foundation.md) | Brett | ACCEPTED |
| 61 | [SDK3 Diagnostics](rfc/0061-sdk3-diagnostics.md) | Michael N. | ACCEPTED |
| 64 | [SDK3 Field-Level Encryption](rfc/0064-sdk3-field-level-encryption.md) | David N. | ACCEPTED |
| 69 | [KV Error Map V2](rfc/0069-kv-error-map-v2.md) | Brett L. | ACCEPTED |
| 76 | [KV Subdoc Replica Reads](rfc/0076-subdoc-replica-reads.md) | Charles D. | ACCEPTED |
### Draft & Review RFCs
| RFC # | Description | Owner | Status |
|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|--------|
| 29 | Server Version Identification [\[gdoc\]](https://docs.google.com/document/d/1d6j0R0BFloQgoQ981PjAzv2AWfAIRPlkBLvlCMG7ipY/edit?usp=sharing) | Brett | DRAFT |
| 38 | Enhanced Prepared Statements [\[gdoc\]](https://docs.google.com/document/d/1JhprmvL2HwHzkg7GxouGJc67eAvKFJekgyOG23T8mVU/edit) | Michael N. | DRAFT |
| 39 | Alternate Address Support (formerly Multi Network Configurations) [\[gdoc\]](https://docs.google.com/document/d/1706x2zMsYoBXQ-8H0cpW0KDYpeBy_FZ9dt1--NnQIzk) | Brett | DRAFT |
| 45 | Advanced Analytics Querying [\[gdoc\]](https://docs.google.com/document/d/1SRYPk4ATM2PVc2Yi3WP-Ol9_qvFue9IG2uhd0UUq9GY) | Michael N. | DRAFT |
| 46 | Synchronous Replication [\[gdoc\]](https://docs.google.com/document/d/1_Bn_cKLxvqFBNVcPaPnoXMpt3JEbf_6MDvMHpJDtO_s/edit) | Sergey | DRAFT |
| 47 | Unified User Agent [\[gdoc\]](https://docs.google.com/document/d/1B4QM9UO6kz2yjLrBqLjSgArUeM1DvzKnakC_e8KfrmY/edit?usp=sharing) | Michael N. | DRAFT |
| 62 | Eventing Management APIs [\[gdoc\]](https://docs.google.com/document/d/1VSqyRjFHJvlr9kYlwzeUpSDC8QkeflTm1epH7UzL0yw) | Michael N. | DRAFT |
| 63 | User Impersonation [\[gdoc\]](https://docs.google.com/document/d/18FTOTIHktHjrntMT2A4qApZco7i5FZwlTEqUcyaquqo/edit#) | Brett | DRAFT |
| 65 | CreateAsDeleted Support [\[doc\]](https://docs.google.com/document/d/1QccFEvHWEL2-ldS_aTfjphYJGB4YVmMKrMB-UyL2KFI/edit?usp=sharing) | Graham P. | DRAFT |
| 66 | Collection-Aware Query Support [\[doc\]](https://docs.google.com/document/d/1U1f7OMNua90NPx2S2-NK9LQYxsq2P0riR8lqNGFwKiA/edit#) | Michael R. | DRAFT |
| 67 | Extended SDK Observability (also known as "Tracing & Metrics") [\[doc\]](https://docs.google.com/document/d/1BAPS8bPMv8-4FPIdysgpxEsKrUgd595EAGOU-_nXHRY/edit?usp=sharing) | Michael N. | DRAFT |
| 68 | Collection-Aware FTS Support [\[doc\]](https://docs.google.com/document/d/1mWD4Qa56iIE9nnwQT83GutU8BcLQ8RS7iW90qEfiElU) | Michael R. | DRAFT |
| 69 | ReplaceBodyWithXattr Support [\[doc\]](https://docs.google.com/document/d/1pafGxfhhg4Nmw_huvjJoGuUBWA39kCCXpkMoIb1MtW0/edit?usp=sharing) | Graham P. | DRAFT |
| 71 | HTTP Client [\[doc\]](https://docs.google.com/document/d/161XtCxl2S-aT3_kEHKQBpm3q89NjwUJPtu902BewbME) | David N. | DRAFT |
| 72 | Queues And Topics [\[doc\]](https://docs.google.com/document/d/1x-wn--F1Qg6y342pBerLLfpWnAGud2HQRA0YpEVMkqU) | Michael N. | DRAFT |
| 73 | KV Range Scan [\[doc\]](https://docs.google.com/document/d/1ir4E9XRvVOncReuR_QgohyompgoIvnZ0De1ik0WkrYs) | David N. & Michael N. | DRAFT |
| 74 | Configuration Profiles [\[doc\]](https://docs.google.com/document/d/1LNCYgV2Eqymp3pGmA8WKPQOLSpcRyv0P7NpMYHVcUM0/) | Mike R. | DRAFT |
| 75 | [Faster Failover and Configuration Push](https://github.com/couchbaselabs/sdk-rfcs/pull/123) | Sergey | DRAFT |
| 77 | couchbase2 support [\[gdoc\]](https://docs.google.com/document/d/1BZe7m6cT5SqUO86W4si9gdNqBOGusYAOW0JLXoe47qU/edit) | Graham P. | DRAFT |
| 78 | [Zone-Aware Replica Reads](https://github.com/couchbaselabs/sdk-rfcs/pull/136) | Sergey | DRAFT |
| 79 | [Columnar API Foundation RFC](https://docs.google.com/document/d/1BzNX8B5XqcDxn8NAi8lVrxP257IdG5kaOsA3mwDMLyQ) | Charles | DRAFT |
| 80 | [Columnar API Connection Management](https://docs.google.com/document/d/11LRvVUGt3fEZt2K3CmxwtQQ0QHYW6hZO733cXPtxHVE) | David N | DRAFT |
| 81 | [Columnar API Streaming](https://docs.google.com/document/d/1Sx9rzJNEFMvEO0Tsho3jQum5TGyjJB2q-dIKrYl--o8) | Dimitris & Matt | DRAFT |
| 82 | [Columnar API Error Handling and Retries](https://docs.google.com/document/d/12WJ4i-B9CcNjIq5NnaFXbxZQfaaNm_tzemrmlRl5YcE) | David N | DRAFT |
| 83 | [API Versioning](https://docs.google.com/document/d/1GFp25bBHMg6kuFhaz0OEA0kQl_gY9ysNOeTK3M-K2Sc) | Jared | DRAFT |
### Identified RFCs
| RFC # | Description | Owner | Status |
|-------|-------------------------------------------------------------------------------------|---------|------------|
| 9 | 2i Query Support | SDK | IDENTIFIED |
| 15 | Collection Support | Brett | IDENTIFIED |
| 17 | Cross-Cluster Failover | Michael | IDENTIFIED |
| 18 | Timeouts for Configuration and Operations | Michael | IDENTIFIED |
| 21 | Generic find Queries [\[issue\]](https://github.com/couchbaselabs/sdk-rfcs/pull/54) | Brett | IDENTIFIED |
| 40 | Feeds | Brett | IDENTIFIED |
| 41 | Multi-Document Atomicity | Graham | IDENTIFIED |
| 42 | Config Publish Interleave | Charlie | IDENTIFIED |
| 44 | XDCR Durability | SDK | IDENTIFIED |
### Superseded and Deprecated RFCs
| RFC # | Description | Owner | Status |
|-------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------------|
| 2 | ~~[SubDocument API](rfc/0002-subdocapi.md)~~ | Mark | SUPERSEDED |
| 3 | ~~[Index Management](https://github.com/couchbaselabs/sdk-rfcs/blob/master/rfc/0003-indexmanagement.md)~~ | Simon | SUPERSEDED |
| 4 | ~~[RYW Consistent Queries – at_plus](rfc/0004-at_plus.md)~~ | Michael | SUPERSEDED |
| 7 | ~~[Cluster Level Authentication](rfc/0007-cluster_level_auth.md)~~ | Brett | SUPERSEDED |
| 8 | ~~[Datastructures](rfc/0008-datastructures.md)~~ | Mark | SUPERSEDED |
| 10 | ~~[Full Text Search (FTS) API](rfc/0010-cbft.md)~~ | Michael | SUPERSEDED |
| 12 | ~~Adapt memcached error code handling for future proofing~~ (see RFC 13) | SDK | SUPERSEDED |
| 14 | ~~LWW Wins XDCR Support~~ (see RFC 17) | SDK | SUPERSEDED |
| 16 | ~~[RBAC](rfc/0016-rbac.md)~~ | Mike G | SUPERSEDED |
| 19 | ~~[SDK 2.0 APIs](https://docs.google.com/document/d/1HgVEJetcIfeIqviKC9zdlv_7IEkWpstatzxeydkLF3A)~~ | Brett | SUPERSEDED |
| 22 | ~~[User Management API](rfc/0022-usermgmt.md)~~ | Subhashni | SUPERSEDED |
| 23 | ~~Subdoc `GET_COUNT` and `MKDOC`~~ (see RFC 25) | Mark | SUPERSEDED |
| 25 | ~~[Spock additions for Subdoc (including XATTRs)](rfc/0025-subdoc-xattr.md)~~ | Brett (Mark) | SUPERSEDED |
| 27 | ~~[Analytics Querying](rfc/0027-analytics.md)~~ | Michael (Brett) | SUPERSEDED |
| 28 | ~~[Enhanced Error Messages](rfc/0028-enhanced_error_messages.md)~~ | Brett L | SUPERSEDED |
| 31 | ~~Custom Transcoders [\[draft\]](https://docs.google.com/a/couchbase.com/document/d/1p3VzB41Tv-q0-j_HsqJAUrijAJEB9rGJ92Qgf36JdXc/edit)~~ | Mike G | SUPERSEDED |
| 33 | ~~Circuit Breakers [\[draft\]](https://docs.google.com/document/d/1QVXMN2u9RUuOAEPbeRvEA8h6drDJKR9Jy1C1Op17q3U/edit#)~~ | Michael N | SUPERSEDED |
| 34 | ~~[Health Check](rfc/0034-health-check.md)~~ | Sergey | SUPERSEDED |
| 35 | ~~[Response Time Observability](rfc/0035-rto.md)~~ | Mike G | SUPERSEDED |
| 36 | ~~[Client Certificate Authentication](rfc/0036-client-cert-auth.md)~~ | Michael | SUPERSEDED |
| 37 | ~~FTS Index Management [\[draft\]](https://docs.google.com/document/d/1C4yfTj5u6ahRgk3ZIL_AkwPMeu9-hHY_lZcsDNeIP74/edit?usp=sharing)~~ | Subhashni | SUPERSEDED |
| 43 | ~~Enhanced Durability Requirements~~ (see RFC 46) | Michael | SUPERSEDED |
| 60 | SDK3 Response Time Observability [\[gdoc\]](https://docs.google.com/document/d/11s2QCIBB-koFUm0ZzWI6aBy27hdRoDc0cRHsWvDT-xI/edit) (superseded by 67) | Mike G | SUPERSEDED |
## Background
We take the addition or extension of APIs seriously because we intend this work to have a lifecycle of years or decades. Toward that end, we had originally been writing a set of "one pagers" which had been influenced by experience in other software development organizations. While those were great and we're even porting some of them over to RFCs, we recognized that we'd caught some mistakes late and want to focus ourselves on identifying affecting all platforms as early as possible.
Thus, we defined a new SDK RFC process. We're not alone in this kind of endeavor. Note that [Joyent have created RFDs](https://github.com/joyent/rfd) (which came from some similar experience [@ingenthr](http://github.com/ingenthr) and [@trondn](http://github.com/trondn) had at Sun as well), and [Rust has Rust RFCs](https://github.com/rust-lang/rfcs) in addition to the well known [IETF RFCs](http://ietf.org/rfc.html).
Even though this says "SDKs", frequently the discussion here will expose issues not always considered at protocol and component design. Those issues may be discussed in the SDK RFC or the discussion may spawn off to [Couchbase's issue tracker](https://issues.couchbase.com)