linode.getDatabaseMysqlConfig

Provides information about a Linode MySQL Database’s Configuration Options. For more information, see the Linode APIv4 docs.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";

const my_db_config = linode.getDatabaseMysqlConfig({});

import pulumi
import pulumi_linode as linode

my_db_config = linode.get_database_mysql_config()

package main

import (
	"github.com/pulumi/pulumi-linode/sdk/v5/go/linode"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := linode.GetDatabaseMysqlConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;

return await Deployment.RunAsync(() => 
{
    var my_db_config = Linode.Index.GetDatabaseMysqlConfig.Invoke();

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.LinodeFunctions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var my-db-config = LinodeFunctions.getDatabaseMysqlConfig(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);

    }
}

variables:
  my-db-config:
    fn::invoke:
      function: linode:getDatabaseMysqlConfig
      arguments: {}

binlogRetentionPeriod

The following arguments are supported in the binlogRetentionPeriod specification block:

• description - The description of binlogRetentionPeriod.

• example - An example of a valid value for binlogRetentionPeriod.

• maximum - The maximum valid value of binlogRetentionPeriod.

• minimum - The minimum valid value of binlogRetentionPeriod.

• requiresRestart - Whether changing the value binlogRetentionPeriod requires the DB to restart.

• type - The type of the value of binlogRetentionPeriod.

mysql

The following arguments are supported in the mysql specification block:

• connectTimeout - The number of seconds that the mysqld server waits for a connect packet before responding with “Bad handshake”.

• defaultTimeZone - 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.

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

• informationSchemaStatsExpiry - The time, in seconds, before cached statistics expire.

• innodbChangeBufferMaxSize - Maximum size for the InnoDB change buffer, as a percentage of the total size of the buffer pool. Default is 25.

• innodbFlushNeighbors - Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent (default is 1): 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.

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

• innodbFtServerStopwordTable - This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables.

• innodbLockWaitTimeout - The length of time in seconds an InnoDB transaction waits for a row lock before giving up. Default is 120.

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

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

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

• innodbRollbackOnTimeout - 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.

• innodbThreadConcurrency - Defines the maximum number of threads permitted inside of InnoDB. Default is 0 (infinite concurrency - no limit).

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

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

• internalTmpMemStorageEngine - The storage engine for in-memory internal temporary tables.

• maxAllowedPacket - Size of the largest message in bytes that can be received by the server. Default is 67108864 (64M).

• maxHeapTableSize - Limits the size of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M).

• netBufferLength - Start sizes of connection buffer and result buffer. Default is 16384 (16K). Changing this parameter will lead to a restart of the MySQL service.

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

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

• sortBufferSize - Sort buffer size in bytes for ORDER BY optimization. Default is 262144 (256K).

• sqlMode - Global SQL mode. Set to empty to use MySQL server defaults. When creating a new service and not setting this field Aiven default SQL mode (strict, SQL standard compliant) will be assigned.

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

• tmpTableSize - Limits the size of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M).

• waitTimeout - The number of seconds the server waits for activity on a noninteractive connection before closing it.

connectTimeout

The following arguments are supported in the connectTimeout specification block:

• description - The description of connectTimeout.

• example - An example of a valid value for connectTimeout.

• maximum - The maximum valid value of connectTimeout.

• minimum - The minimum valid value of connectTimeout.

• requiresRestart - Whether changing the value connectTimeout requires the DB to restart.

• type - The type of the value of connectTimeout.

defaultTimeZone

The following arguments are supported in the defaultTimeZone specification block:

• description - The description of defaultTimeZone.

• example - An example of a valid value for defaultTimeZone.

• maxLength - The maximum length of the defaultTimeZone value.

• minLength - The minimum length of the defaultTimeZone value.

• pattern - A regular expression that the defaultTimeZone value must match.

• requiresRestart - Whether changing the value defaultTimeZone requires the DB to restart.

• type - The type of the value of defaultTimeZone.

groupConcatMaxLen

The following arguments are supported in the groupConcatMaxLen specification block:

• description - The description of groupConcatMaxLen.

• example - An example of a valid value for groupConcatMaxLen.

• maximum - The maximum valid value of groupConcatMaxLen.

• minimum - The minimum valid value of groupConcatMaxLen.

• requiresRestart - Whether changing the value groupConcatMaxLen requires the DB to restart.

• type - The type of the value of groupConcatMaxLen.

informationSchemaStatsExpiry

The following arguments are supported in the informationSchemaStatsExpiry specification block:

