Skip to content

Database Stats

Operations Summary

Method Endpoint Description
GET /api/database-stats/ Get database table statistics

Get database table statistics

Retrieves statistics about the database, including the top 10 largest tables by total size. This information is useful for monitoring and maintenance. Requires support user permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/database-stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.database_stats import database_stats_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = database_stats_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: database_stats_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { databaseStatsList } from 'waldur-js-client';

try {
  const response = await databaseStatsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
table_name string Name of the database table
total_size integer Total size of the table in bytes
data_size integer Size of the actual data in bytes
external_size integer Size of external data (e.g., TOAST) in bytes