|
7 | 7 | # the Business Source License, use of this software will be governed
|
8 | 8 | # by the Apache License, Version 2.0.
|
9 | 9 |
|
10 |
| -name: "Internal - Proposed Optimization" |
| 10 | +name: "Internal: proposed optimization" |
11 | 11 | description: A proposal for a new query optimization. Contributor use only.
|
12 |
| -labels: ["A-optimization", "needs-discussion"] |
| 12 | +labels: ["A-optimization", "C-feature", "needs-discussion"] |
13 | 13 | body:
|
14 | 14 | - type: textarea
|
15 | 15 | attributes:
|
16 | 16 | label: Elevator pitch
|
17 |
| - description: Each question should be answered comprehensively but using as |
18 |
| - few sentences as possible. |
| 17 | + description: | |
| 18 | + Each question should be answered comprehensively but using as few sentences as possible. |
19 | 19 | value: |
|
20 |
| - 1. What does the transformation do? Give a representative SQL query. |
21 |
| - 2. Why should we add it? |
22 |
| - 3. When would it be good to have? |
23 |
| - 4. When would it be ineffectual? |
24 |
| - 5. When would be bad to have? |
25 |
| - 6. In the worst case, how would it degrade performance? |
| 20 | + ### What does the transformation do? |
| 21 | + <!-- Give a representative SQL query. --> |
| 22 | +
|
| 23 | + ### Why should we add it? |
| 24 | +
|
| 25 | + ### When would it be good to have? |
| 26 | +
|
| 27 | + ### When would it be ineffectual? |
| 28 | +
|
| 29 | + ### When would be bad to have? |
| 30 | +
|
| 31 | + ### In the worst case, how would it degrade performance? |
26 | 32 | validations:
|
27 | 33 | required: true
|
28 | 34 | - type: textarea
|
29 | 35 | attributes:
|
30 |
| - label: List real life instances where this transformation would help. |
| 36 | + label: Customer impact |
| 37 | + description: | |
| 38 | + List real life instances where this transformation would help. |
31 | 39 | - type: textarea
|
32 | 40 | attributes:
|
33 |
| - label: Cost Model |
| 41 | + label: Cost model |
34 | 42 | description: |
|
35 |
| - If both the implementation and cost model are simple, this section can |
36 |
| - be skipped if the implementation section is filled in. |
| 43 | + If both the implementation and cost model are simple, this section can be skipped if the implementation section is filled in. |
37 | 44 |
|
38 |
| - Each subsection is meant to be answered with formulae. Take into account |
39 |
| - memory, CPU, liveness, and skew. Approximations are ok if it is not |
40 |
| - possible to calculate exact numbers. |
| 45 | + Each subsection is meant to be answered with formulae. Take into account memory, CPU, liveness, and skew. Approximations are ok if it is not possible to calculate exact numbers. |
41 | 46 |
|
42 |
| - If the transformation is always good to have, you only have to fill out |
43 |
| - the first subsection. |
| 47 | + If the transformation is always good to have, you only have to fill out the first subsection. |
44 | 48 | value: |
|
45 |
| - 1. What is the benefit of the transformation? |
46 |
| - 2. What is the overhead? |
47 |
| - 3. When would the transformation be worthwhile? Intuitively, this should |
48 |
| - be when benefit > overhead, but sometimes a benefit with regards to X |
49 |
| - comes at a cost with regards to Y, and it would be worthwhile to discuss |
50 |
| - when it is worthwhile to sacrifice Y to gain a benefit in X. |
| 49 | + ### What is the benefit of the transformation? |
| 50 | +
|
| 51 | + ### What is the overhead? |
| 52 | +
|
| 53 | + ### When would the transformation be worthwhile? |
| 54 | + <!-- Intuitively, this should be when benefit > overhead, but sometimes a benefit with regards to X comes at a cost with regards to Y, and it would be worthwhile to discuss when it is worthwhile to sacrifice Y to gain a benefit in X. --> |
51 | 55 | - type: textarea
|
52 | 56 | attributes:
|
53 |
| - label: List any knobs that we may need to tune or expose to the user. |
| 57 | + label: User-facing changes |
| 58 | + description: | |
| 59 | + List any knobs that we may need to be tuned by or exposed to the user. |
54 | 60 | - type: textarea
|
55 | 61 | attributes:
|
56 | 62 | label: Proposed implementation
|
57 | 63 | value: |
|
58 |
| - 1. Describe the implementation. |
59 |
| - 2. Which queries will do better with the given implementation? |
60 |
| - 3. Which queries will do worse? |
61 |
| - 4. Break the implementation down into stages. |
| 64 | + ### Describe the implementation. |
| 65 | +
|
| 66 | + ### Which queries will do better with the given implementation? |
| 67 | +
|
| 68 | + ### Which queries will do worse? |
| 69 | +
|
| 70 | + ### Break the implementation down into stages. |
0 commit comments