Type Alias PutDatabasesMysqlInstanceResponses

Type Declaration

• allow_list: string[]

  Controls access to the Managed Database.

  • Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.

  • A standalone value of 0.0.0.0/0 allows all IP addresses access to the Managed Database.

  • An empty array ([]) blocks all public and private connections to the Managed Database.

• cluster_size: 1 | 2 | 3

  The number of Linode instance nodes deployed to the Managed Database.

  • Choose 3 nodes to create a high availability cluster that consists of one primary node and two replica nodes.

  • A 2 node cluster is only available with a dedicated plan. It consists of one primary node and one replica node.

• Readonlycreated: string

  Read-only When this Managed Database was created.

• Readonlyencrypted: boolean

  Read-only Whether the Managed Databases is encrypted. Currently required to be true.

• Readonlyengine: string

  Filterable, Read-only The Managed Database engine type.

• engine_config: {
      binlog_retention_period: number;
      mysql: {
          connect_timeout: number;
          default_time_zone: string;
          group_concat_max_len: number;
          information_schema_stats_expiry: number;
          innodb_change_buffer_max_size: number;
          innodb_flush_neighbors: number;
          innodb_ft_min_token_size: number;
          innodb_ft_server_stopword_table: string | null;
          innodb_lock_wait_timeout: number;
          innodb_log_buffer_size: number;
          innodb_online_alter_log_max_size: number;
          innodb_read_io_threads: number;
          innodb_rollback_on_timeout: boolean;
          innodb_thread_concurrency: number;
          innodb_write_io_threads: number;
          interactive_timeout: number;
          internal_tmp_mem_storage_engine: "TempTable" | "MEMORY";
          max_allowed_packet: number;
          max_heap_table_size: number;
          net_buffer_length: number;
          net_read_timeout: number;
          net_write_timeout: number;
          sql_mode: string;
          sql_require_primary_key: boolean;
          tmp_table_size: number;
          wait_timeout: number;
      };
  }

  Advanced parameters you can apply to a MySQL Managed Database, via our partner Aiven's specification. Only include the objects for parameters you want to set in your database. Omit objects for parameters you don't want to define or change.

  📘

  Aiven may offer additional parameters in their specification. Currently, only those listed here are supported for use in a MySQL Managed Database. You can also run the List MySQL Managed Database advanced parameters operation to see an up-to-date list.

  • binlog_retention_period: number

    The minimum amount of time in seconds to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default, for example if using the MySQL Debezium Kafka connector.

  • mysql: {
        connect_timeout: number;
        default_time_zone: string;
        group_concat_max_len: number;
        information_schema_stats_expiry: number;
        innodb_change_buffer_max_size: number;
        innodb_flush_neighbors: number;
        innodb_ft_min_token_size: number;
        innodb_ft_server_stopword_table: string | null;
        innodb_lock_wait_timeout: number;
        innodb_log_buffer_size: number;
        innodb_online_alter_log_max_size: number;
        innodb_read_io_threads: number;
        innodb_rollback_on_timeout: boolean;
        innodb_thread_concurrency: number;
        innodb_write_io_threads: number;
        interactive_timeout: number;
        internal_tmp_mem_storage_engine: "TempTable" | "MEMORY";
        max_allowed_packet: number;
        max_heap_table_size: number;
        net_buffer_length: number;
        net_read_timeout: number;
        net_write_timeout: number;
        sql_mode: string;
        sql_require_primary_key: boolean;
        tmp_table_size: number;
        wait_timeout: number;
    }

    MySQL-specific advanced configuration parameters.

    • connect_timeout: number

      The number of seconds that the mysqld server waits for a connect packet before responding with bad handshake.

    • default_time_zone: string

      Default server time zone as an offset from UTC (from -12:00 to +12:00), a time zone name, or SYSTEM to use the MySQL server default.

    • group_concat_max_len: number

      The maximum permitted result length in bytes for the GROUP_CONCAT() function.

    • information_schema_stats_expiry: number

      The time, in seconds, before cached statistics expire.

    • innodb_change_buffer_max_size: number

      Maximum size for the InnoDB change buffer, as a percentage of the total size of the buffer pool.

    • innodb_flush_neighbors: number

      Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent: 0 - dirty pages in the same extent are not flushed, 1 - flush contiguous dirty pages in the same extent, 2 - flush dirty pages in the same extent.

    • innodb_ft_min_token_size: number

      Minimum length of words that are stored in an InnoDB -1FULLTEXT index. Changing this parameter will lead to a restart of the MySQL service.

    • innodb_ft_server_stopword_table: string | null

      This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables. Set to null for no value.

    • innodb_lock_wait_timeout: number

      The length of time in seconds an InnoDB transaction waits for a row lock before giving up.

    • innodb_log_buffer_size: number

      The size in bytes of the buffer that InnoDB uses to write to the log files on disk.

    • innodb_online_alter_log_max_size: number

      The upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables.

    • innodb_read_io_threads: number

      The number of I/O threads for read operations in InnoDB. Changing this parameter will lead to a restart of the MySQL service.

    • innodb_rollback_on_timeout: boolean

      When enabled a transaction timeout causes InnoDB to abort and roll back the entire transaction. Changing this parameter will lead to a restart of the MySQL service.

    • innodb_thread_concurrency: number

      Defines the maximum number of threads permitted inside of InnoDB. The default is 0 which indicates infinite concurrency, or no limit.

    • innodb_write_io_threads: number

      The number of I/O threads for write operations in InnoDB. Changing this parameter will lead to a restart of the MySQL service.

    • interactive_timeout: number

      The number of seconds the server waits for activity on an interactive connection before closing it.

    • internal_tmp_mem_storage_engine: "TempTable" | "MEMORY"

      The storage engine for in-memory internal temporary tables.

    • max_allowed_packet: number

      Size of the largest message in bytes that can be received by the server.

    • max_heap_table_size: number

      Limits the size of internal in-memory tables. Also set tmp_table_size.

    • net_buffer_length: number

      Start sizes of connection buffer and result buffer. Changing this parameter will lead to a restart of the MySQL service.

    • net_read_timeout: number

      The number of seconds to wait for more data from a connection before aborting the read.

    • net_write_timeout: number

      The number of seconds to wait for a block to be written to a connection before aborting the write.

    • sql_mode: string

      Global SQL mode. Set to empty to use MySQL server defaults. When creating a new service and not setting this field, Akamai defaults to SQL mode which is strict, SQL standard compliant.

    • sql_require_primary_key: boolean

      Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. You should always have primary keys because various functionality may break if any large table is missing them.

    • tmp_table_size: number

      Limits the size of internal in-memory tables. This also requires a max_heap_table_size.

    • wait_timeout: number

      The number of seconds the server waits for activity on a non-interactive connection before closing it.

