跳转到主要内容

<RFC Title>

Summary​

One paragraph explanation of the proposal.

Motivation​

Why are we doing this? What use cases does it support? What is the expected outcome?

Guide-level explanation​

Explain the proposal as if it was already included in the databend and you were teaching it to other databend users. That generally means:

  • Introducing new named concepts.
  • Explaining the feature mainly in terms of examples.
  • Explaining how databend users should think about the feature and how it should impact the way they use databend. It should explain the impact as concretely as possible.
  • If applicable, provide sample error messages, deprecation warnings, or migration guidance.
  • If applicable, describe the differences between teaching this to exist databend users and new databend users.

Reference-level explanation​

This is the technical portion of the RFC. Explain the design in sufficient detail that:

  • Its interaction with other features is clear.
  • It is reasonably clear how the feature would be implemented.
  • Corner cases are dissected by example.

The section should return to the examples given in the previous section and explain more fully how the detailed proposal makes those examples work.

Drawbacks​

Why should we not do this?

Rationale and alternatives​

  • Why is this design the best in the space of possible designs?
  • What other designs have been considered, and what is the rationale for not choosing them?
  • What is the impact of not doing this?

Prior art​

Discuss prior art, both the good and the bad, in relation to this proposal. A few examples of what this can include are:

  • What lessons can we learn from what other communities have done here?

This section is intended to encourage you as an author to think about the lessons from other communities provide readers of your RFC with a fuller picture. If there is no prior art, that is fine - your ideas are interesting to us, whether they are brand new or an adaptation from other projects.

Unresolved questions​

  • What parts of the design do you expect to resolve through the RFC process before this gets merged?
  • What related issues do you consider out of scope for this RFC that could be addressed in the future independently of the solution that comes out of this RFC?

Future possibilities​

Think about what the natural extension and evolution of your proposal would be and how it would affect the databend. Try to use this section as a tool to more fully consider all possible interactions with the project in your proposal.

Also, consider how this all fits into the roadmap for the project.

This is also a good place to "dump ideas", if they are out of scope for the RFC, you are writing but otherwise related.

If you have tried and cannot think of any future possibilities, you may state that you cannot think of anything.

Note that having something written down in the future-possibilities section is not a reason to accept the current or a future RFC; such notes should be in the section on motivation or rationale in this or subsequent RFCs. The section merely provides additional information.