REST Resource: flags

Resource: Flag
- JSON representation
SqlFlagType
SqlFlagScope
Methods

Resource: Flag

A flag resource.

JSON representation

JSON representation
{ "name" : string , "type" : enum ( `SqlFlagType` ) , "appliesTo" : [ enum ( `SqlDatabaseVersion` ) ] , "allowedStringValues" : [ string ] , "minValue" : string , "maxValue" : string , "requiresRestart" : boolean , "kind" : string , "inBeta" : boolean , "allowedIntValues" : [ string ] , "flagScope" : enum ( `SqlFlagScope` ) , // Union field `recommended_value` can be only one of the following: "recommendedStringValue" : string , "recommendedIntValue" : string // End of list of possible types for union field `recommended_value` . }

 { 
 "name" 
 : 
 string 
 , 
 "type" 
 : 
 enum (  SqlFlagType 
 
) 
 , 
 "appliesTo" 
 : 
 [ 
 enum (  SqlDatabaseVersion 
 
) 
 ] 
 , 
 "allowedStringValues" 
 : 
 [ 
 string 
 ] 
 , 
 "minValue" 
 : 
 string 
 , 
 "maxValue" 
 : 
 string 
 , 
 "requiresRestart" 
 : 
 boolean 
 , 
 "kind" 
 : 
 string 
 , 
 "inBeta" 
 : 
 boolean 
 , 
 "allowedIntValues" 
 : 
 [ 
 string 
 ] 
 , 
 "flagScope" 
 : 
 enum (  SqlFlagScope 
 
) 
 , 
 // Union field recommended_value 
can be only one of the following: 
 "recommendedStringValue" 
 : 
 string 
 , 
 "recommendedIntValue" 
 : 
 string 
 // End of list of possible types for union field recommended_value 
. 
 }

Fields

name

string

This is the name of the flag. Flag names always use underscores, not hyphens, for example: max_allowed_packet

type

enum ( SqlFlagType )

The type of the flag. Flags are typed to being BOOLEAN , STRING , INTEGER or NONE . NONE is used for flags which do not take a value, such as skip_grant_tables .

appliesTo[]

enum ( SqlDatabaseVersion )

The database version this flag applies to. Can be MySQL instances: MYSQL_8_0 , MYSQL_8_0_18 , MYSQL_8_0_26 , MYSQL_5_7 , or MYSQL_5_6 . PostgreSQL instances: POSTGRES_9_6 , POSTGRES_10 , POSTGRES_11 or POSTGRES_12 . SQL Server instances: SQLSERVER_2017_STANDARD , SQLSERVER_2017_ENTERPRISE , SQLSERVER_2017_EXPRESS , SQLSERVER_2017_WEB , SQLSERVER_2019_STANDARD , SQLSERVER_2019_ENTERPRISE , SQLSERVER_2019_EXPRESS , or SQLSERVER_2019_WEB . See the complete list .

allowedStringValues[]

string

For STRING flags, a list of strings that the value can be set to.

minValue

string ( Int64Value format)

For INTEGER flags, the minimum allowed value.

maxValue

string ( Int64Value format)

For INTEGER flags, the maximum allowed value.

requiresRestart

boolean

Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.

kind

string

This is always sql#flag .

inBeta

boolean

Whether or not the flag is considered in beta.

allowedIntValues[]

string ( int64 format)

Use this field if only certain integers are accepted. Can be combined with minValue and maxValue to add additional values.

flagScope

enum ( SqlFlagScope )

Scope of flag.

Union field recommended_value . Recommended flag value for UI display. recommended_value can be only one of the following:

recommendedStringValue

string

Recommended flag value in string format for UI display.

recommendedIntValue

string ( Int64Value format)

Recommended flag value in integer format for UI display.

SqlFlagType

Enums
`SQL_FLAG_TYPE_UNSPECIFIED`	This is an unknown flag type.
`BOOLEAN`	Boolean type flag.
`STRING`	String type flag.
`INTEGER`	Integer type flag.
`NONE`	Flag type used for a server startup option.
`MYSQL_TIMEZONE_OFFSET`	Type introduced specially for MySQL TimeZone offset. Accept a string value with the format [-12:59, 13:00].
`FLOAT`	Float type flag.
`REPEATED_STRING`	Comma-separated list of the strings in a SqlFlagType enum.

SqlFlagScope

Scopes of a flag describe where the flag is used.

Enums
`SQL_FLAG_SCOPE_UNSPECIFIED`	Assume database flags if unspecified
`SQL_FLAG_SCOPE_DATABASE`	database flags
`SQL_FLAG_SCOPE_CONNECTION_POOL`	connection pool configuration flags

Methods
`list`	Lists all available database flags for Cloud SQL instances.

REST Resource: flags

Resource: Flag

SqlFlagType

SqlFlagScope

Methods

list

`list`