Added support for DB Configurable Params #527
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ezilber-akamai
force-pushed
the
TPT-3560-configurable-db-params
branch
from
a33527f to
4b5f5a3
Compare
ezilber-akamai
requested review from
lgarber-akamai and
ykim-akamai
and removed request for
a team
linode_api4/objects/database.py
Outdated
Comment on lines
147
to
177
| connect_timeout: Optional[int] = None | ||
| default_time_zone: Optional[str] = None | ||
| group_concat_max_len: Optional[float] = None | ||
| information_schema_stats_expiry: Optional[int] = None | ||
| innodb_change_buffer_max_size: Optional[int] = None | ||
| innodb_flush_neighbors: Optional[int] = None | ||
| innodb_ft_min_token_size: Optional[int] = None | ||
| innodb_ft_server_stopword_table: Optional[str] = None | ||
| innodb_lock_wait_timeout: Optional[int] = None | ||
| innodb_log_buffer_size: Optional[int] = None | ||
| innodb_online_alter_log_max_size: Optional[int] = None | ||
| innodb_print_all_deadlocks: Optional[bool] = None | ||
| innodb_read_io_threads: Optional[int] = None | ||
| innodb_rollback_on_timeout: Optional[bool] = None | ||
| innodb_thread_concurrency: Optional[int] = None | ||
| innodb_write_io_threads: Optional[int] = None | ||
| interactive_timeout: Optional[int] = None | ||
| internal_tmp_mem_storage_engine: Optional[str] = None | ||
| log_output: Optional[str] = None | ||
| long_query_time: Optional[float] = None | ||
| max_allowed_packet: Optional[int] = None | ||
| max_heap_table_size: Optional[int] = None | ||
| net_buffer_length: Optional[int] = None | ||
| net_read_timeout: Optional[int] = None | ||
| net_write_timeout: Optional[int] = None | ||
| slow_query_log: Optional[bool] = None | ||
| sort_buffer_size: Optional[int] = None | ||
| sql_mode: Optional[str] = None | ||
| sql_require_primary_key: Optional[bool] = None | ||
| tmp_table_size: Optional[int] = None | ||
| wait_timeout: Optional[int] = None |
There was a problem hiding this comment.
Do these fields correspond to the fields returned by DatabaseGroup(...).mysql_config_options()?
I think having explicit fields is still the right call if so, but we also need to make sure (unit test?) users can access any fields added to that endpoint in the future. Typically I would think this is something we just update as we go, but there being a dedicated endpoint to return fields make me think these changes could happen outside of an API release.
There was a problem hiding this comment.
As far as I know, yes, it is the same fields returned by mysql_config_options(). That endpoint returns additional information about the fields too (min, max, description, example, etc.). I would hope that new fields wouldn't be added outside of an API release but if you think that is a possibility, then I may have to rethink my design.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
ykim-akamai
approved these changes
Apr 29, 2025
lgarber-akamai
approved these changes
May 6, 2025
ezilber-akamai
merged commit 14ab831
into
linode:proj/configurable-db-params
12 checks passed
ezilber-akamai
added a commit
that referenced
this pull request
May 21, 2025
* Added support for DB Configurable Params (#527) * Added support for DB Configurable Params features * Added unit tests for config endpoints * Added more unit tests and removed config_update methods * Removed stale fields and updated unit tests * Add integration tests * Add integration tests * remove unused var * remove comments and update test case * update test case * remove assertion * Added support for custom JSON field names in dataclasses * Minor integration test fixes * add get and list test cases --------- Co-authored-by: Youjung Kim <ykim@akamai.com> * Add / prefix to URL in mysql_config_options and postgresql_config_options API calls (#542) * add test coverage for nullable fields (#541) --------- Co-authored-by: Youjung Kim <ykim@akamai.com> Co-authored-by: Lena Garber <114949949+lgarber-akamai@users.noreply.github.com> Co-authored-by: Youjung Kim <126618609+ykim-akamai@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
Implemented support for Configurable DB Params and added unit tests using mocks to test the new features.
Also, added support for custom JSON field names in dataclass fields.
✔️ How to Test
The following steps assume you have pulled down this PR locally.
Unit Tests
make test-unitIntegration Tests
make test-int TEST_SUITE=database/test_database_engine_config.py RUN_DB_TESTS=true