Documentation Home
MySQL Shell for VS Code


MySQL Shell for VS Code  /  ...  /  Dba Methods in AdminAPI

Pre-General Availability: 2023-01-18

5.6.1 Dba Methods in AdminAPI

The following section provides details of the options available for Dba class methods.

Dba Class Method Description
check_instance_configuration() Validates an instance for InnoDB ClusterSet, ReplicaSet or Cluster usage.
configure_instance() Validates and configures an instance for InnoDB ClusterSet, ReplicaSet or Cluster usage.
configure_local_instance() Validates and configures a local instance for InnoDB ClusterSet, ReplicaSet or Cluster usage.
configure_replica_set_instance() Validates and configures an instance for use in an InnoDB ReplicaSet.
create_cluster() Creates an InnoDB Cluster.
create_replica_set() Creates an InnoDB ReplicaSet.
delete_sandbox_instance() Deletes an existing MySQL Server instance on localhost.
deploy_sandbox_instance() Creates a new MySQL Server instance on localhost.
drop_metadata_schema() Drops the Metadata Schema.
get_cluster() Retrieves an InnoDB Cluster from the Metadata Store.
get_cluster_set() Returns an object representing an InnoDB ClusterSet.
get_replica_set() Returns an object representing an InnoDB ReplicaSet.
help() Provides help about the defined object and it’s members.
kill_sandbox_instance() Kills a running MySQL Server instance on localhost.
reboot_cluster_from_complete_outage() Brings an InnoDB Cluster back online when all members are offline.
start_sandbox_instance Starts an existing MySQL Server instance on localhost.
stop_sandbox_instance() Stops a running MySQL Server instance on localhost.
upgrade_metadata() Upgrades (or restores) the metadata to the version supported by MySQL Shell.

For general information about the AdminAPI issue: ? AdminAPI.

For help on a specific method issue: ? dba.<methodName>.