Package io.quarkus.agroal.runtime.dev.ui

Class DatabaseInspector

java.lang.Object

io.quarkus.agroal.runtime.dev.ui.DatabaseInspector

public final class DatabaseInspector
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final record	DatabaseInspector.EnglishToSQLResponse
(package private) static final record	DatabaseInspector.InsertStatementResponse

Field Summary

Fields

Modifier and Type	Field	Description
(package private) jakarta.enterprise.inject.Instance<io.quarkus.agroal.runtime.AgroalDataSourceSupport>	agroalDataSourceSupports
(package private) Optional<io.quarkus.assistant.runtime.dev.Assistant>	assistant

Constructor Summary

Constructors

Constructor	Description
DatabaseInspector()

Method Summary

Modifier and Type	Method	Description
CompletionStage<Map<String,String>>	englishToSQL(String datasource, String schema, String name, String english)
io.quarkus.agroal.runtime.dev.ui.DatabaseInspector.DataSet	executeSQL(String datasource, String sql, Integer pageNumber, Integer pageSize)
String	generateDot(String datasource)
CompletionStage<Map<String,String>>	generateTableData(String datasource, String schema, String name, int rowCount)
List<io.quarkus.agroal.runtime.dev.ui.DatabaseInspector.Datasource>	getDataSources()
String	getInsertScript(String datasource)
List<io.quarkus.agroal.runtime.dev.ui.DatabaseInspector.Table>	getTables(String datasource)
protected void	init()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

agroalDataSourceSupports

@Inject
jakarta.enterprise.inject.Instance<io.quarkus.agroal.runtime.AgroalDataSourceSupport> agroalDataSourceSupports

assistant

@Inject
Optional<io.quarkus.assistant.runtime.dev.Assistant> assistant

Constructor Details

DatabaseInspector

public DatabaseInspector()

Method Details

init

@PostConstruct
protected void init()

getDataSources

@JsonRpcDescription("Get all available datasources for the Database")
@DevMCPEnableByDefault
public List<io.quarkus.agroal.runtime.dev.ui.DatabaseInspector.Datasource> getDataSources()

getTables

@JsonRpcDescription("Get all the tables for a certain datasource")
@DevMCPEnableByDefault
public List<io.quarkus.agroal.runtime.dev.ui.DatabaseInspector.Table> getTables(@JsonRpcDescription("Datasource name")
 String datasource)

generateDot

@JsonRpcDescription("Generate an ER Diagram in dot (graphviz) format for a certain datasource")
public String generateDot(@JsonRpcDescription("Datasource name")
 String datasource)

executeSQL

@JsonRpcDescription("Execute SQL against a certain datasource")
@DevMCPEnableByDefault
public io.quarkus.agroal.runtime.dev.ui.DatabaseInspector.DataSet executeSQL(@JsonRpcDescription("Datasource name")
 String datasource,
 @JsonRpcDescription("Valid SQL to execute")
 String sql,
 @JsonRpcDescription("Page number for pagable rusults, starting at 1")
 Integer pageNumber,
 @JsonRpcDescription("Number of rows in a page, example 10")
 Integer pageSize)

getInsertScript

@JsonRpcDescription("Get the import.sql script for a certain datasource")
public String getInsertScript(@JsonRpcDescription("Datasource name")
 String datasource)

generateTableData

public CompletionStage<Map<String,String>> generateTableData(String datasource,
 String schema,
 String name,
 int rowCount)

englishToSQL

public CompletionStage<Map<String,String>> englishToSQL(String datasource,
 String schema,
 String name,
 String english)