Added support for DB Configurable Params features

ezilber-akamai · ezilber-akamai · commit 4b5f5a33e297 · 2025-04-10T13:51:28.000-04:00
diff --git a/linode_api4/groups/database.py b/linode_api4/groups/database.py
@@ -1,3 +1,9 @@
+from typing import Any, Dict, Union
+
+from linode_api4 import (
+    MySQLDatabaseConfigOptions,
+    PostgreSQLDatabaseConfigOptions,
+)
 from linode_api4.errors import UnexpectedResponseError
 from linode_api4.groups import Group
 from linode_api4.objects import (
@@ -63,6 +69,26 @@ def engines(self, *filters):
         """
         return self.client._get_and_filter(DatabaseEngine, *filters)
 
+    def mysql_config_options(self):
+        """
+        Returns a detailed list of all the configuration options for MySQL Databases.
+
+        API Documentation: TODO
+
+        :returns: The JSON configuration options for MySQL Databases.
+        """
+        return self.client.get("databases/mysql/config", model=self)
+
+    def postgresql_config_options(self):
+        """
+        Returns a detailed list of all the configuration options for PostgreSQL Databases.
+
+        API Documentation: TODO
+
+        :returns: The JSON configuration options for PostgreSQL Databases.
+        """
+        return self.client.get("databases/postgresql/config", model=self)
+
     def instances(self, *filters):
         """
         Returns a list of Managed Databases active on this account.
@@ -93,7 +119,15 @@ def mysql_instances(self, *filters):
         """
         return self.client._get_and_filter(MySQLDatabase, *filters)
 
-    def mysql_create(self, label, region, engine, ltype, **kwargs):
+    def mysql_create(
+        self,
+        label,
+        region,
+        engine,
+        ltype,
+        engine_config: Union[MySQLDatabaseConfigOptions, Dict[str, Any]] = None,
+        **kwargs,
+    ):
         """
         Creates an :any:`MySQLDatabase` on this account with
         the given label, region, engine, and node type.  For example::
@@ -123,13 +157,16 @@ def mysql_create(self, label, region, engine, ltype, **kwargs):
         :type engine: str or Engine
         :param ltype: The Linode Type to use for this cluster
         :type ltype: str or Type
+        :param engine_config: The configuration options for this MySQL cluster
+        :type engine_config: Dict[str, Any] or MySQLDatabaseConfigOptions
         """
 
         params = {
             "label": label,
             "region": region,
             "engine": engine,
             "type": ltype,
+            "engine_config": engine_config,
         }
         params.update(kwargs)
 
@@ -201,6 +238,54 @@ def mysql_fork(self, source, restore_time, **kwargs):
         d = MySQLDatabase(self.client, result["id"], result)
         return d
 
+    def mysql_update_config(
+        self,
+        engine_config: Union[MySQLDatabaseConfigOptions, Dict[str, Any]] = None,
+        **kwargs,
+    ):
+        """
+        Updates the config of :any:`MySQLDatabase` on this account with
+        the given engine_config.
+        For example::
+
+           client = LinodeClient(TOKEN)
+
+           db_to_update_config = client.database.mysql_instances()[0]
+
+           new_engine_config = MySQLDatabaseConfigOptions(
+                mysql=MySQLDatabaseConfigMySQLOptions(connect_timeout=20),
+                service_log=True
+            )
+
+           db_with_new_config = client.database.mysql_update_config(
+                new_engine_config
+           )
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/post-databases-mysql-instances
+
+        :param engine_config: The configuration options for this MySQL cluster
+        :type engine_config: Dict[str, Any] or MySQLDatabaseConfigOptions
+        """
+
+        params = {
+            "engine_config": engine_config,
+        }
+        params.update(kwargs)
+
+        result = self.client.post(
+            "/databases/mysql/instances",
+            data=_flatten_request_body_recursive(drop_null_keys(params)),
+        )
+
+        if "id" not in result:
+            raise UnexpectedResponseError(
+                "Unexpected response when updating MySQL Database config",
+                json=result,
+            )
+
+        d = MySQLDatabase(self.client, result["id"], result)
+        return d
+
     def postgresql_instances(self, *filters):
         """
         Returns a list of Managed PostgreSQL Databases active on this account.
@@ -216,7 +301,17 @@ def postgresql_instances(self, *filters):
         """
         return self.client._get_and_filter(PostgreSQLDatabase, *filters)
 
-    def postgresql_create(self, label, region, engine, ltype, **kwargs):
+    def postgresql_create(
+        self,
+        label,
+        region,
+        engine,
+        ltype,
+        engine_config: Union[
+            PostgreSQLDatabaseConfigOptions, Dict[str, Any]
+        ] = None,
+        **kwargs,
+    ):
         """
         Creates an :any:`PostgreSQLDatabase` on this account with
         the given label, region, engine, and node type.  For example::
@@ -246,13 +341,16 @@ def postgresql_create(self, label, region, engine, ltype, **kwargs):
         :type engine: str or Engine
         :param ltype: The Linode Type to use for this cluster
         :type ltype: str or Type
+        :param engine_config: The configuration options for this PostgreSQL cluster
+        :type engine_config: Dict[str, Any] or PostgreSQLDatabaseConfigOptions
         """
 
         params = {
             "label": label,
             "region": region,
             "engine": engine,
             "type": ltype,
+            "engine_config": engine_config,
         }
         params.update(kwargs)
 
@@ -325,3 +423,53 @@ def postgresql_fork(self, source, restore_time, **kwargs):
 
         d = PostgreSQLDatabase(self.client, result["id"], result)
         return d
+
+    def postgresql_update_config(
+        self,
+        engine_config: Union[
+            PostgreSQLDatabaseConfigOptions, Dict[str, Any]
+        ] = None,
+        **kwargs,
+    ):
+        """
+        Updates the config of :any:`PostgreSQLDatabase` on this account with
+        the given engine_config.
+        For example::
+
+           client = LinodeClient(TOKEN)
+
+           db_to_update_config = client.database.postgresql_instances()[0]
+
+           new_engine_config = PostgreSQLDatabaseConfigOptions(
+                pg=PostgreSQLDatabaseConfigPGOptions(log_temp_files=200),
+                service_log=True
+            )
+
+           db_with_new_config = client.database.postgresql_update_config(
+                new_engine_config
+           )
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/post-databases-postgresql-instances
+
+        :param engine_config: The configuration options for this PostgreSQL cluster
+        :type engine_config: Dict[str, Any] or PostgreSQLDatabaseConfigOptions
+        """
+
+        params = {
+            "engine_config": engine_config,
+        }
+        params.update(kwargs)
+
+        result = self.client.post(
+            "/databases/postgresql/instances",
+            data=_flatten_request_body_recursive(drop_null_keys(params)),
+        )
+
+        if "id" not in result:
+            raise UnexpectedResponseError(
+                "Unexpected response when updating PostgreSQL Database config",
+                json=result,
+            )
+
+        d = PostgreSQLDatabase(self.client, result["id"], result)
+        return d
diff --git a/linode_api4/objects/database.py b/linode_api4/objects/database.py
@@ -1,6 +1,15 @@
+from dataclasses import dataclass
+from typing import Optional
+
 from deprecated import deprecated
 
-from linode_api4.objects import Base, DerivedBase, MappedObject, Property
+from linode_api4.objects import (
+    Base,
+    DerivedBase,
+    JSONObject,
+    MappedObject,
+    Property,
+)
 
 
 class DatabaseType(Base):
@@ -128,6 +137,143 @@ class PostgreSQLDatabaseBackup(DatabaseBackup):
     api_endpoint = "/databases/postgresql/instances/{database_id}/backups/{id}"
 
 
+@dataclass
+class MySQLDatabaseConfigMySQLOptions(JSONObject):
+    """
+    MySQLDatabaseConfigMySQLOptions represents the fields in the mysql
+    field of the MySQLDatabaseConfigOptions class
+    """
+
+    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
+
+
+@dataclass
+class MySQLDatabaseConfigOptions(JSONObject):
+    """
+    MySQLDatabaseConfigOptions is used to specify
+    a MySQL Database Cluster's configuration options during its creation.
+    """
+
+    mysql: Optional[MySQLDatabaseConfigMySQLOptions] = None
+    binlog_retention_period: Optional[int] = None
+    service_log: Optional[bool] = None
+
+
+@dataclass
+class PostgreSQLDatabasePGLookoutConfigOptions(JSONObject):
+    """
+    PostgreSQLDatabasePGLookoutConfigOptions represents the fields in the pglookout
+    field of the PostgreSQLDatabasePGConfigOptions class
+    """
+
+    max_failover_replication_time_lag: Optional[int] = None
+
+
+@dataclass
+class PostgreSQLDatabasePGConfigOptions(JSONObject):
+    """
+    PostgreSQLDatabasePGConfigOptions represents the fields in the pg
+    field of the PostgreSQLDatabasePGConfigOptions class
+    """
+
+    autovacuum_analyze_scale_factor: Optional[float] = None
+    autovacuum_analyze_threshold: Optional[int] = None
+    autovacuum_freeze_max_age: Optional[int] = None
+    autovacuum_max_workers: Optional[int] = None
+    autovacuum_naptime: Optional[int] = None
+    autovacuum_vacuum_cost_delay: Optional[int] = None
+    autovacuum_vacuum_cost_limit: Optional[int] = None
+    autovacuum_vacuum_scale_factor: Optional[float] = None
+    autovacuum_vacuum_threshold: Optional[int] = None
+    bgwriter_delay: Optional[int] = None
+    bgwriter_flush_after: Optional[int] = None
+    bgwriter_lru_maxpages: Optional[int] = None
+    bgwriter_lru_multiplier: Optional[float] = None
+    deadlock_timeout: Optional[int] = None
+    default_toast_compression: Optional[str] = None
+    idle_in_transaction_session_timeout: Optional[int] = None
+    jit: Optional[bool] = None
+    log_autovacuum_min_duration: Optional[int] = None
+    log_error_verbosity: Optional[str] = None
+    log_line_prefix: Optional[str] = None
+    log_min_duration_statement: Optional[int] = None
+    log_temp_files: Optional[int] = None
+    max_files_per_process: Optional[int] = None
+    max_locks_per_transaction: Optional[int] = None
+    max_logical_replication_workers: Optional[int] = None
+    max_parallel_workers: Optional[int] = None
+    max_parallel_workers_per_gather: Optional[int] = None
+    max_pred_locks_per_transaction: Optional[int] = None
+    max_prepared_transactions: Optional[int] = None
+    max_replication_slots: Optional[int] = None
+    max_slot_wal_keep_size: Optional[int] = None
+    max_stack_depth: Optional[int] = None
+    max_standby_archive_delay: Optional[int] = None
+    max_standby_streaming_delay: Optional[int] = None
+    max_wal_senders: Optional[int] = None
+    max_worker_processes: Optional[int] = None
+    password_encryption: Optional[str] = None
+    pg_partman_bgw_interval: Optional[int] = None
+    pg_partman_bgw_role: Optional[str] = None
+    pg_stat_monitor_pgsm_enable_query_plan: Optional[bool] = None
+    pg_stat_monitor_pgsm_max_buckets: Optional[int] = None
+    pg_stat_statements_track: Optional[str] = None
+    temp_file_limit: Optional[int] = None
+    timezone: Optional[str] = None
+    track_activity_query_size: Optional[int] = None
+    track_commit_timestamp: Optional[str] = None
+    track_functions: Optional[str] = None
+    track_io_timing: Optional[str] = None
+    wal_sender_timeout: Optional[int] = None
+    wal_writer_delay: Optional[int] = None
+
+
+@dataclass
+class PostgreSQLDatabaseConfigOptions(JSONObject):
+    """
+    PostgreSQLDatabaseConfigOptions is used to specify
+    a PostgreSQL Database Cluster's configuration options during its creation.
+    """
+
+    pg: Optional[PostgreSQLDatabasePGConfigOptions] = None
+    pg_stat_monitor_enable: Optional[bool] = None
+    pglookout: Optional[PostgreSQLDatabasePGLookoutConfigOptions] = None
+    service_log: Optional[bool] = None
+    shared_buffers_percentage: Optional[float] = None
+    synchronous_replication: Optional[str] = None
+    work_mem: Optional[int] = None
+
+
 class MySQLDatabase(Base):
     """
     An accessible Managed MySQL Database.
@@ -158,6 +304,7 @@ class MySQLDatabase(Base):
         "updated": Property(volatile=True, is_datetime=True),
         "updates": Property(mutable=True),
         "version": Property(),
+        "engine_config": Property(mutable=True),
     }
 
     @property
@@ -321,6 +468,7 @@ class PostgreSQLDatabase(Base):
         "updated": Property(volatile=True, is_datetime=True),
         "updates": Property(mutable=True),
         "version": Property(),
+        "engine_config": Property(mutable=True),
     }
 
     @property