• description - The description of informationSchemaStatsExpiry.

• example - An example of a valid value for informationSchemaStatsExpiry.

• maximum - The maximum valid value of informationSchemaStatsExpiry.

• minimum - The minimum valid value of informationSchemaStatsExpiry.

• requiresRestart - Whether changing the value informationSchemaStatsExpiry requires the DB to restart.

• type - The type of the value of informationSchemaStatsExpiry.

innodbChangeBufferMaxSize

The following arguments are supported in the innodbChangeBufferMaxSize specification block:

• description - The description of innodbChangeBufferMaxSize.

• example - An example of a valid value for innodbChangeBufferMaxSize.

• maximum - The maximum valid value of innodbChangeBufferMaxSize.

• minimum - The minimum valid value of innodbChangeBufferMaxSize.

• requiresRestart - Whether changing the value innodbChangeBufferMaxSize requires the DB to restart.

• type - The type of the value of innodbChangeBufferMaxSize.

innodbFlushNeighbors

The following arguments are supported in the innodbFlushNeighbors specification block:

• description - The description of innodbFlushNeighbors.

• example - An example of a valid value for innodbFlushNeighbors.

• maximum - The maximum valid value of innodbFlushNeighbors.

• minimum - The minimum valid value of innodbFlushNeighbors.

• requiresRestart - Whether changing the value innodbFlushNeighbors requires the DB to restart.

• type - The type of the value of innodbFlushNeighbors.

innodbFtMinTokenSize

The following arguments are supported in the innodbFtMinTokenSize specification block:

• description - The description of innodbFtMinTokenSize.

• example - An example of a valid value for innodbFtMinTokenSize.

• maximum - The maximum valid value of innodbFtMinTokenSize.

• minimum - The minimum valid value of innodbFtMinTokenSize.

• requiresRestart - Whether changing the value innodbFtMinTokenSize requires the DB to restart.

• type - The type of the value of innodbFtMinTokenSize.

innodbFtServerStopwordTable

The following arguments are supported in the innodbFtServerStopwordTable specification block:

• description - The description of innodbFtServerStopwordTable.

• example - An example of a valid value for innodbFtServerStopwordTable.

• maxLength - The maximum length of the value for innodbFtServerStopwordTable.

• pattern - A regex pattern that a value of innodbFtServerStopwordTable must match.

• requiresRestart - Whether changing the value innodbFtServerStopwordTable requires the DB to restart.

• type - The type of the value of innodbFtServerStopwordTable.

innodbLockWaitTimeout

The following arguments are supported in the innodbLockWaitTimeout specification block:

• description - The description of innodbLockWaitTimeout.

• example - An example of a valid value for innodbLockWaitTimeout.

• maximum - The maximum valid value of innodbLockWaitTimeout.

• minimum - The minimum valid value of innodbLockWaitTimeout.

• requiresRestart - Whether changing the value innodbLockWaitTimeout requires the DB to restart.

• type - The type of the value of innodbLockWaitTimeout.

innodbLogBufferSize

The following arguments are supported in the innodbLogBufferSize specification block:

• description - The description of innodbLogBufferSize.

• example - An example of a valid value for innodbLogBufferSize.

• maximum - The maximum valid value of innodbLogBufferSize.

• minimum - The minimum valid value of innodbLogBufferSize.

• requiresRestart - Whether changing the value innodbLogBufferSize requires the DB to restart.

• type - The type of the value of innodbLogBufferSize.

innodbOnlineAlterLogMaxSize

The following arguments are supported in the innodbOnlineAlterLogMaxSize specification block:

• description - The description of innodbOnlineAlterLogMaxSize.

• example - An example of a valid value for innodbOnlineAlterLogMaxSize.

• maximum - The maximum valid value of innodbOnlineAlterLogMaxSize.

• minimum - The minimum valid value of innodbOnlineAlterLogMaxSize.

• requiresRestart - Whether changing the value innodbOnlineAlterLogMaxSize requires the DB to restart.

• type - The type of the value of innodbOnlineAlterLogMaxSize.

innodbReadIoThreads

The following arguments are supported in the innodbReadIoThreads specification block:

• description - The description of innodbReadIoThreads.

• example - An example of a valid value for innodbReadIoThreads.

• maximum - The maximum valid value of innodbReadIoThreads.

• minimum - The minimum valid value of innodbReadIoThreads.

• requiresRestart - Whether changing the value innodbReadIoThreads requires the DB to restart.

