openapi: 3.2.0 info: description: The API for the MySQL Database Service license: name: Oracle Corporation title: MySQL Database Service Mysqlaas API version: '20190415' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/c21bc5da8ceddf436da4e56b2328b97fa65fa6675d07108e7a0447de3e832a0a.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the MySQL Database Service API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/c21bc5da8ceddf436da4e56b2328b97fa65fa6675d07108e7a0447de3e832a0a.yaml what: the harvested document for MySQL Database Service API servers: - url: http://mysql.{region}.ocp.oraclecloud.com/20190415 tags: - name: mysqlaas paths: /configurations: get: description: "Lists the Configurations available when creating a DB System.\n\nThis may include DEFAULT configurations per Shape and CUSTOM configurations.\n\nThe default sort order is a multi-part sort by:\n - shapeName, ascending\n - DEFAULT-before-CUSTOM\n - displayName ascending\n" operationId: ListConfigurations parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByConfigurationIdQueryParam' - $ref: '#/components/parameters/FilterByConfigurationLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByConfigurationTypeQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByShapeNameQueryParam' - $ref: '#/components/parameters/SortByConfigurationFieldQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The Configurations available. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ConfigurationSummary' type: array 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: List Configurations. tags: - mysqlaas x-obmcs-client-retries-enabled: true post: description: Creates a new Configuration. operationId: CreateConfiguration parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' responses: 201: description: The successfully created Configuration. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: The URI for the entity being described in the response body. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Configuration' 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 409: $ref: '#/components/responses/409-Conflict' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: Create Configuration. tags: - mysqlaas requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConfigurationDetails' description: Request to create a Configuration. required: true /configurations/{configurationId}: delete: description: 'Deletes a Configuration. The Configuration must not be in use by any DB Systems. ' operationId: DeleteConfiguration parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ConfigurationIdPathParam' responses: 204: description: The request to delete the resource was successful. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 409: $ref: '#/components/responses/409-Conflict' 412: $ref: '#/components/responses/412-PreconditionFailed' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: Delete Configuration. tags: - mysqlaas x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Configuration' get: description: 'Get the full details of the specified Configuration, including the list of MySQL Variables and their values. ' operationId: GetConfiguration parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/ConfigurationIdPathParam' responses: 200: description: 'The Configuration details, including type, shape association, and list of MySQL Variables. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Configuration' 304: $ref: '#/components/responses/304-NotModified' 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: Get Configuration. tags: - mysqlaas x-obmcs-client-retries-enabled: true put: description: Updates the Configuration details. operationId: UpdateConfiguration parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ConfigurationIdPathParam' responses: 200: description: The successfully updated Configuration. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Configuration' 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 409: $ref: '#/components/responses/409-Conflict' 412: $ref: '#/components/responses/412-PreconditionFailed' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: Update Configuration. tags: - mysqlaas x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateConfigurationDetails' description: Request to update a Configuration. required: true /shapes: get: description: 'Gets a list of the shapes you can use to create a new MySQL DB System. The shape determines the resources allocated to the DB System: CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. ' operationId: ListShapes parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/FilterByServiceFeatureSupportedQueryParam' - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryOptionalParam' - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' responses: 200: description: Supported MySQL Database Service shapes. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ShapeSummary' type: array 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: List MySQL Database Service Shapes. tags: - mysqlaas x-obmcs-client-retries-enabled: true /versions: get: description: 'Get a list of supported and available MySQL database major versions. The list is sorted by version family. ' operationId: ListVersions parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam' responses: 200: description: Supported MySQL database versions. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VersionSummary' type: array 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: List MySQL versions available for DB Systems. tags: - mysqlaas x-obmcs-client-retries-enabled: true components: parameters: ConfigurationIdPathParam: description: The OCID of the Configuration. in: path name: configurationId required: true schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: 'The value of the `opc-next-page` or `opc-prev-page` response header from the previous list call. For information about pagination, see [List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination). ' in: query name: page schema: type: string maxLength: 4096 minLength: 1 FilterByServiceFeatureSupportedQueryParam: description: 'Return shapes that are supported by the service feature. ' in: query name: isSupportedFor required: false style: form explode: true schema: type: array items: enum: - DBSYSTEM - HEATWAVECLUSTER type: string default: - DBSYSTEM uniqueItems: true FilterByAvailabilityDomainQueryOptionalParam: description: The name of the Availability Domain. in: query name: availabilityDomain required: false schema: type: string IfNoneMatchHeader: description: 'For conditional requests. In the GET call for a resource, set the `If-None-Match` header to the value of the ETag from a previous GET (or POST or PUT) response for that resource. The server will return with either a 304 Not Modified response if the resource has not changed, or a 200 OK response with the updated representation. ' in: header name: if-none-match x-default-description: No conditional request is made. schema: type: string OpcRetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). ' in: header name: opc-retry-token schema: type: string maxLength: 64 minLength: 1 FilterByConfigurationLifecycleStateQueryParam: description: Configuration Lifecycle State in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Configuration/lifecycleState' schema: type: string default: AVAILABLE FilterByConfigurationTypeQueryParam: description: The requested Configuration types. in: query name: type required: false schema: type: array items: enum: - DEFAULT - CUSTOM type: string default: '[DEFAULT]' uniqueItems: true IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `If-Match` header to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string FilterByCompartmentIdQueryParam: description: The compartment [OCID](/Content/General/Concepts/identifiers.htm). in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 FilterByDisplayNameQueryParam: description: A filter to return only the resource matching the given display name exactly. in: query name: displayName required: false schema: type: string maxLength: 255 PaginationLimitQueryParam: description: 'The maximum number of items to return in a paginated list call. For information about pagination, see [List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination). ' in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 FilterByNameQueryParam: description: Name in: query name: name required: false schema: type: string maxLength: 255 FilterByShapeNameQueryParam: description: The requested Shape name. in: query name: shapeName required: false schema: type: string maxLength: 255 minLength: 1 SortOrderQueryParam: description: The sort order to use (ASC or DESC). in: query name: sortOrder schema: type: string enum: - ASC - DESC default: ASC SortByConfigurationFieldQueryParam: description: 'The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending. ' in: query name: sortBy required: false schema: type: string enum: - displayName - shapeName - timeCreated - timeUpdated default: timeCreated FilterByConfigurationIdQueryParam: description: The requested Configuration instance. in: query name: configurationId required: false schema: type: string maxLength: 255 minLength: 1 OpcRequestIdHeader: description: 'Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. ' in: header name: opc-request-id required: false schema: type: string schemas: Configuration: description: 'The set of MySQL variables to be used when deploying a MySQL Database Service DB System. ' properties: compartmentId: description: OCID of the Compartment the Configuration exists in. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: User-provided data about the Configuration. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the Configuration. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the Configuration. maxLength: 255 minLength: 1 type: string initVariables: $ref: '#/components/schemas/InitializationVariables' lifecycleState: description: The current state of the Configuration. enum: - ACTIVE - DELETED type: string options: description: The MySQL options defined in the Configuration. items: $ref: '#/components/schemas/Option' maxItems: 1024 type: array parentConfigurationId: description: 'The OCID of the Configuration from which this Configuration is "derived". This is entirely a metadata relationship. There is no relation between the values in this Configuration and its parent. ' maxLength: 255 minLength: 1 type: string shapeName: description: The name of the associated Shape. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the Configuration was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeUpdated: description: The date and time the Configuration was last updated, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string type: description: The Configuration type, DEFAULT or CUSTOM. enum: - DEFAULT - CUSTOM type: string variables: $ref: '#/components/schemas/ConfigurationVariables' required: - id - compartmentId - shapeName - type - timeCreated - timeUpdated - lifecycleState - variables - options UpdateConfigurationDetails: description: 'The details required to update a Configuration. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: User-provided data about the Configuration. maxLength: 400 minLength: 1 type: string displayName: description: A new display name for the Configuration. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object CreateConfigurationDetails: description: 'The details required to create a new Configuration. ' properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: User-provided data about the Configuration. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the Configuration. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object initVariables: $ref: '#/components/schemas/InitializationVariables' options: description: The MySQL options defined in the Configuration. items: $ref: '#/components/schemas/Option' maxItems: 1024 type: array parentConfigurationId: description: 'The OCID of the Configuration from which the new Configuration is derived. The values in CreateConfigurationDetails.variables supersede the variables of the parent Configuration. ' maxLength: 255 minLength: 1 type: string shapeName: description: The name of the associated Shape. maxLength: 255 minLength: 1 type: string variables: $ref: '#/components/schemas/ConfigurationVariables' required: - compartmentId - shapeName Error: description: Sorry. properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error string. type: string required: - code - message InitializationVariables: description: 'DEPRECATED -- please use the `options` field instead. User-defined service variables set only at DB system initialization. These variables cannot be changed later at runtime. ' properties: lowerCaseTableNames: default: CASE_SENSITIVE description: "Represents the MySQL server system variable lower_case_table_names (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_lower_case_table_names).\nlowerCaseTableNames controls case-sensitivity of tables and schema names and how they are stored in the DB System.\nValid values are:\n - CASE_SENSITIVE - (default) Table and schema name comparisons are case-sensitive and stored as specified. (lower_case_table_names=0)\n - CASE_INSENSITIVE_LOWERCASE - Table and schema name comparisons are not case-sensitive and stored in lowercase. (lower_case_table_names=1)\n" enum: - CASE_SENSITIVE - CASE_INSENSITIVE_LOWERCASE type: string VersionSummary: description: 'A summary of the supported MySQL Versions families, and a list of their supported minor versions. ' properties: versionFamily: description: A descriptive summary of a group of versions. maxLength: 255 minLength: 1 type: string versions: description: The list of supported MySQL Versions. items: $ref: '#/components/schemas/Version' type: array required: - versions ConfigurationVariables: description: 'DEPRECATED -- please use the `options` field instead. User-defined service variables. ' properties: autoIncrementIncrement: description: 'auto_increment_increment and auto_increment_offset are intended for use with circular (source-to-source) replication, and can be used to control the operation of AUTO_INCREMENT columns. Both variables have global and session values, and each can assume an integer value between 1 and 65,535 inclusive. autoIncrementIncrement corresponds to the MySQL Replication Source Options variable [auto_increment_increment] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-source.html#sysvar_auto_increment_increment). ' maximum: 65535 minimum: 1 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true autoIncrementOffset: description: 'This variable has a default value of 1. If it is left with its default value, and Group Replication is started on the server in multi-primary mode, it is changed to the server ID. autoIncrementOffset corresponds to the MySQL Replication Source Options variable [auto_increment_offset] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-source.html#sysvar_auto_increment_offset). ' maximum: 65535 minimum: 1 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true autocommit: default: true description: ("autocommit") type: boolean bigTables: default: false description: 'If enabled, the server stores all temporary tables on disk rather than in memory. bigTables corresponds to the MySQL server variable [big_tables](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_big_tables). ' type: boolean x-obmcs-mysql-isDynamic: true binlogExpireLogsSeconds: default: 2592000 description: 'Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable [binlog_expire_logs_seconds](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_expire_logs_seconds). ' minimum: 0 type: integer x-obmcs-mysql-isDynamic: true binlogGroupCommitSyncDelay: description: 'Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk. There is no delay by default. Setting this variable to a microsecond delay enables more transactions to be synchronized together to disk at once, reducing the overall time to commit a group of transactions because the larger groups required fewer time units per group. binlogGroupCommitSyncDelay corresponds to the MySQL Replication system variable [binlog_group_commit_sync_delay](https://dev.mysql.com/doc/refman/5.7/en/replication-options-binary-log.html#sysvar_binlog_group_commit_sync_delay) ' maximum: 1000000 minimum: 0 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: microseconds binlogGroupCommitSyncNoDelayCount: description: 'The maximum number of transactions to wait for before aborting the current delay as specified by binlog_group_commit_sync_delay. If binlog_group_commit_sync_delay is set to 0, then this option has no effect. binlogGroupCommitSyncNoDelayCount corresponds to the MySQL Replication system variable [binlog_group_commit_sync_no_delay_count](https://dev.mysql.com/doc/refman/5.7/en/replication-options-binary-log.html#sysvar_binlog_group_commit_sync_no_delay_count) ' maximum: 100000 minimum: 0 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true binlogRowMetadata: default: MINIMAL description: 'Configures the amount of table metadata added to the binary log when using row-based logging. binlogRowMetadata corresponds to the MySQL binary logging system variable [binlog_row_metadata](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_row_metadata). ' enum: - FULL - MINIMAL type: string x-obmcs-mysql-isDynamic: true binlogRowValueOptions: default: PARTIAL_JSON description: 'When set to PARTIAL_JSON, this enables use of a space-efficient binary log format for updates that modify only a small portion of a JSON document. binlogRowValueOptions corresponds to the MySQL binary logging system variable [binlog_row_value_options](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_row_value_options). ' type: string x-obmcs-mysql-isDynamic: true x-obmcs-mysql-type: Set x-obmcs-mysql-validValues: - PARTIAL_JSON binlogTransactionCompression: default: true description: 'Enables compression for transactions that are written to binary log files on this server. binlogTransactionCompression corresponds to the MySQL binary logging system variable [binlog_transaction_compression](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_transaction_compression). ' type: boolean blockEncryptionMode: description: "This variable controls the block encryption mode for block-based algorithms such as AES. It affects encryption for AES_ENCRYPT() and AES_DECRYPT().\n \nblock_encryption_mode takes a value in aes-keylen-mode format, where keylen is the key length in bits and mode is the encryption mode. The value is not case-sensitive.\nPermitted keylen values are 128, 192, and 256. Permitted mode values are ECB, CBC, CFB1, CFB8, CFB128, and OFB.\n\nblock_encryption_mode corresponds to the MySQL Server Administration system variable\n[block_encryption_mode](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_block_encryption_mode)\n" type: string x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true characterSetServer: description: 'The server''s default character set. If you set this variable, you should also set collation_server to specify the collation for the character set. characterSetServer corresponds to the MySQL server variable [character_set_server](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_character_set_server). ' enum: - ARMSCII8 - ASCII - BIG5 - BINARY - CP1250 - CP1251 - CP1256 - CP1257 - CP850 - CP852 - CP866 - CP932 - DEC8 - EUCJPMS - EUCKR - GB18030 - GB2312 - GBK - GEOSTD8 - GREEK - HEBREW - HP8 - KEYBCS2 - KOI8R - KOI8U - LATIN1 - LATIN2 - LATIN5 - LATIN7 - MACCE - MACROMAN - SJIS - SWE7 - TIS620 - UCS2 - UJIS - UTF16 - UTF16LE - UTF32 - UTF8MB3 - UTF8MB4 type: string x-default-description: 'If not specified, the MySQL server internally assumes the default character set for its current version. ' x-obmcs-mysql-isDynamic: true collationServer: description: 'The server''s default collation. collationServer corresponds to the MySQL server variable [collation_server](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_collation_server). ' enum: - ARMSCII8_GENERAL_CI - ARMSCII8_BIN - ASCII_GENERAL_CI - ASCII_BIN - BIG5_CHINESE_CI - BIG5_BIN - BINARY - CP1250_GENERAL_CI - CP1250_BIN - CP1250_CROATIAN_CI - CP1250_CZECH_CS - CP1250_POLISH_CI - CP1251_GENERAL_CI - CP1251_BIN - CP1251_BULGARIAN_CI - CP1251_GENERAL_CS - CP1251_UKRAINIAN_CI - CP1256_GENERAL_CI - CP1256_BIN - CP1257_GENERAL_CI - CP1257_BIN - CP1257_LITHUANIAN_CI - CP850_GENERAL_CI - CP850_BIN - CP852_GENERAL_CI - CP852_BIN - CP866_GENERAL_CI - CP866_BIN - CP932_JAPANESE_CI - CP932_BIN - DEC8_SWEDISH_CI - DEC8_BIN - EUCJPMS_JAPANESE_CI - EUCJPMS_BIN - EUCKR_KOREAN_CI - EUCKR_BIN - GB18030_CHINESE_CI - GB18030_BIN - GB18030_UNICODE_520_CI - GB2312_CHINESE_CI - GB2312_BIN - GBK_CHINESE_CI - GBK_BIN - GEOSTD8_GENERAL_CI - GEOSTD8_BIN - GREEK_GENERAL_CI - GREEK_BIN - HEBREW_GENERAL_CI - HEBREW_BIN - HP8_ENGLISH_CI - HP8_BIN - KEYBCS2_GENERAL_CI - KEYBCS2_BIN - KOI8R_GENERAL_CI - KOI8R_BIN - KOI8U_GENERAL_CI - KOI8U_BIN - LATIN1_SWEDISH_CI - LATIN1_BIN - LATIN1_DANISH_CI - LATIN1_GENERAL_CI - LATIN1_GENERAL_CS - LATIN1_GERMAN1_CI - LATIN1_GERMAN2_CI - LATIN1_SPANISH_CI - LATIN2_GENERAL_CI - LATIN2_BIN - LATIN2_CROATIAN_CI - LATIN2_CZECH_CS - LATIN2_HUNGARIAN_CI - LATIN5_TURKISH_CI - LATIN5_BIN - LATIN7_GENERAL_CI - LATIN7_BIN - LATIN7_ESTONIAN_CS - LATIN7_GENERAL_CS - MACCE_GENERAL_CI - MACCE_BIN - MACROMAN_GENERAL_CI - MACROMAN_BIN - SJIS_JAPANESE_CI - SJIS_BIN - SWE7_SWEDISH_CI - SWE7_BIN - TIS620_THAI_CI - TIS620_BIN - UCS2_GENERAL_CI - UCS2_BIN - UCS2_CROATIAN_CI - UCS2_CZECH_CI - UCS2_DANISH_CI - UCS2_ESPERANTO_CI - UCS2_ESTONIAN_CI - UCS2_GENERAL_MYSQL500_CI - UCS2_GERMAN2_CI - UCS2_HUNGARIAN_CI - UCS2_ICELANDIC_CI - UCS2_LATVIAN_CI - UCS2_LITHUANIAN_CI - UCS2_PERSIAN_CI - UCS2_POLISH_CI - UCS2_ROMANIAN_CI - UCS2_ROMAN_CI - UCS2_SINHALA_CI - UCS2_SLOVAK_CI - UCS2_SLOVENIAN_CI - UCS2_SPANISH2_CI - UCS2_SPANISH_CI - UCS2_SWEDISH_CI - UCS2_TURKISH_CI - UCS2_UNICODE_520_CI - UCS2_UNICODE_CI - UCS2_VIETNAMESE_CI - UJIS_JAPANESE_CI - UJIS_BIN - UTF16_GENERAL_CI - UTF16_BIN - UTF16_CROATIAN_CI - UTF16_CZECH_CI - UTF16_DANISH_CI - UTF16_ESPERANTO_CI - UTF16_ESTONIAN_CI - UTF16_GERMAN2_CI - UTF16_HUNGARIAN_CI - UTF16_ICELANDIC_CI - UTF16_LATVIAN_CI - UTF16_LITHUANIAN_CI - UTF16_PERSIAN_CI - UTF16_POLISH_CI - UTF16_ROMANIAN_CI - UTF16_ROMAN_CI - UTF16_SINHALA_CI - UTF16_SLOVAK_CI - UTF16_SLOVENIAN_CI - UTF16_SPANISH2_CI - UTF16_SPANISH_CI - UTF16_SWEDISH_CI - UTF16_TURKISH_CI - UTF16_UNICODE_520_CI - UTF16_UNICODE_CI - UTF16_VIETNAMESE_CI - UTF16LE_GENERAL_CI - UTF16LE_BIN - UTF32_GENERAL_CI - UTF32_BIN - UTF32_CROATIAN_CI - UTF32_CZECH_CI - UTF32_DANISH_CI - UTF32_ESPERANTO_CI - UTF32_ESTONIAN_CI - UTF32_GERMAN2_CI - UTF32_HUNGARIAN_CI - UTF32_ICELANDIC_CI - UTF32_LATVIAN_CI - UTF32_LITHUANIAN_CI - UTF32_PERSIAN_CI - UTF32_POLISH_CI - UTF32_ROMANIAN_CI - UTF32_ROMAN_CI - UTF32_SINHALA_CI - UTF32_SLOVAK_CI - UTF32_SLOVENIAN_CI - UTF32_SPANISH2_CI - UTF32_SPANISH_CI - UTF32_SWEDISH_CI - UTF32_TURKISH_CI - UTF32_UNICODE_520_CI - UTF32_UNICODE_CI - UTF32_VIETNAMESE_CI - UTF8_GENERAL_CI - UTF8_BIN - UTF8_CROATIAN_CI - UTF8_CZECH_CI - UTF8_DANISH_CI - UTF8_ESPERANTO_CI - UTF8_ESTONIAN_CI - UTF8_GENERAL_MYSQL500_CI - UTF8_GERMAN2_CI - UTF8_HUNGARIAN_CI - UTF8_ICELANDIC_CI - UTF8_LATVIAN_CI - UTF8_LITHUANIAN_CI - UTF8_PERSIAN_CI - UTF8_POLISH_CI - UTF8_ROMANIAN_CI - UTF8_ROMAN_CI - UTF8_SINHALA_CI - UTF8_SLOVAK_CI - UTF8_SLOVENIAN_CI - UTF8_SPANISH2_CI - UTF8_SPANISH_CI - UTF8_SWEDISH_CI - UTF8_TOLOWER_CI - UTF8_TURKISH_CI - UTF8_UNICODE_520_CI - UTF8_UNICODE_CI - UTF8_VIETNAMESE_CI - UTF8MB4_0900_AI_CI - UTF8MB4_0900_AS_CI - UTF8MB4_0900_AS_CS - UTF8MB4_0900_BIN - UTF8MB4_BIN - UTF8MB4_CROATIAN_CI - UTF8MB4_CS_0900_AI_CI - UTF8MB4_CS_0900_AS_CS - UTF8MB4_CZECH_CI - UTF8MB4_DANISH_CI - UTF8MB4_DA_0900_AI_CI - UTF8MB4_DA_0900_AS_CS - UTF8MB4_DE_PB_0900_AI_CI - UTF8MB4_DE_PB_0900_AS_CS - UTF8MB4_EO_0900_AI_CI - UTF8MB4_EO_0900_AS_CS - UTF8MB4_ESPERANTO_CI - UTF8MB4_ESTONIAN_CI - UTF8MB4_ES_0900_AI_CI - UTF8MB4_ES_0900_AS_CS - UTF8MB4_ES_TRAD_0900_AI_CI - UTF8MB4_ES_TRAD_0900_AS_CS - UTF8MB4_ET_0900_AI_CI - UTF8MB4_ET_0900_AS_CS - UTF8MB4_GENERAL_CI - UTF8MB4_GERMAN2_CI - UTF8MB4_HR_0900_AI_CI - UTF8MB4_HR_0900_AS_CS - UTF8MB4_HUNGARIAN_CI - UTF8MB4_HU_0900_AI_CI - UTF8MB4_HU_0900_AS_CS - UTF8MB4_ICELANDIC_CI - UTF8MB4_IS_0900_AI_CI - UTF8MB4_IS_0900_AS_CS - UTF8MB4_JA_0900_AS_CS - UTF8MB4_JA_0900_AS_CS_KS - UTF8MB4_LATVIAN_CI - UTF8MB4_LA_0900_AI_CI - UTF8MB4_LA_0900_AS_CS - UTF8MB4_LITHUANIAN_CI - UTF8MB4_LT_0900_AI_CI - UTF8MB4_LT_0900_AS_CS - UTF8MB4_LV_0900_AI_CI - UTF8MB4_LV_0900_AS_CS - UTF8MB4_PERSIAN_CI - UTF8MB4_PL_0900_AI_CI - UTF8MB4_PL_0900_AS_CS - UTF8MB4_POLISH_CI - UTF8MB4_ROMANIAN_CI - UTF8MB4_ROMAN_CI - UTF8MB4_RO_0900_AI_CI - UTF8MB4_RO_0900_AS_CS - UTF8MB4_RU_0900_AI_CI - UTF8MB4_RU_0900_AS_CS - UTF8MB4_SINHALA_CI - UTF8MB4_SK_0900_AI_CI - UTF8MB4_SK_0900_AS_CS - UTF8MB4_SLOVAK_CI - UTF8MB4_SLOVENIAN_CI - UTF8MB4_SL_0900_AI_CI - UTF8MB4_SL_0900_AS_CS - UTF8MB4_SPANISH2_CI - UTF8MB4_SPANISH_CI - UTF8MB4_SV_0900_AI_CI - UTF8MB4_SV_0900_AS_CS - UTF8MB4_SWEDISH_CI - UTF8MB4_TR_0900_AI_CI - UTF8MB4_TR_0900_AS_CS - UTF8MB4_TURKISH_CI - UTF8MB4_UNICODE_520_CI - UTF8MB4_UNICODE_CI - UTF8MB4_VIETNAMESE_CI - UTF8MB4_VI_0900_AI_CI - UTF8MB4_VI_0900_AS_CS - UTF8MB4_ZH_0900_AS_CS type: string x-default-description: 'If not specified, the MySQL server internally assumes the default collation for the configured character set. ' x-obmcs-mysql-isDynamic: true completionType: default: NO_CHAIN description: ("completion_type") enum: - NO_CHAIN - CHAIN - RELEASE type: string x-obmcs-mysql-isDynamic: true connectTimeout: default: 10 description: 'The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake. connectTimeout corresponds to the MySQL system variable [connect_timeout](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_connect_timeout) Increasing the connect_timeout value might help if clients frequently encounter errors of the form "Lost connection to MySQL server at ''XXX'', system error: errno". ' maximum: 31536000 minimum: 2 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: seconds connectionMemoryChunkSize: default: 8912 description: 'Set the chunking size for updates to the global memory usage counter Global_connection_memory. connectionMemoryChunkSize corresponds to the MySQL system variable [connection_memory_chunk_size](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_connection_memory_chunk_size). ' maximum: 536870912 minimum: 0 type: integer connectionMemoryLimit: description: 'Set the maximum amount of memory that can be used by a single user connection. connectionMemoryLimit corresponds to the MySQL system variable [connection_memory_limit](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_connection_memory_limit). ' format: int64 maximum: 9223372036854775807 minimum: 2097152 type: integer x-default-description: No memory limits imposed. x-obmcs-mysql-units: bytes cteMaxRecursionDepth: default: 1000 description: ("cte_max_recursion_depth") format: int64 maximum: 4294967295 minimum: 0 type: integer x-obmcs-mysql-isDynamic: true defaultAuthenticationPlugin: default: caching_sha2_password description: 'The default authentication plugin. This must be a plugin that uses internal credentials storage, so these values are permitted: mysql_native_password, sha256_password, caching_sha2_password. As of MySQL 8.0.27, which introduces multifactor authentication, default_authentication_plugin is still used, but in conjunction with and at a lower precedence than the authentication_policy system variable. For details, see The Default Authentication Plugin. Because of this diminished role, default_authentication_plugin is deprecated as of MySQL 8.0.27 and subject to removal in a future MySQL version. defaultAuthenticationPlugin corresponds to the MySQL system variable [default_authentication_plugin](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_default_authentication_plugin). ' enum: - mysql_native_password - sha256_password - caching_sha2_password type: string explainFormat: description: 'This variable determines the default output format used by EXPLAIN in the absence of a FORMAT option when displaying a query execution plan. explainFormat corresponds to the MySQL system variable [explain_format](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_explain_format). ' enum: - TRADITIONAL - JSON - TREE type: string x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true explicitDefaultsForTimestamp: description: 'This system variable determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns. By default, explicit_defaults_for_timestamp is enabled, which disables the nonstandard behaviors. Disabling explicit_defaults_for_timestamp results in a warning. explicit_defaults_for_timestamp corresponds to the MySQL Server Administration system variable [explicit_defaults_for_timestamp](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_explicit_defaults_for_timestamp) ' type: boolean x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true foreignKeyChecks: default: true description: ("foreign_key_checks") type: boolean generatedRandomPasswordLength: default: 20 description: ("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored maximum: 255 minimum: 5 type: integer x-obmcs-mysql-isDynamic: true globalConnectionMemoryLimit: description: 'Set the total amount of memory that can be used by all user connections. globalConnectionMemoryLimit corresponds to the MySQL system variable [global_connection_memory_limit](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_global_connection_memory_limit). ' format: int64 maximum: 9223372036854775807 minimum: 2097152 type: integer x-default-description: No memory limits imposed. x-obmcs-mysql-units: bytes globalConnectionMemoryTracking: default: false description: 'Determines whether the MySQL server calculates Global_connection_memory. globalConnectionMemoryTracking corresponds to the MySQL system variable [global_connection_memory_tracking](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_global_connection_memory_tracking). ' type: boolean groupConcatMaxLen: default: 1024 description: 'Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function. This is the MySQL variable "group_concat_max_len". For more information, please see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_group_concat_max_len) ' format: int64 maximum: 9223372036854775807 minimum: 4 type: integer x-obmcs-mysql-isDynamic: true groupReplicationConsistency: default: BEFORE_ON_PRIMARY_FAILOVER description: "- EVENTUAL:\n Both RO and RW transactions do not wait for preceding transactions to be applied before executing.\n A RW transaction does not wait for other members to apply a transaction. This means that a transaction\n could be externalized on one member before the others. This also means that in the event of a primary failover,\n the new primary can accept new RO and RW transactions before the previous primary transactions are all applied.\n RO transactions could result in outdated values, RW transactions could result in a rollback due to conflicts.\n- BEFORE_ON_PRIMARY_FAILOVER:\n New RO or RW transactions with a newly elected primary that is applying backlog from the old\n primary are held (not applied) until any backlog has been applied. This ensures that when a primary failover happens,\n intentionally or not, clients always see the latest value on the primary. This guarantees consistency, but means that\n clients must be able to handle the delay in the event that a backlog is being applied. Usually this delay should be minimal,\n but does depend on the size of the backlog.\n- BEFORE:\n A RW transaction waits for all preceding transactions to complete before being applied. A RO transaction waits for all preceding\n transactions to complete before being executed. This ensures that this transaction reads the latest value by only affecting the\n latency of the transaction. This reduces the overhead of synchronization on every RW transaction, by ensuring synchronization is\n used only on RO transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER.\n- AFTER:\n A RW transaction waits until its changes have been applied to all of the other members. This value has no effect on RO transactions.\n This mode ensures that when a transaction is committed on the local member, any subsequent transaction reads the written value or\n a more recent value on any group member. Use this mode with a group that is used for predominantly RO operations to ensure that\n applied RW transactions are applied everywhere once they commit. This could be used by your application to ensure that subsequent\n reads fetch the latest data which includes the latest writes. This reduces the overhead of synchronization on every RO transaction,\n by ensuring synchronization is used only on RW transactions. This consistency level also includes the consistency guarantees\n provided by BEFORE_ON_PRIMARY_FAILOVER.\n- BEFORE_AND_AFTER:\n A RW transaction waits for 1) all preceding transactions to complete before being applied and 2) until its changes have been\n applied on other members. A RO transaction waits for all preceding transactions to complete before execution takes place.\n This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER.\n" enum: - EVENTUAL - BEFORE_ON_PRIMARY_FAILOVER - BEFORE - AFTER - BEFORE_AND_AFTER type: string x-obmcs-mysql-isDynamic: true informationSchemaStatsExpiry: default: 86400 description: ("information_schema_stats_expiry") maximum: 31536000 minimum: 0 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: seconds innodbAdaptiveHashIndex: description: 'Whether the InnoDB adaptive hash index is enabled or disabled. It may be desirable, depending on your workload, to dynamically enable or disable adaptive hash indexing to improve query performance. Because the adaptive hash index may not be useful for all workloads, conduct benchmarks with it both enabled and disabled, using realistic workloads. innodbAdaptiveHashIndex corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_adaptive_hash_index] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_adaptive_hash_index). ' type: boolean x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true innodbAutoincLockMode: description: 'The lock mode to use for generating auto-increment values. Permissible values are 0, 1, or 2, for traditional, consecutive, or interleaved, respectively. innodbAutoincLockMode corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_autoinc_lock_mode] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_autoinc_lock_mode). ' type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: false x-obmcs-mysql-validValues: - 0 - 1 - 2 innodbBufferPoolDumpPct: default: 25 description: 'Specifies the percentage of the most recently used pages for each buffer pool to read out and dump. innodbBufferPoolDumpPct corresponds to the MySQL InnoDB system variable [innodb_buffer_pool_dump_pct](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_buffer_pool_dump_pct). The range is 1 to 100. The default value is 25. For example, if there are 4 buffer pools with 100 pages each, and innodb_buffer_pool_dump_pct is set to 25, the 25 most recently used pages from each buffer pool are dumped. ' maximum: 100 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true innodbBufferPoolInstances: default: 8 description: ("innodb_buffer_pool_instances") maximum: 64 minimum: 1 type: integer x-obmcs-mysql-isDynamic: false innodbBufferPoolSize: default: 134217728 description: 'The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data. innodbBufferPoolSize corresponds to the MySQL server system variable [innodb_buffer_pool_size](https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_buffer_pool_size). The default and maximum values depend on the amount of RAM provisioned by the shape. See [Default User Variables](/mysql-database/doc/configuring-db-system.html#GUID-B5504C19-F6F4-4DAB-8506-189A4E8F4A6A). ' format: int64 maximum: 9223372036854775807 minimum: 5242880 type: integer x-obmcs-mysql-isDynamic: true innodbChangeBuffering: description: 'Whether InnoDB performs change buffering, an optimization that delays write operations to secondary indexes so that the I/O operations can be performed sequentially. Permitted values are described in the following table. Values may also be specified numerically. innodbChangeBuffering corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_change_buffering] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_change_buffering). ' enum: - NONE - INSERTS - DELETES - CHANGES - PURGES - ALL type: string x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true innodbDdlBufferSize: default: 1048576 description: 'innodbDdlBufferSize corresponds to the MySQL system variable [innodb_ddl_buffer_size] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_ddl_buffer_size) ' format: int64 maximum: 4294967295 minimum: 65536 type: integer x-obmcs-mysql-isDynamic: true innodbDdlThreads: default: 4 description: 'innodbDdlThreads corresponds to the MySQL system variable [innodb_ddl_threads] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_ddl_threads) ' maximum: 64 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true innodbFtEnableStopword: default: true description: ("innodb_ft_enable_stopword") type: boolean innodbFtMaxTokenSize: default: 84 description: ("innodb_ft_max_token_size") maximum: 84 minimum: 10 type: integer x-obmcs-mysql-isDynamic: false innodbFtMinTokenSize: default: 3 description: ("innodb_ft_min_token_size") maximum: 16 minimum: 0 type: integer x-obmcs-mysql-isDynamic: false innodbFtNumWordOptimize: default: 2000 description: ("innodb_ft_num_word_optimize") type: integer x-obmcs-mysql-isDynamic: true innodbFtResultCacheLimit: default: 2000000000 description: ("innodb_ft_result_cache_limit") format: int64 maximum: 4294967295 minimum: 1000000 type: integer x-obmcs-mysql-isDynamic: true innodbFtServerStopwordTable: default: null description: ("innodb_ft_server_stopword_table") type: string x-obmcs-mysql-isDynamic: true innodbLockWaitTimeout: default: 50 description: ("innodb_lock_wait_timeout") maximum: 1073741824 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true innodbLogWriterThreads: default: true description: 'Enables dedicated log writer threads for writing redo log records from the log buffer to the system buffers and flushing the system buffers to the redo log files. This is the MySQL variable "innodb_log_writer_threads". For more information, please see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_log_writer_threads) ' type: boolean innodbMaxPurgeLag: default: 0 description: 'The desired maximum purge lag in terms of transactions. InnoDB maintains a list of transactions that have index records delete-marked by UPDATE or DELETE operations. The length of the list is the purge lag. If this value is exceeded, a delay is imposed on INSERT, UPDATE, and DELETE operations to allow time for purge to catch up. The default value is 0, which means there is no maximum purge lag and no delay. innodbMaxPurgeLag corresponds to the MySQL server system variable [innodb_max_purge_lag](https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_max_purge_lag). ' format: int64 maximum: 4294967295 minimum: 0 type: integer x-obmcs-mysql-isDynamic: true innodbMaxPurgeLagDelay: default: 0 description: 'The maximum delay in microseconds for the delay imposed when the innodb_max_purge_lag threshold is exceeded. The specified innodb_max_purge_lag_delay value is an upper limit on the delay period. innodbMaxPurgeLagDelay corresponds to the MySQL server system variable [innodb_max_purge_lag_delay](https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_max_purge_lag_delay). ' maximum: 1000000 minimum: 0 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: microseconds innodbNumaInterleave: description: 'Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool. When innodb_numa_interleave is enabled, the NUMA memory policy is set to MPOL_INTERLEAVE for the mysqld process. After the InnoDB buffer pool is allocated, the NUMA memory policy is set back to MPOL_DEFAULT. For the innodb_numa_interleave option to be available, MySQL must be compiled on a NUMA-enabled Linux system. innodbNumaInterleave corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_numa_interleave] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_numa_interleave). ' type: boolean x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: false innodbOnlineAlterLogMaxSize: description: 'Specifies an upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables. There is one such log file for each index being created or table being altered. This log file stores data inserted, updated, or deleted in the table during the DDL operation. innodbOnlineAlterLogMaxSize corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_online_alter_log_max_size] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_online_alter_log_max_size). ' format: int64 maximum: 9223372036854775807 minimum: 65536 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true innodbRedoLogCapacity: description: 'Defines the amount of disk space occupied by redo log files. innodb_redo_log_capacity supercedes the innodb_log_files_in_group and innodb_log_file_size variables, which are both ignored if innodb_redo_log_capacity is defined. If innodb_redo_log_capacity is not defined, and if neither innodb_log_file_size or innodb_log_files_in_group are defined, then the default innodb_redo_log_capacity value is used. innodbRedoLogCapacity corresponds to the InnoDB Startup Options and System Variables [innodb_redo_log_capacity](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_redo_log_capacity) ' format: int64 maximum: 137438953472 minimum: 8388608 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true innodbRollbackOnTimeout: description: 'InnoDB rolls back only the last statement on a transaction timeout by default. If --innodb-rollback-on-timeout is specified, a transaction timeout causes InnoDB to abort and roll back the entire transaction. innodbRollbackOnTimeout corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_rollback_on_timeout] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_rollback_on_timeout). ' type: boolean x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: false innodbSortBufferSize: description: "This variable defines:\n\n* The sort buffer size for online DDL operations that create or rebuild secondary indexes.\n However, as of MySQL 8.0.27, this responsibility is subsumed by the innodb_ddl_buffer_size variable.\n\n* The amount by which the temporary log file is extended when recording concurrent DML during an online DDL operation,\n and the size of the temporary log file read buffer and write buffer.\n\ninnodbSortBufferSize corresponds to the MySQL InnoDB Startup Options and System Variables\n[innodb_sort_buffer_size] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_sort_buffer_size).\n" maximum: 67108864 minimum: 65536 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: false innodbStatsPersistentSamplePages: default: 20 description: 'The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE. innodbStatsPersistentSamplePages corresponds to the MySQL InnoDB system variable [innodb_stats_persistent_sample_pages](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_stats_persistent_sample_pages) innodb_stats_persistent_sample_pages only applies when innodb_stats_persistent is enabled for a table; when innodb_stats_persistent is disabled, innodb_stats_transient_sample_pages applies instead. ' format: int64 maximum: 9223372036854775807 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true innodbStatsTransientSamplePages: default: 8 description: 'The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by [ANALYZE TABLE](https://dev.mysql.com/doc/refman/8.0/en/analyze-table.html). innodbStatsTransientSamplePages corresponds to the MySQL InnoDB system variable [innodb_stats_transient_sample_pages](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_stats_transient_sample_pages) innodb_stats_transient_sample_pages only applies when innodb_stats_persistent is disabled for a table; when innodb_stats_persistent is enabled, innodb_stats_persistent_sample_pages applies instead. innodb_stats_persistent is ON by default and cannot be changed. It is possible to override it using the STATS_PERSISTENT clause of the [CREATE TABLE](https://dev.mysql.com/doc/refman/8.0/en/create-table.html) and [ALTER TABLE](https://dev.mysql.com/doc/refman/8.0/en/alter-table.html) statements. ' format: int64 maximum: 9223372036854775807 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true innodbStrictMode: default: true description: 'When you enable innodbStrictMode, the InnoDB storage engine returns errors instead of warnings for invalid or incompatible table options. innodbStrictMode corresponds to the MySQL InnoDB system variable [innodb_strict_mode](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_strict_mode) ' type: boolean innodbUndoLogTruncate: description: 'When enabled, undo tablespaces that exceed the threshold value defined by innodb_max_undo_log_size are marked for truncation. Only undo tablespaces can be truncated. Truncating undo logs that reside in the system tablespace is not supported. For truncation to occur, there must be at least two undo tablespaces. innodbUndoLogTruncate corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_undo_log_truncate] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_undo_log_truncate). ' type: boolean x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true interactiveTimeout: default: 28800 description: 'The number of seconds the server waits for activity on an interactive connection before closing it. interactiveTimeout corresponds to the MySQL system variable. [interactive_timeout](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_interactive_timeout) ' maximum: 31536000 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: seconds joinBufferSize: description: 'The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans. In MySQL 8.0.18 and later, this variable also controls the amount of memory used for hash joins. Normally, the best way to get fast joins is to add indexes. Increase the value of join_buffer_size to get a faster full join when adding indexes is not possible. One join buffer is allocated for each full join between two tables. For a complex join between several tables for which indexes are not used, multiple join buffers might be necessary. joinBufferSize corresponds to the MySQL Server System variable [join_buffer_size] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_join_buffer_size). ' format: int64 maximum: 9223372036854775807 minimum: 128 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true localInfile: default: false description: "This variable controls server-side LOCAL capability for LOAD DATA statements. Depending on the local_infile setting,\nthe server refuses or permits local data loading by clients that have LOCAL enabled on the client side. \n\nlocal_infile corresponds to the MySQL Server system variable\n[local_infile](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_local_infile)\n" type: boolean x-obmcs-mysql-isDynamic: true longQueryTime: description: 'If a query takes longer than this many seconds, the server increments the Slow_queries status variable. If the slow query log is enabled, the query is logged to the slow query log file. This value is measured in real time, not CPU time, so a query that is under the threshold on a lightly loaded system might be above the threshold on a heavily loaded one. longQueryTime corresponds to the MySQL Server System variable [long_query_time] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_long_query_time). ' maximum: 31536000 minimum: 0 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true mandatoryRoles: default: '' description: ("mandatory_roles") type: string x-obmcs-mysql-isDynamic: true maxAllowedPacket: default: 67108864 description: 'The maximum size of one packet or any generated/intermediate string. This is the mysql variable "max_allowed_packet". ' maximum: 1073741824 minimum: 67108864 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-units: bytes maxBinlogCacheSize: description: 'Sets the size of the transaction cache. maxBinlogCacheSize corresponds to the MySQL server system variable [max_binlog_cache_size](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_max_binlog_cache_size). ' format: int64 maximum: 65970697666560 minimum: 4096 type: integer x-obmcs-mysql-isDynamic: true maxConnectErrors: description: ("max_connect_errors") format: int64 maximum: 9223372036854775807 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true maxConnections: default: 151 description: ("max_connections") maximum: 100000 minimum: 151 type: integer maxExecutionTime: default: 0 description: ("max_execution_time") format: int64 maximum: 9223372036854775807 minimum: 0 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: millis maxHeapTableSize: default: 16777216 description: 'This variable sets the maximum size to which user-created MEMORY tables are permitted to grow. maxHeapTableSize corresponds to the MySQL system variable [max_heap_table_size](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_heap_table_size) ' format: int64 maximum: 9223372036854775807 minimum: 16384 type: integer x-obmcs-mysql-isDynamic: true maxPreparedStmtCount: default: 16382 description: ("max_prepared_stmt_count") maximum: 4194304 minimum: 0 type: integer x-obmcs-mysql-isDynamic: true maxSeeksForKey: description: 'Limit the assumed maximum number of seeks when looking up rows based on a key. The MySQL optimizer assumes that no more than this number of key seeks are required when searching for matching rows in a table by scanning an index, regardless of the actual cardinality of the index (see Section 15.7.7.22, “SHOW INDEX Statement”). By setting this to a low value (say, 100), you can force MySQL to prefer indexes instead of table scans. maxSeeksForKey corresponds to the MySQL Server System variable [max_seeks_for_key] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_seeks_for_key). ' format: int64 maximum: 9223372036854775807 minimum: 1 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true maxUserConnections: description: 'The maximum number of simultaneous connections permitted to any given MySQL user account. A value of 0 (the default) means “no limit.” This variable has a global value that can be set at server startup or runtime. It also has a read-only session value that indicates the effective simultaneous-connection limit that applies to the account associated with the current session. maxUserConnections corresponds to the MySQL Server System variable [max_user_connections] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_user_connections). ' format: int64 maximum: 4294967295 minimum: 0 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true mysqlFirewallMode: default: true description: ("mysql_firewall_mode") type: boolean mysqlZstdDefaultCompressionLevel: default: 3 description: DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored. maximum: 18 minimum: 1 type: integer mysqlxConnectTimeout: default: 30 description: 'The number of seconds X Plugin waits for the first packet to be received from newly connected clients. mysqlxConnectTimeout corresponds to the MySQL X Plugin system variable [mysqlx_connect_timeout](https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_connect_timeout) ' maximum: 1000000000 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-units: seconds mysqlxDeflateDefaultCompressionLevel: default: 3 description: Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level") maximum: 9 minimum: 1 type: integer mysqlxDeflateMaxClientCompressionLevel: default: 5 description: Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlx_deflate_max_client_compression_level") maximum: 9 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true? mysqlxDocumentIdUniquePrefix: default: 0 description: ("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored maximum: 65535 minimum: 0 type: integer x-obmcs-mysql-isDynamic: true mysqlxEnableHelloNotice: default: true description: ("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored type: boolean mysqlxIdleWorkerThreadTimeout: default: 60 description: ("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored maximum: 3600 minimum: 0 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-units: seconds mysqlxInteractiveTimeout: default: 28800 description: 'The number of seconds to wait for interactive clients to timeout. mysqlxInteractiveTimeout corresponds to the MySQL X Plugin system variable. [mysqlx_interactive_timeout](https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_interactive_timeout) ' maximum: 2147483 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: seconds mysqlxLz4DefaultCompressionLevel: default: 2 description: Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level") maximum: 16 minimum: 0 type: integer mysqlxLz4MaxClientCompressionLevel: default: 8 description: Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlx_lz4_max_client_compression_level") maximum: 16 minimum: 0 type: integer mysqlxMaxAllowedPacket: default: 67108864 description: 'The maximum size of network packets that can be received by X Plugin. This is the mysql variable "mysqlx_max_allowed_packet". ' maximum: 1073741824 minimum: 67108864 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-units: bytes mysqlxMinWorkerThreads: default: 2 description: ("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored maximum: 100 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true mysqlxReadTimeout: default: 28800 description: 'The number of seconds that X Plugin waits for blocking read operations to complete. After this time, if the read operation is not successful, X Plugin closes the connection and returns a warning notice with the error code ER_IO_READ_ERROR to the client application. mysqlxReadTimeout corresponds to the MySQL X Plugin system variable [mysqlx_read_timeout](https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_read_timeout) ' maximum: 2147483 minimum: 30 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: seconds mysqlxWaitTimeout: default: 28800 description: 'The number of seconds that X Plugin waits for activity on a connection. mysqlxWaitTimeout corresponds to the MySQL X Plugin system variable. [mysqlx_wait_timeout](https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_wait_timeout) ' maximum: 2147483 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: seconds mysqlxWriteTimeout: default: 60 description: 'The number of seconds that X Plugin waits for blocking write operations to complete. After this time, if the write operation is not successful, X Plugin closes the connection. mysqlxReadmysqlxWriteTimeoutTimeout corresponds to the MySQL X Plugin system variable [mysqlx_write_timeout](https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_write_timeout) ' maximum: 2147483 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-units: seconds mysqlxZstdDefaultCompressionLevel: default: 3 description: Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level") maximum: 18 minimum: 1 type: integer mysqlxZstdMaxClientCompressionLevel: default: 11 description: Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlx_zstd_max_client_compression_level") maximum: 18 minimum: 1 type: integer netReadTimeout: default: 30 description: 'The number of seconds to wait for more data from a connection before aborting the read. netReadTimeout corresponds to the MySQL system variable [net_read_timeout](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_net_read_timeout) ' maximum: 31536000 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: seconds netWriteTimeout: default: 60 description: 'The number of seconds to wait for a block to be written to a connection before aborting the write. netWriteTimeout corresponds to the MySQL system variable [net_write_timeout](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_net_write_timeout) ' maximum: 31536000 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: seconds optimizerSwitch: description: 'The optimizer_switch system variable enables control over optimizer behavior. The value of this variable is a set of flags, each of which has a value of on or off to indicate whether the corresponding optimizer behavior is enabled or disabled. This variable has global and session values and can be changed at runtime. The global default can be set at server startup. Setting hypergraph_optimizer=on for cloud builds below 9.0.0 will fail. optimizerSwitch corresponds to the MySQL Server System variable [optimizer_switch] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_optimizer_switch). ' type: string x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true x-obmcs-mysql-type: Set x-obmcs-mysql-validValues: - batched_key_access={on|off} - block_nested_loop={on|off} - condition_fanout_filter={on|off} - derived_condition_pushdown={on|off} - derived_merge={on|off} - duplicateweedout={on|off} - engine_condition_pushdown={on|off} - firstmatch={on|off} - hash_join={on|off} - index_condition_pushdown={on|off} - index_merge={on|off} - index_merge_intersection={on|off} - index_merge_sort_union={on|off} - index_merge_union={on|off} - loosescan={on|off} - materialization={on|off} - mrr={on|off} - mrr_cost_based={on|off} - prefer_ordering_index={on|off} - semijoin={on|off} - skip_scan={on|off} - subquery_materialization_cost_based={on|off} - subquery_to_derived={on|off} - use_index_extensions={on|off} - use_invisible_indexes={on|off} - hypergraph_optimizer={on|off} parserMaxMemSize: description: ("parser_max_mem_size") format: int64 maximum: 9223372036854775807 minimum: 10000000 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: bytes queryAllocBlockSize: default: 8192 description: ("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored format: int64 maximum: 4294967295 minimum: 1024 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: bytes queryPreallocSize: default: 8192 description: ("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored format: int64 maximum: 9223372036854775807 minimum: 8192 type: integer x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: bytes rangeOptimizerMaxMemSize: description: "The limit on memory consumption for the range optimizer. A value of 0 means “no limit.”\nIf an execution plan considered by the optimizer uses the range access method but the optimizer estimates that the amount of memory needed for this method would exceed the limit,\nit abandons the plan and considers other plans. \n\nrangeOptimizerMaxMemSize corresponds to the MySQL Server System variable\n[range_optimizer_max_mem_size] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_range_optimizer_max_mem_size).\n" format: int64 maximum: 9223372036854775807 minimum: 0 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true regexpTimeLimit: default: 32 description: 'regexpTimeLimit corresponds to the MySQL system variable [regexp_time_limit] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_regexp_time_limit) ' maximum: 2147483647 minimum: 0 type: integer x-obmcs-mysql-isDynamic: true relayLogSpaceLimit: description: 'The maximum amount of space to use for all relay logs. relayLogSpaceLimit corresponds to the MySQL Replica Server Options variable [relay_log_space_limit] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html#sysvar_relay_log_space_limit). ' format: int64 maximum: 9223372036854775807 minimum: 0 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: false replicaNetTimeout: description: 'Specifies the number of seconds to wait for more data or a heartbeat signal from the source before the replica considers the connection broken, aborts the read, and tries to reconnect. Setting this variable has no immediate effect. The state of the variable applies on all subsequent START REPLICA commands. replicaNetTimeout corresponds to the MySQL Replica server system variable [replica_net_timeout](https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html#sysvar_replica_net_timeout) ' maximum: 31536000 minimum: 1 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true x-obmcs-mysql-unit: seconds replicaParallelWorkers: description: 'Beginning with MySQL 8.0.26, slave_parallel_workers is deprecated, and you should use replica_parallel_workers instead. (Prior to MySQL 8.0.26, you must use slave_parallel_workers to set the number of applier threads.) replicaParallelWorkers corresponds to the MySQL Replica Server Options variable [replica_parallel_workers] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html#sysvar_replica_parallel_workers). ' maximum: 1024 minimum: 0 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true replicaTypeConversions: description: "From MySQL 8.0.26, use replica_type_conversions in place of slave_type_conversions, which is deprecated from that release.\nIn releases before MySQL 8.0.26, use slave_type_conversions.\n\nreplica_type_conversions controls the type conversion mode in effect on the replica when using row-based replication.\nIts value is a comma-delimited set of zero or more elements from the list: ALL_LOSSY, ALL_NON_LOSSY, ALL_SIGNED, ALL_UNSIGNED.\nSet this variable to an empty string to disallow type conversions between the source and the replica.\nSetting this variable takes effect for all replication channels immediately, including running channels. \n\nreplica_type_conversions corresponds to the MySQL Replica Server Options variable\n[replica_type_conversions] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html#sysvar_replica_type_conversions).\n" type: string x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true x-obmcs-mysql-type: Set x-obmcs-mysql-validValues: - ALL_LOSSY - ALL_NON_LOSSY - ALL_SIGNED - ALL_UNSIGNED requireSecureTransport: description: 'Whether client connections to the server are required to use some form of secure transport. When this variable is enabled, the server permits only TCP/IP connections encrypted using TLS/SSL, or connections that use a socket file or shared memory. The server rejects nonsecure connection attempts, which fail with an ER_SECURE_TRANSPORT_REQUIRED error. require_secure_transport corresponds to the MySQL Server Administration system variable [require_secure_transport](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_require_secure_transport) ' type: boolean x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true skipNameResolve: description: 'Whether to resolve host names when checking client connections. If this variable is OFF, mysqld resolves host names when checking client connections. If it is ON, mysqld uses only IP numbers; in this case, all Host column values in the grant tables must be IP addresses. See Section 7.1.12.3, “DNS Lookups and the Host Cache”. skipNameResolve corresponds to the MySQL Server System variable [skip_name_resolve] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_skip_name_resolve). ' type: boolean x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: false sortBufferSize: default: 262144 description: 'Each session that must perform a sort allocates a buffer of this size. sortBufferSize corresponds to the MySQL system variable [sort_buffer_size](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_sort_buffer_size) ' format: int64 maximum: 9223372036854775807 minimum: 32768 type: integer sqlGenerateInvisiblePrimaryKey: description: 'Whether GIPK mode is in effect, in which case a MySQL replication source server adds a generated invisible primary key to any InnoDB table that is created without one. sqlGenerateInvisiblePrimaryKey corresponds to the MySQL system variable [sql_generate_invisible_primary_key] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_sql_generate_invisible_primary_key). ' type: boolean x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true sqlMode: default: 'ONLY_FULL_GROUP_BY, STRICT_TRANS_TABLES, NO_ZERO_IN_DATE, NO_ZERO_DATE, ERROR_FOR_DIVISION_BY_ZERO, NO_ENGINE_SUBSTITUTION ' description: ("sql_mode") type: string x-obmcs-mysql-isDynamic: true x-obmcs-mysql-type: Set x-obmcs-mysql-validValues: - ALLOW_INVALID_DATES - ANSI_QUOTES - ERROR_FOR_DIVISION_BY_ZERO - HIGH_NOT_PRECEDENCE - IGNORE_SPACE - NO_AUTO_VALUE_ON_ZERO - NO_BACKSLASH_ESCAPES - NO_DIR_IN_CREATE - NO_ENGINE_SUBSTITUTION - NO_UNSIGNED_SUBTRACTION - NO_ZERO_DATE - NO_ZERO_IN_DATE - ONLY_FULL_GROUP_BY - PAD_CHAR_TO_FULL_LENGTH - PIPES_AS_CONCAT - REAL_AS_FLOAT - STRICT_ALL_TABLES - STRICT_TRANS_TABLES - TIME_TRUNCATE_FRACTIONAL sqlRequirePrimaryKey: default: false description: ("sql_require_primary_key") type: boolean sqlWarnings: default: false description: ("sql_warnings") type: boolean tableDefinitionCache: description: 'The number of table definitions that can be stored in the table definition cache. If you use a large number of tables, you can create a large table definition cache to speed up opening of tables. The table definition cache takes less space and does not use file descriptors, unlike the normal table cache. table_definition_cache corresponds to the MySQL Server Administration system variable [table_definition_cache](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_table_definition_cache) ' maximum: 524288 minimum: 400 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true tableOpenCache: description: 'The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires. table_open_cache corresponds to the MySQL Server Administration system variable [table_open_cache](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_table_open_cache) ' maximum: 524288 minimum: 1 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true temptableMaxRam: description: 'Defines the maximum amount of memory that can be occupied by the TempTable storage engine before it starts storing data on disk. The default value is 1073741824 bytes (1GiB). For more information, see Section 10.4.4, “Internal Temporary Table Use in MySQL”. temptableMaxRam corresponds to the MySQL system variable [temptable_max_ram] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_temptable_max_ram). ' format: int64 maximum: 9223372036854775807 minimum: 2097152 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true threadPoolDedicatedListeners: default: false description: 'Controls whether the thread pool uses dedicated listener threads. If enabled, a listener thread in each thread group is dedicated to the task of listening for network events from clients, ensuring that the maximum number of query worker threads is no more than the value specified by threadPoolMaxTransactionsLimit. threadPoolDedicatedListeners corresponds to the MySQL Database Service-specific system variable thread_pool_dedicated_listeners. ' type: boolean x-obmcs-mysql-isDynamic: false threadPoolMaxTransactionsLimit: description: 'Limits the maximum number of open transactions to the defined value. The default value is 0, which enforces no limit. threadPoolMaxTransactionsLimit corresponds to the MySQL Database Service-specific system variable thread_pool_max_transactions_limit. ' maximum: 100000 minimum: 0 type: integer x-obmcs-mysql-isDynamic: true threadPoolQueryThreadsPerGroup: description: "The maximum number of query threads permitted in a thread group.\nThe maximum value is 4096, but if thread_pool_max_transactions_limit is set, thread_pool_query_threads_per_group must not exceed that value.\nThe default value of 1 means there is one active query thread in each thread group, which works well for many loads.\nWhen you are using the high concurrency thread pool algorithm (thread_pool_algorithm = 1),\nconsider increasing the value if you experience slower response times due to long-running transactions. \n\nthreadPoolQueryThreadsPerGroup corresponds to the MySQL Server system variable\n[thread_pool_query_threads_per_group](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_thread_pool_query_threads_per_group)\n" maximum: 4096 minimum: 1 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true threadPoolSize: description: 'The number of thread groups in the thread pool. This is the most important parameter controlling thread pool performance. It affects how many statements can execute simultaneously. If a value outside the range of permissible values is specified, the thread pool plugin does not load and the server writes a message to the error log. threadPoolSize corresponds to the MySQL Server System variable [thread_pool_size] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_thread_pool_size). ' maximum: 512 minimum: 1 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: false threadPoolTransactionDelay: description: "The delay period before executing a new transaction, in milliseconds. The maximum value is 300000 (5 minutes).\nA transaction delay can be used in cases where parallel transactions affect the performance of other operations due to resource contention.\nFor example, if parallel transactions affect index creation or an online buffer pool resizing operation,\nyou can configure a transaction delay to reduce resource contention while those operations are running. \n\nthreadPoolTransactionDelay corresponds to the MySQL Server system variable\n[thread_pool_transaction_delay](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_thread_pool_transaction_delay)\n" maximum: 300000 minimum: 0 type: integer x-default-description: 'Assumes the MySQL Server default value, which may depend on the server version, according to documentation. ' x-obmcs-mysql-isDynamic: true timeZone: default: UTC description: 'Initializes the time zone for each client that connects. This corresponds to the MySQL System Variable "time_zone". The values can be given in one of the following formats, none of which are case-sensitive: - As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as ''+10:00'', ''-6:00'', or ''+05:30''. The permitted range is ''-13:59'' to ''+14:00'', inclusive. - As a named time zone, as defined by the "IANA Time Zone database", such as ''Europe/Helsinki'', ''US/Eastern'', ''MET'', or ''UTC''. ' type: string tmpTableSize: default: 16777216 description: 'The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables. tmp_table_size corresponds to the MySQL system variable [tmp_table_size](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_tmp_table_size) ' format: int64 maximum: 9223372036854775807 minimum: 1024 type: integer x-obmcs-mysql-isDynamic: true transactionIsolation: default: REPEATABLE-READ description: ("transaction_isolation") enum: - READ-UNCOMMITTED - READ-COMMITED - READ-COMMITTED - REPEATABLE-READ - SERIALIZABLE type: string x-obmcs-mysql-isDynamic: true waitTimeout: default: 28800 description: 'The number of seconds the server waits for activity on a noninteractive connection before closing it. waitTimeout corresponds to the MySQL system variable. [wait_timeout](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_wait_timeout) ' maximum: 2147483 minimum: 1 type: integer x-obmcs-mysql-isDynamic: true Version: description: 'A supported MySQL Version. ' properties: description: description: A link to a page describing the version. type: string version: description: The specific version identifier maxLength: 255 minLength: 1 type: string type: object Option: description: 'The value of an option for a particular version of the DB System engine. ' properties: name: description: The option name. maxLength: 64 minLength: 1 type: string value: description: The option value. maxLength: 1024 type: string required: - name ShapeSummary: description: 'The shape of the DB System. The shape determines resources to allocate to the DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. For a description of shapes, see [DB System Shape Options](/mysql-database/doc/shapes.htm). ' properties: cpuCoreCount: description: The number of CPU Cores the Instance provides. These are "OCPU"s. type: integer isSupportedFor: description: 'What service features the shape is supported for. ' items: enum: - DBSYSTEM - HEATWAVECLUSTER type: string type: array uniqueItems: true memorySizeInGBs: description: The amount of RAM the Instance provides. This is an IEC base-2 number. type: integer name: description: The name of the shape used for the DB System. maxLength: 255 minLength: 1 type: string required: - name - cpuCoreCount - memorySizeInGBs ConfigurationSummary: description: 'The general details of a Configuration such as its id, displayName, type, and shape association. ' properties: compartmentId: description: OCID of the Compartment the Configuration exists in. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: User-provided data about the Configuration. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the Configuration. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the Configuration. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the Configuration. type: string x-obmcs-enumref: '#/definitions/Configuration/lifecycleState' shapeName: description: The name of the associated Shape. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the Configuration was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeUpdated: description: The date and time the Configuration was last updated, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string type: description: The Configuration type, DEFAULT or CUSTOM type: string x-obmcs-enumref: '#/definitions/Configuration/type' required: - id - compartmentId - shapeName - type - lifecycleState responses: 409-Conflict: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404-NotFound: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 400-BadRequest: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500-ServerError: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' DefaultError: description: An error has occurred. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412-PreconditionFailed: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401-Unauthorized: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 304-NotModified: description: The resource with the given ETag has not changed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 429-TooManyRequests: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: backupPolicyDefinedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object backupPolicyFreeformTags: additionalProperties: type: string description: 'Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: `{"bar-key": "value"}` ' type: object definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object securityAttributes: additionalProperties: additionalProperties: description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) ' type: object description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` ' type: object description: 'Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-oracle-package: com.oracle.oci.mysql