databaseSize

Return the current database name and its total disk size.

read-onlyany connectionsweeps instancesweeps group

Synopsis

databaseSize()

Description

Return the current database name and its total disk size.

Parameters

None of its own.

Also accepts connection, instance, group, described once under arguments every tool takes.

Output

Size of the connected database. An absent extension or a missing grant is reported as {error, hint} instead.

FieldType
databasestring | null
sizeinteger | null

Scope

A physical replica is byte-identical here, so asking each member of a replication group adds nothing.

Example mocked data

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "databaseSize",
    "arguments": {
      "connection": "shop_prod"
    }
  }
}

Result

{
  "database": "shop",
  "size": 36120010752
}

Invented values on a fictional shop database, shaped by and checked against this tool's output schema. Real output is returned as structuredContent to clients that negotiate MCP 2025-06-18 or later.

See also

diskUsage, serverSettings, currentActivity, currentLocks, databaseStats, statementStats, wraparoundStatus, progressStats, ioStats, checkpointStats, tableIOStats, hostCapacity, bufferCacheSummary, bufferCacheContents