• type - The type of the value of innodbReadIoThreads.

innodbRollbackOnTimeout

The following arguments are supported in the innodbRollbackOnTimeout specification block:

• description - The description of innodbRollbackOnTimeout.

• example - An example of a valid value for innodbRollbackOnTimeout.

• requiresRestart - Whether changing the value innodbRollbackOnTimeout requires the DB to restart.

• type - The type of the value of innodbRollbackOnTimeout.

innodbThreadConcurrency

The following arguments are supported in the innodbThreadConcurrency specification block:

• description - The description of innodbThreadConcurrency.

• example - An example of a valid value for innodbThreadConcurrency.

• maximum - The maximum valid value of innodbThreadConcurrency.

• minimum - The minimum valid value of innodbThreadConcurrency.

• requiresRestart - Whether changing the value innodbThreadConcurrency requires the DB to restart.

• type - The type of the value of innodbThreadConcurrency.

innodbWriteIoThreads

The following arguments are supported in the innodbWriteIoThreads specification block:

• description - The description of innodbWriteIoThreads.

• example - An example of a valid value for innodbWriteIoThreads.

• maximum - The maximum valid value of innodbWriteIoThreads.

• minimum - The minimum valid value of innodbWriteIoThreads.

• requiresRestart - Whether changing the value innodbWriteIoThreads requires the DB to restart.

• type - The type of the value of innodbWriteIoThreads.

interactiveTimeout

The following arguments are supported in the interactiveTimeout specification block:

• description - The description of interactiveTimeout.

• example - An example of a valid value for interactiveTimeout.

• maximum - The maximum valid value of interactiveTimeout.

• minimum - The minimum valid value of interactiveTimeout.

• requiresRestart - Whether changing the value interactiveTimeout requires the DB to restart.

• type - The type of the value of interactiveTimeout.

internalTmpMemStorageEngine

The following arguments are supported in the internalTmpMemStorageEngine specification block:

• description - The description of internalTmpMemStorageEngine.

• enum - A list of valid enum values for internalTmpMemStorageEngine.

• example - An example of a valid value for internalTmpMemStorageEngine.

• requiresRestart - Whether changing the value internalTmpMemStorageEngine requires the DB to restart.

• type - The type of the value of internalTmpMemStorageEngine.

maxAllowedPacket

The following arguments are supported in the maxAllowedPacket specification block:

• description - The description of maxAllowedPacket.

• example - An example of a valid value for maxAllowedPacket.

• maximum - The maximum valid value of maxAllowedPacket.

• minimum - The minimum valid value of maxAllowedPacket.

• requiresRestart - Whether changing the value maxAllowedPacket requires the DB to restart.

• type - The type of the value of maxAllowedPacket.

maxHeapTableSize

The following arguments are supported in the maxHeapTableSize specification block:

• description - The description of maxHeapTableSize.

• example - An example of a valid value for maxHeapTableSize.

• maximum - The maximum valid value of maxHeapTableSize.

• minimum - The minimum valid value of maxHeapTableSize.

• requiresRestart - Whether changing the value maxHeapTableSize requires the DB to restart.

• type - The type of the value of maxHeapTableSize.

netBufferLength

The following arguments are supported in the netBufferLength specification block:

• description - The description of netBufferLength.

• example - An example of a valid value for netBufferLength.

• maximum - The maximum valid value of netBufferLength.

• minimum - The minimum valid value of netBufferLength.

• requiresRestart - Whether changing the value netBufferLength requires the DB to restart.

• type - The type of the value of netBufferLength.

netReadTimeout

The following arguments are supported in the netReadTimeout specification block:

• description - The description of netReadTimeout.

• example - An example of a valid value for netReadTimeout.

• maximum - The maximum valid value of netReadTimeout.

• minimum - The minimum valid value of netReadTimeout.

• requiresRestart - Whether changing the value netReadTimeout requires the DB to restart.

• type - The type of the value of netReadTimeout.

netWriteTimeout

The following arguments are supported in the netWriteTimeout specification block:

• description - The description of netWriteTimeout.

• example - An example of a valid value for netWriteTimeout.

• maximum - The maximum valid value of netWriteTimeout.

• minimum - The minimum valid value of netWriteTimeout.

• requiresRestart - Whether changing the value netWriteTimeout requires the DB to restart.

• type - The type of the value of netWriteTimeout.

sortBufferSize

The following arguments are supported in the sortBufferSize specification block:

• description - The description of sortBufferSize.

