Skip to content

Rework settings handling and implement auto-generation for new ones #14383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 31 commits into from
Oct 16, 2024
Merged

Rework settings handling and implement auto-generation for new ones #14383

merged 31 commits into from
Oct 16, 2024

Conversation

Mytherin
Copy link
Collaborator

Follow-up from #14018, finalizing the implementation

This PR enables the generation of settings through a JSON file, avoiding having to touch many places in the code to add a single setting. Examples of such settings:

Simple
        "name": "allow_extensions_metadata_mismatch",
        "description": "Allow to load extensions with not compatible metadata",
        "type": "BOOLEAN",
        "scope": "global"
More bells and whistles
    {
        "name": "checkpoint_threshold",
        "description": "The WAL size threshold at which to automatically trigger a checkpoint (e.g. 1GB)",
        "type": "VARCHAR",
        "scope": "global",
        "internal_setting": "checkpoint_wal_size",
        "custom_implementation": [
            "set",
            "get"
        ],
        "aliases": [
            "wal_autocheckpoint"
        ]
    },
Setting Description
name Name of the setting
description Description of the setting
type SQL type of the setting (e.g. BIGINT)
return_type C++ return type of the setting - if not set this is derived from the SQL type (e.g. VARCHAR -> string)
scope Global (DBConfig) or Local (ClientConfig)
internal_setting C++ variable name of the setting - if not provided equal to name
on_callbacks Custom callbacks to generate (set/reset) - generates OnGlobalSet/OnLocalSet/OnGlobalReset/OnLocalReset callbacks that can be used to verify input data
custom_implementation Whether or not the setting code is automatically generated - can be either true/false, or a list providing which has a custom implementation (set/reset/get)
struct Struct name of the setting, defaults to setting name in CamelCase
aliases List of aliases to generate for the setting

Not all settings can be fully auto-generated, therefore they are split between custom_settings.cpp and autogenerated_settings.cpp. The custom_implementation flag controls whether or not code for the setting is automatically generated.

chrisiou and others added 30 commits August 9, 2024 10:52
@chrisiou
add script to auto generate settings
a7b1ffe
@chrisiou
update settings funcions' names and add verification functions
0978ebc
@chrisiou
revisit settings generation - declaration and scope configuration
c2cb1d1
@chrisiou
autogenerate settings body implementation
4d3f26c
@chrisiou
integrate the existing functionality of each setting with the new API
bec7f55
@chrisiou
Merge branch 'main' into generate-settings
d6f7354
@chrisiou
add new settings after merging
7294c94
@chrisiou
rename options variables as settings names
dbc0a90
@chrisiou
use locked settings accesor
4a59457
@chrisiou
Merge branch 'main' into generate-settings
34cd4f5
@chrisiou
make format
65f68e9
@chrisiou
rename settings variables to their initial names and change how set/r…
d547a56 
…eset verification is enabled
@chrisiou
add templated method to directly return setting's type, auto-unpackin…
4361678 
…g Value
@chrisiou
Merge branch 'feature' into generate-settings
ec8295f
@Mytherin
Merge branch 'generate-settings' of github.com:chrisiou/duckdb into c…
7a93930 
…hrisiou-generate-settings
@Mytherin
Rename custom_conversion_and_validation to custom_implementation
d96ae23
@Mytherin
Rename VerifyDBInstanceSET to OnGlobalSet, etc
1e786cc
@Mytherin
Rename verification to on_callbacks
c127f08
@Mytherin
Allow setting custom implementations of a subset of the setting funct…
40ca49c 
…ions
@Mytherin
Don't touch custom_settings.cpp
df8c854
@Mytherin
Get return type from the SQL type in settings generation
8d3d3ef
@Mytherin
Test fixes
f3d8386
@Mytherin
Add internal_setting flag, and add more settings to autogenerated set…
a0a3d43 
…tings
@Mytherin
Allow explicitly defining the struct name
8eabb43
@Mytherin
Format fix
b3fcfe7
@Mytherin
Some cleanup
e4c8896
@Mytherin
Add support for generating enum settings
56b20a7
@Mytherin
More enum settings generated
a979e73
@Mytherin
Remove type hint
65f76b4
@Mytherin
Avoid Value::CreateValue
6683af8
@Mytherin Mytherin merged commit a411527 into duckdb:feature Oct 16, 2024
36 checks passed
@Mytherin Mytherin mentioned this pull request Oct 16, 2024
Merged
@Mytherin Mytherin deleted the chrisiou-generate-settings branch December 8, 2024 06:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Mytherin @chrisiou