Skip to main content

supported_database_flags

Creates, updates, deletes, gets or lists a supported_database_flags resource.

Overview

Namesupported_database_flags
TypeResource
Idgoogle.alloydb.supported_database_flags

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringThe name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
acceptsMultipleValuesbooleanWhether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
flagNamestringThe name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field.
integerRestrictionsobjectRestriction on INTEGER type value. (id: IntegerRestrictions)
recommendedIntegerValuestring (int64)The recommended value for an INTEGER flag.
recommendedStringValuestringThe recommended value for a STRING flag.
requiresDbRestartbooleanWhether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).
scopestringThe scope of the flag.
stringRestrictionsobjectRestriction on STRING type value. (id: StringRestrictions)
supportedDbVersionsarrayMajor database engine versions for which this flag is supported.
valueTypestring

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectprojectsId, locationsIdpageSize, pageToken, scopeLists SupportedDatabaseFlags for a given project and location.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
locationsIdstring
projectsIdstring
pageSizeinteger (int32)
pageTokenstring
scopestring

SELECT examples

Lists SupportedDatabaseFlags for a given project and location.

SELECT
name,
acceptsMultipleValues,
flagName,
integerRestrictions,
recommendedIntegerValue,
recommendedStringValue,
requiresDbRestart,
scope,
stringRestrictions,
supportedDbVersions,
valueType
FROM google.alloydb.supported_database_flags
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND scope = '{{ scope }}';