Package net.solarnetwork.node.dao.jdbc

Interface DatabaseSystemService

public interface DatabaseSystemService
An API to expose system administration functions to the database. The implementation of these methods are most often database vendor specific, so this API provides a way for the SolarNode to access the information in a generic way.
Since:
1.19
Version:
1.0
Author:
matt

  • Method Summary

    Modifier and Type
    Method
    Description
    File[]
    getFileSystemRoots()
    Get a set of "root" directories the database stores files on.
    long
    tableFileSystemSize(String schemaName, String tableName)
    Get the size, in bytes, a specific database table consumes on disk.
    void
    vacuumTable(String schemaName, String tableName)
    Perform maintenance on a table, with the goal of freeing up resources that can be returned to the system.

  • Method Details

    • getFileSystemRoots

      File[] getFileSystemRoots()
      Get a set of "root" directories the database stores files on. This method aims to support discovering how much space is available for the database system on the file system(s) it uses.
      Returns:
      a list of directories

    • tableFileSystemSize

      long tableFileSystemSize(String schemaName, String tableName)
      Get the size, in bytes, a specific database table consumes on disk.
      Parameters:
      schemaName - the schema of the table
      tableName - the table name
      Returns:
      the size, in bytes, the table consumes on disk

    • vacuumTable

      void vacuumTable(String schemaName, String tableName)
      Perform maintenance on a table, with the goal of freeing up resources that can be returned to the system.
      Parameters:
      schemaName - the schema of the table
      tableName - the table name