• example - An example of a valid value for sortBufferSize.

• maximum - The maximum valid value of sortBufferSize.

• minimum - The minimum valid value of sortBufferSize.

• requiresRestart - Whether changing the value sortBufferSize requires the DB to restart.

• type - The type of the value of sortBufferSize.

sqlMode

The following arguments are supported in the sqlMode specification block:

• description - The description of sqlMode.

• example - An example of a valid value for sqlMode.

• maxLength - The maximum valid length of sqlMode.

• pattern - The pattern to match for sqlMode.

• requiresRestart - Whether changing the value sqlMode requires the DB to restart.

• type - The type of the value of sqlMode.

sqlRequirePrimaryKey

The following arguments are supported in the sqlRequirePrimaryKey specification block:

• description - The description of sqlRequirePrimaryKey.

• example - An example of a valid value for sqlRequirePrimaryKey.

• requiresRestart - Whether changing the value sqlRequirePrimaryKey requires the DB to restart.

• type - The type of the value of sqlRequirePrimaryKey.

tmpTableSize

The following arguments are supported in the tmpTableSize specification block:

• description - The description of tmpTableSize.

• example - An example of a valid value for tmpTableSize.

• maximum - The maximum valid value of tmpTableSize.

• minimum - The minimum valid value of tmpTableSize.

• requiresRestart - Whether changing the value tmpTableSize requires the DB to restart.

• type - The type of the value of tmpTableSize.

waitTimeout

The following arguments are supported in the waitTimeout specification block:

• description - The description of waitTimeout.

• example - An example of a valid value for waitTimeout.

• maximum - The maximum valid value of waitTimeout.

• minimum - The minimum valid value of waitTimeout.

• requiresRestart - Whether changing the value waitTimeout requires the DB to restart.

• type - The type of the value of waitTimeout.

Using getDatabaseMysqlConfig

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDatabaseMysqlConfig(opts?: InvokeOptions): Promise<GetDatabaseMysqlConfigResult>
function getDatabaseMysqlConfigOutput(opts?: InvokeOptions): Output<GetDatabaseMysqlConfigResult>

def get_database_mysql_config(opts: Optional[InvokeOptions] = None) -> GetDatabaseMysqlConfigResult
def get_database_mysql_config_output(opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseMysqlConfigResult]

func GetDatabaseMysqlConfig(ctx *Context, opts ...InvokeOption) (*GetDatabaseMysqlConfigResult, error)
func GetDatabaseMysqlConfigOutput(ctx *Context, opts ...InvokeOption) GetDatabaseMysqlConfigResultOutput

public static class GetDatabaseMysqlConfig 
{
    public static Task<GetDatabaseMysqlConfigResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetDatabaseMysqlConfigResult> Invoke(InvokeOptions? opts = null)
}

public static CompletableFuture<GetDatabaseMysqlConfigResult> getDatabaseMysqlConfig(InvokeOptions options)
public static Output<GetDatabaseMysqlConfigResult> getDatabaseMysqlConfig(InvokeOptions options)

fn::invoke:
  function: linode:index/getDatabaseMysqlConfig:getDatabaseMysqlConfig
  arguments:
    # arguments dictionary

getDatabaseMysqlConfig Result

The following output properties are available:

Supporting Types

GetDatabaseMysqlConfigBinlogRetentionPeriod

GetDatabaseMysqlConfigMysql

GetDatabaseMysqlConfigMysqlConnectTimeout

GetDatabaseMysqlConfigMysqlDefaultTimeZone

GetDatabaseMysqlConfigMysqlGroupConcatMaxLen

GetDatabaseMysqlConfigMysqlInformationSchemaStatsExpiry

GetDatabaseMysqlConfigMysqlInnodbChangeBufferMaxSize

GetDatabaseMysqlConfigMysqlInnodbFlushNeighbors

GetDatabaseMysqlConfigMysqlInnodbFtMinTokenSize

GetDatabaseMysqlConfigMysqlInnodbFtServerStopwordTable

GetDatabaseMysqlConfigMysqlInnodbLockWaitTimeout

GetDatabaseMysqlConfigMysqlInnodbLogBufferSize

GetDatabaseMysqlConfigMysqlInnodbOnlineAlterLogMaxSize

GetDatabaseMysqlConfigMysqlInnodbReadIoThreads

GetDatabaseMysqlConfigMysqlInnodbRollbackOnTimeout

GetDatabaseMysqlConfigMysqlInnodbThreadConcurrency