Skip to content

0.2.0

Compare
Choose a tag to compare
@Oreoxmt Oreoxmt released this 12 Sep 10:14
· 59 commits to main since this release
2d940eb

⚠️ Note: tidbcloudy 0.2.0 has been yanked due to a bug.

Release on Aug 14, 2022

What's Changed

Support using tidbcloudy to access TiDB Cloud and manage restores by @Oreoxmt in #1

How to manage your projects?

  • To get a project by its id, you can use the TiDBCloud().get_project(project_id="your_project_id", update_from_server=True) method.
  • To list/iter all projects in your organization, you can use the TiDBCloud().list_projects() or TiDBCloud().iter_projects() method.

How to manage your clusters?

  • To list available cloud providers, regions, and specifications, you can use the TiDBCloud().list_provider_regions() method.
  • To create a cluster, you can use the Project().create_cluster(config=config) method.
  • To modify a cluster, you can use the Cluster().update() or Project().update_cluster(cluster_id=cluster_id, config=config) method.
  • To get a cluster by its id, you can use the `` or Project().get_cluster(cluster_id=cluster_id) method.
  • To list/iter all clusters in a specified project, you can use the Project().list_clusters(), or Project().iter_clusters() method.
  • To connect with your TiDB, you can use the Cluster().connect(type=type, database=database, password=password) method.
  • To delete a cluster by its id, you can use the Cluster().delete() or Project().delete_cluster(cluster_id=cluster_id) method.

How to manage your backups?

  • To create a backup task, you can use the Cluster().create_backup(name=name) method.
  • To get a backup task by its id, you can use the Cluster().get_backup(backup_id=backup_id) method.
  • To list/iter all backup tasks of a specified cluster, you can use the Cluster().list_backups() or Cluster().iter_backup() method.
  • To delete a backup task by its id, you can use the Backup().delete() or Cluster().delete_backup(backup_id=backup_id) method.

How to manage your restores?

  • To create a restore task, you can use the Project().create_restore(name=name, backup_id=backup_id, cluster_config=cluster_config) method.
  • To **get **a restore task by its id, you can use the Project().get_restore(restore_id=restore_id) method.
  • To list/iter all restore tasks in a specified project, you can use the Project().list_restores() or Project().iter_restores() method.

Full Changelog: ...v0.2.0