action/cloudflare/tidb_data_service_api library

Classes

TidbCloudManagementApi

Minimal Digest-authenticated client for TiDB Cloud management APIs.

TidbDataServiceApi

Contract used by TiDB Data Service management operations.

TidbEndpointOwnershipState

Last successfully deployed TiDB endpoints for the current project.

TidbManagedEndpointOwnership

A TiDB Data Service endpoint owned by the current Katana project.

Functions

callTidbDataEndpoint({required String region, required String appId, required String path, required String publicKey, required String privateKey, String method = "GET", Map<String, String>? query, Object? body}) → Future<Map<String, dynamic>>

Calls a deployed Data Service endpoint with Digest authentication.

deleteTidbDataServiceEndpointAndWait(TidbDataServiceApi api, {required String appId, required String endpointName, Duration pollInterval = const Duration(seconds: 2), int maxAttempts = 30}) → Future<void>

Deletes one endpoint and waits for its automatic deployment to finish.

listTidbDataServicePages(TidbCloudManagementApi api, String path, String listKey) → Future<List<Map<String, dynamic>>>

Lists every page from a TiDB Data Service collection.

retryTidbDataEndpointUntilDeployed(Future<Map<String, dynamic>> call(), {Duration pollInterval = const Duration(seconds: 2), int maxAttempts = 10}) → Future<Map<String, dynamic>>

Retries a newly deployed endpoint while TiDB propagates the deployment.