Interface DatasourceMeta
-
- All Known Subinterfaces:
Datasource
- All Known Implementing Classes:
SerializableDatasourceMeta
public interface DatasourceMeta
Describes an Ignition datasource, including its current status, query workload, etc.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getActiveConnections()
Returns the current number of connections in usejava.util.List<ActiveQuery>
getActiveQueries()
A snapshot of the currently executing queries for this datasourcejava.lang.String
getDescription()
DatasourceStatus
getExtendedStatus()
Returns the "best" status of this datasource or of any failover datasources.DatasourceFailoverMode
getFailoverMode()
Returns the behavioral failover mode for this datasourceint
getMaxConnections()
Returns the maximum number of connections the underlying pool is configured to use.java.lang.String
getName()
java.lang.String
getProblemDescription()
A string describing the current problem, if the status is not goodStatMetric
getStatistics()
A StatMetric that tracks the overall query throughput for this datasourceDatasourceStatus
getStatus()
Returns the Status of this datasource based on its last tested conditionjava.lang.String
getValidationQuery()
Returns a SQL query that will be used to validate the status of this datasource.DatabaseVendor
getVendor()
-
-
-
Method Detail
-
getName
java.lang.String getName()
- Returns:
- the name of this datasource
-
getDescription
java.lang.String getDescription()
- Returns:
- the description for this datasource
-
getVendor
DatabaseVendor getVendor()
- Returns:
- the database type that this connection's driver is connecting to
-
getStatus
DatasourceStatus getStatus()
Returns the Status of this datasource based on its last tested condition
-
getProblemDescription
java.lang.String getProblemDescription()
A string describing the current problem, if the status is not good
-
getExtendedStatus
DatasourceStatus getExtendedStatus()
Returns the "best" status of this datasource or of any failover datasources. This is a better indicator of whether or not getConnection() will succeed
-
getFailoverMode
DatasourceFailoverMode getFailoverMode()
Returns the behavioral failover mode for this datasource
-
getStatistics
StatMetric getStatistics()
A StatMetric that tracks the overall query throughput for this datasource
-
getMaxConnections
int getMaxConnections()
Returns the maximum number of connections the underlying pool is configured to use.
-
getActiveConnections
int getActiveConnections()
Returns the current number of connections in use
-
getValidationQuery
java.lang.String getValidationQuery()
Returns a SQL query that will be used to validate the status of this datasource. This query should always return at least 1 row.
-
getActiveQueries
java.util.List<ActiveQuery> getActiveQueries()
A snapshot of the currently executing queries for this datasource
-
-