|
| 1 | +- Feature Name: (fill in with a unique identifier, e.g. `my_feature`) |
| 2 | +- Start Date: (today's date, YYYY-MM-DD) |
| 3 | +- RFC PR: [vortex-data/rfcs#0000](https://github.com/vortex-data/rfcs/pull/0000) |
| 4 | +- Tracking Issue: [vortex-data/vortex#0000](https://github.com/vortex-data/vortex/issues/0000) |
| 5 | + |
| 6 | +## Summary |
| 7 | + |
| 8 | +One paragraph explanation of the proposed change. |
| 9 | + |
| 10 | +## Motivation |
| 11 | + |
| 12 | +What problem does this solve? Include concrete use cases where possible. |
| 13 | + |
| 14 | +- What specific use cases does this enable or improve? |
| 15 | +- What workflows or operations are painful, slow, or impossible today? |
| 16 | + |
| 17 | +## Design |
| 18 | + |
| 19 | +Describe the proposed design in enough detail that someone familiar with Vortex could implement it. This should cover: |
| 20 | + |
| 21 | +- New or modified APIs, traits, or vtable entries. |
| 22 | +- How this interacts with existing components (encodings, layouts, scan, file format, etc.). |
| 23 | +- Key implementation details and corner cases. |
| 24 | +- Why is this the best approach in the space of possible designs? |
| 25 | +- Which crates are affected and how the dependency graph changes, if at all. |
| 26 | + |
| 27 | +Use code examples and diagrams where they might help. |
| 28 | + |
| 29 | +## Compatibility |
| 30 | + |
| 31 | +- Does this change the file format or wire format? Is it backward/forward compatible? |
| 32 | +- Does this break any public APIs? If so, what is the migration path? |
| 33 | +- Are there performance implications? |
| 34 | + |
| 35 | +If there are no compatibility concerns, briefly state why. |
| 36 | + |
| 37 | +## Drawbacks |
| 38 | + |
| 39 | +- Why should we _not_ do this? |
| 40 | +- What is the maintenance cost of this change? |
| 41 | +- Does this add complexity that could be avoided? |
| 42 | + |
| 43 | +## Alternatives |
| 44 | + |
| 45 | +- What other designs were considered and why were they rejected? |
| 46 | +- What is the cost of **not** doing this? |
| 47 | +- Is there a simpler approach that gets us most of the way there? |
| 48 | + |
| 49 | +## Prior Art |
| 50 | + |
| 51 | +How have other systems solved this or similar problems? Consider: |
| 52 | + |
| 53 | +- Other columnar formats (Parquet, Arrow, Lance, Nimble, etc.). |
| 54 | +- Database internals (DuckDB, DataFusion, Velox, etc.). |
| 55 | +- Relevant academic papers or blog posts. |
| 56 | + |
| 57 | +This section helps frame the design in a broader context. If there is no relevant prior art, that is fine. |
| 58 | + |
| 59 | +## Unresolved Questions |
| 60 | + |
| 61 | +- What parts of the design need to be resolved during the RFC process? |
| 62 | +- What is explicitly out of scope for this RFC? |
| 63 | +- Are there open questions that can be deferred to implementation? |
| 64 | + |
| 65 | +## Future Possibilities |
| 66 | + |
| 67 | +What natural extensions or follow-on work does this enable? This is a good place to note related ideas that are out of scope for this RFC but worth capturing. |
0 commit comments