• fork: { restore_time: string; source: number }

  Details on the database that was the target of the fork. This only exists if the database was restored by creating a fork from another MySQL or PostgreSQL database.

  • restore_time: string

    The database timestamp from which it was restored. This is not when the fork was created.

  • source: number

    The instance id of the database that was forked from.

• Readonlyhosts: { primary: string | null; secondary: string | null }

  Read-only The primary hostname and secondary read-only hostname for the Managed Database. The API assigns these hostnames after it successfully creates the Managed Database.

  • primary: string | null

    The primary hostname for the Managed Database.

    📘

    • If you've configured the Managed Database to use a Virtual Private Cloud (VPC) via the private_network object (MySQL / PostgreSQL), this hostname resolves to a private IPv4 address within that VPC subnet's address range. Currently, IPv6 addresses aren't supported in a VPC.

    • With public_access enabled in a private_network, a public version of this hostname is also available. Resolving this hostname returns publicly routable IPv4 and IPv6 addresses.

  • secondary: string | null

    The secondary, read-only hostname for the Managed Database. This can only be used to access a Managed Database cluster from Linodes in the same data center (region). Accessing the cluster through this hostname doesn't incur transfer costs.

    📘

    • The secondary hostname is publicly visible and accessible.

    • If you've configured the Managed Database to use a VPC via the private_network object (MySQL / PostgreSQL), this hostname resolves to a private IPv4 address within that VPC subnet's address range. Currently, IPv6 addresses aren't supported in a VPC. You can also use this hostname for requests between clients within the same VPC to access the cluster over the private network, which avoids transfer costs.

    • With public_access enabled in a private_network, a public version of this hostname is also available. Resolving this hostname returns publicly routable IPv4 and IPv6 addresses.

• Readonlyid: number

  Read-only A unique ID that can be used to identify and reference the Managed Database.

• label: string

  Filterable A unique, user-defined string referring to the Managed Database. This string needs to be unique per Managed Database engine type.

• Readonlymembers: { [key: string]: unknown }

  Read-only A mapping between IP addresses and strings designating them as primary or failover.

• Readonlyoldest_restore_time: string

  Read-only The oldest time to which a database can be restored.

• platform: "rdbms-legacy" | "rdbms-default"

  Filterable, Read-only The back-end platform for relational databases used by the service.

• Readonlyport: number

  Read-only The access port for this Managed Database.

• private_network: { public_access: boolean; subnet_id: number; vpc_id: number } | null

  Beta Restricts access to a MySQL Managed Database using a Virtual Private Cloud (VPC). Displayed as null if no VPC is configured.

• region: string

  Filterable The unique identifier for the region where the Managed Database lives.

• ssl_connection: boolean

  Currently required to be true. Whether to require SSL credentials to establish a connection to the Managed Database. Run the Get managed MySQL database credentials operation for access information.

• status:
      | "provisioning"
      | "active"
      | "suspending"
      | "suspended"
      | "resuming"
      | "failed"
      | "degraded"
      | "updating"
      | "resizing"

  Filterable, Read-only The operating status of the Managed Database.

• Readonlytotal_disk_size_gb: number

  Read-only The total disk size of the database, in GB.

• type: string

  Filterable The Linode Instance type used by the Managed Database for its nodes.

• Readonlyupdated: string

  Read-only When this Managed Database was last updated.

• updates: {
      day_of_week: number;
      duration: number;
      frequency: "weekly";
      hour_of_day: number;
      pending: {
          deadline: string | null;
          description: string;
          planned_for: string | null;
      }[];
  }

  Configuration settings for automated patch update maintenance for the Managed Database.

  • day_of_week: number

    The numeric reference for the day of the week to perform maintenance. 1 is Monday, 2 is Tuesday, through to 7 which is Sunday.

  • duration: number

    The maximum maintenance window time in hours.

  • frequency: "weekly"

    How frequently maintenance occurs. Currently can only be weekly.

  • hour_of_day: number

    The hour to begin maintenance based in UTC time.

  • Readonlypending: { deadline: string | null; description: string; planned_for: string | null }[]

    Read-only An array of pending updates.

• Readonlyused_disk_size_gb: number

  Read-only The amount of space currently in use in the database, in GB.

• version: string

  Filterable The Managed Database engine version.