readyset/readyset-features.json at main · readysettech/readyset · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
[
    {
        "feature_id": "1",
        "name": "Full Materialization",
        "command-line": "--feature-full-materialization",
        "environment-variable": "FEATURE_FULL_MATERIALIZATION",
        "description": "Allow the creation of fully materialized nodes.",
        "dialect": ["mysql", "postgresql"],
        "default": true,
        "display": false
    },
    {
        "feature_id": "2",
        "name": "Mixed Comparisons",
        "command-line": "--feature-mixed-comparisons",
        "environment-variable": "FEATURE_MIXED_COMPARISONS",
        "description": "Enable support for mixing equality and range comparisons on query parameters.",
        "dialect": ["mysql", "postgresql"],
        "default": false,
        "display": true
    },
    {
        "feature_id": "3",
        "name": "Pagination",
        "command-line": "--feature-pagination",
        "environment-variable": "FEATURE_PAGINATION",
        "description": "Enable support for Pagination in dataflow.\n\nNOTE: If enabled, this must be set for all Readyset processes (both servers and adapters).",
        "dialect": ["mysql", "postgresql"],
        "default": false,
        "display": true
    },
    {
        "feature_id": "4",
        "name": "Post-Lookup",
        "command-line": "--feature-post-lookup",
        "environment-variable": "FEATURE_POST_LOOKUP",
        "description": "Enable support for Post-Lookup (queries which do extra work after the lookup into the reader).\n\nIf the Top K feature is disabled, Post-Lookup can still provide support for some queries supported by Top K, albeit with lower performance.",
        "dialect": ["mysql", "postgresql"],
        "default": false,
        "display": true
    },
    {
        "feature_id": "5",
        "name": "Straddled Joins",
        "command-line": "--feature-straddled-joins",
        "environment-variable": "FEATURE_STRADDLED_JOINS",
        "description": "Enable support for straddled joins (joins with partial keys traced to both parents).",
        "dialect": ["mysql", "postgresql"],
        "default": false,
        "display": true
    },
    {
        "feature_id": "6",
        "name": "Top K",
        "command-line": "--feature-topk",
        "environment-variable": "FEATURE_TOPK",
        "description": "Enable support for Top K in dataflow.\n\nNOTE: If enabled, this must be set for all Readyset processes (both servers and adapters).",
        "dialect": ["mysql", "postgresql"],
        "default": false,
        "display": true
    },
    {
        "feature_id": "7",
        "name": "Placeholder Inlining",
        "command-line": "--feature-placeholder-inlining",
        "environment-variable": "FEATURE_PLACEHOLDER_INLINING",
        "description": "Whether to allow Readyset to automatically create inlined caches when we receive a CREATE CACHE command for a query with unsupported placeholders.\n\nIf set, we will create a cache with literals inlined in the unsupported placeholder positions every time the statement is executed with a new set of parameters.",
        "dialect": ["mysql", "postgresql"],
        "default": false,
        "display": true
    },
    {
        "feature_id": "8",
        "name": "Full Materialization Persistence",
        "command-line": "--feature-materialization-persistence",
        "environment-variable": "FEATURE_MATERIALIZATION_PERSISTENCE",
        "description": "Allows fully materialized nodes to be persisted to disk.",
        "dialect": ["mysql", "postgresql"],
        "default": false,
        "display": true
    },
    {
        "feature_id": "9",
        "name": "Disable automatic setup of DDL replication triggers (PostgreSQL)",
        "command-line": "--disable-setup-ddl-replication",
        "environment-variable": "DISABLE_SETUP_DDL_REPLICATION",
        "description": "For PostgreSQL deployments, do not automatically set up DDL replication triggers. Useful for situations where triggers need to be set up separately due to permissions.",
        "dialect": ["postgresql"],
        "default": false,
        "display": true
    },
    {
        "feature_id": "10",
        "name": "Disable automatic setup of replication publication (PostgreSQL)",
        "command-line": "--disable-create-publication",
        "environment-variable": "DISABLE_CREATE_PUBLICATION",
        "description": "For PostgreSQL deployments, do not automatically set up logical replication publication, i.e., CREATE PUBLICATION. Useful for situations where logical replication needs to be set up separately due to permissions.",
        "dialect": ["postgresql"],
        "default": false,
        "display": true
    }
]