SQL Database Instance

Docs > DDSQL Reference > Data Directory > SQL Database Instance

This table represents the SQL Database Instance resource from Google Cloud Platform.

gcp.sql_database_instance

Fields

ID	Type	Data Type	Description
_key	core	string
ancestors	core	array<string>
available_maintenance_versions	core	array<string>	Output only. List all maintenance versions applicable on the instance
backend_type	core	string	The backend type. `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. Possible values: ['SQL_BACKEND_TYPE_UNSPECIFIED', 'FIRST_GEN', 'SECOND_GEN', 'EXTERNAL']. Values descriptions: ['This is an unknown backend type for instance.', 'V1 speckle instance.', 'V2 speckle instance.', 'On premises instance.']
clear_network	core	bool	Clears private network settings when the instance is restored.
connection_name	core	string	Connection name of the Cloud SQL instance used in connection strings.
create_time	core	timestamp	Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
current_disk_size	core	int64	The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details.
database_installed_version	core	string	Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`.
database_version	core	string	The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. Possible values: ['SQL_DATABASE_VERSION_UNSPECIFIED', 'MYSQL_5_1', 'MYSQL_5_5', 'MYSQL_5_6', 'MYSQL_5_7', 'MYSQL_8_0', 'MYSQL_8_0_18', 'MYSQL_8_0_26', 'MYSQL_8_0_27', 'MYSQL_8_0_28', 'MYSQL_8_0_29', 'MYSQL_8_0_30', 'MYSQL_8_0_31', 'MYSQL_8_0_32', 'MYSQL_8_0_33', 'MYSQL_8_0_34', 'MYSQL_8_0_35', 'MYSQL_8_0_36', 'MYSQL_8_0_37', 'MYSQL_8_0_39', 'MYSQL_8_0_40', 'MYSQL_8_0_41', 'MYSQL_8_0_42', 'MYSQL_8_0_43', 'MYSQL_8_0_44', 'MYSQL_8_0_45', 'MYSQL_8_0_46', 'MYSQL_8_4', 'SQLSERVER_2017_STANDARD', 'SQLSERVER_2017_ENTERPRISE', 'SQLSERVER_2017_EXPRESS', 'SQLSERVER_2017_WEB', 'POSTGRES_9_6', 'POSTGRES_10', 'POSTGRES_11', 'POSTGRES_12', 'POSTGRES_13', 'POSTGRES_14', 'POSTGRES_15', 'POSTGRES_16', 'POSTGRES_17', 'SQLSERVER_2019_STANDARD', 'SQLSERVER_2019_ENTERPRISE', 'SQLSERVER_2019_EXPRESS', 'SQLSERVER_2019_WEB', 'SQLSERVER_2022_STANDARD', 'SQLSERVER_2022_ENTERPRISE', 'SQLSERVER_2022_EXPRESS', 'SQLSERVER_2022_WEB']. Values descriptions: ['This is an unknown database version.', 'The database version is MySQL 5.1.', 'The database version is MySQL 5.5.', 'The database version is MySQL 5.6.', 'The database version is MySQL 5.7.', 'The database version is MySQL 8.', 'The database major version is MySQL 8.0 and the minor version is 18.', 'The database major version is MySQL 8.0 and the minor version is 26.', 'The database major version is MySQL 8.0 and the minor version is 27.', 'The database major version is MySQL 8.0 and the minor version is 28.', 'The database major version is MySQL 8.0 and the minor version is 29.', 'The database major version is MySQL 8.0 and the minor version is 30.', 'The database major version is MySQL 8.0 and the minor version is 31.', 'The database major version is MySQL 8.0 and the minor version is 32.', 'The database major version is MySQL 8.0 and the minor version is 33.', 'The database major version is MySQL 8.0 and the minor version is 34.', 'The database major version is MySQL 8.0 and the minor version is 35.', 'The database major version is MySQL 8.0 and the minor version is 36.', 'The database major version is MySQL 8.0 and the minor version is 37.', 'The database major version is MySQL 8.0 and the minor version is 39.', 'The database major version is MySQL 8.0 and the minor version is 40.', 'The database major version is MySQL 8.0 and the minor version is 41.', 'The database major version is MySQL 8.0 and the minor version is 42.', 'The database major version is MySQL 8.0 and the minor version is 43.', 'The database major version is MySQL 8.0 and the minor version is 44.', 'The database major version is MySQL 8.0 and the minor version is 45.', 'The database major version is MySQL 8.0 and the minor version is 46.', 'The database version is MySQL 8.4.', 'The database version is SQL Server 2017 Standard.', 'The database version is SQL Server 2017 Enterprise.', 'The database version is SQL Server 2017 Express.', 'The database version is SQL Server 2017 Web.', 'The database version is PostgreSQL 9.6.', 'The database version is PostgreSQL 10.', 'The database version is PostgreSQL 11.', 'The database version is PostgreSQL 12.', 'The database version is PostgreSQL 13.', 'The database version is PostgreSQL 14.', 'The database version is PostgreSQL 15.', 'The database version is PostgreSQL 16.', 'The database version is PostgreSQL 17.', 'The database version is SQL Server 2019 Standard.', 'The database version is SQL Server 2019 Enterprise.', 'The database version is SQL Server 2019 Express.', 'The database version is SQL Server 2019 Web.', 'The database version is SQL Server 2022 Standard.', 'The database version is SQL Server 2022 Enterprise.', 'The database version is SQL Server 2022 Express.', 'The database version is SQL Server 2022 Web.']
datadog_display_name	core	string
disk_encryption_configuration	core	json	Disk encryption configuration specific to an instance.
disk_encryption_status	core	json	Disk encryption status specific to an instance.
dns_name	core	string	Output only. The dns name of the instance.
dns_names	core	json	Output only. The list of DNS names used by this instance.
etag	core	string	This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead.
failover_replica	core	json	The name and status of the failover replica.
gce_zone	core	string	The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.
gemini_config	core	json	Gemini instance configuration.
include_replicas_for_major_version_upgrade	core	bool	Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated.
instance_type	core	string	The instance type. Possible values: ['SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE', 'READ_REPLICA_INSTANCE', 'READ_POOL_INSTANCE']. Values descriptions: ['This is an unknown Cloud SQL instance type.', 'A regular Cloud SQL instance that is not replicating from a primary instance.', "An instance running on the customer's premises that is not managed by Cloud SQL.", 'A Cloud SQL instance acting as a read-replica.', 'A Cloud SQL read pool.']
ip_addresses	core	json	The assigned IP addresses for the instance.
ipv6_address	core	string	The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
kind	core	string	This is always `sql#instance`.
labels	core	array<string>
maintenance_version	core	string	The current software version on the instance.
master_instance_name	core	string	The name of the instance which will act as primary in the replication setup.
max_disk_size	core	int64	The maximum disk size of the instance in bytes.
name	core	string	Name of the Cloud SQL instance. This does not include the project ID.
node_count	core	int64	The number of read pool nodes in a read pool.
nodes	core	json	Output only. Entries containing information about each read pool node of the read pool.
on_premises_configuration	core	json	Configuration specific to on-premises instances.
organization_id	core	string
out_of_disk_report	core	json	This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
parent	core	string
primary_dns_name	core	string	Output only. DEPRECATED: please use write_endpoint instead.
project	core	string	The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
project_id	core	string
project_number	core	string
psc_service_attachment_link	core	string	Output only. The link to service attachment of PSC instance.
region	core	string	The geographical region of the Cloud SQL instance. It can be one of the [regions](https://cloud.google.com/sql/docs/mysql/locations#location-r) where Cloud SQL operates: For example, `asia-east1`, `europe-west1`, and `us-central1`. The default value is `us-central1`.
replica_configuration	core	json	Configuration specific to failover replicas and read replicas.
replica_names	core	array<string>	The replicas of the instance.
replication_cluster	core	json	A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Applicable to MySQL and PostgreSQL.
resource_name	core	string
satisfies_pzi	core	bool	Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use.
satisfies_pzs	core	bool	This status indicates whether the instance satisfies PZS. The status is reserved for future use.
scheduled_maintenance	core	json	The start time of any upcoming scheduled maintenance for this instance.
secondary_gce_zone	core	string	The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone.
self_link	core	string	The URI of this resource.
server_ca_cert	core	json	SSL configuration.
service_account_email_address	core	string	The service account email address assigned to the instance. \This property is read-only.
settings	core	json	The user settings.
sql_network_architecture	core	string	The SQL network architecture for the instance. Possible values: ['SQL_NETWORK_ARCHITECTURE_UNSPECIFIED', 'NEW_NETWORK_ARCHITECTURE', 'OLD_NETWORK_ARCHITECTURE']. Values descriptions: ['', 'The instance uses the new network architecture.', 'The instance uses the old network architecture.']
state	core	string	The current serving state of the Cloud SQL instance. Possible values: ['SQL_INSTANCE_STATE_UNSPECIFIED', 'RUNNABLE', 'SUSPENDED', 'PENDING_DELETE', 'PENDING_CREATE', 'MAINTENANCE', 'FAILED', 'ONLINE_MAINTENANCE', 'REPAIRING']. Values descriptions: ['The state of the instance is unknown.', 'The instance is running, or has been stopped by owner.', 'The instance is not available, for example due to problems with billing.', 'The instance is being deleted.', 'The instance is being created.', 'The instance is down for maintenance.', 'The creation of the instance failed or a fatal error occurred during maintenance.', 'Deprecated', '(Applicable to read pool nodes only.) The read pool node needs to be repaired. The database might be unavailable.']
suspension_reason	core	array<string>	If the instance state is SUSPENDED, the reason for the suspension.
switch_transaction_logs_to_cloud_storage_enabled	core	bool	Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.
tags	core	hstore
upgradable_database_versions	core	json	Output only. All database versions that are available for upgrade.
write_endpoint	core	string	Output only. The dns name of the primary instance in a replication group.