Package-level declarations

Types

Link copied to clipboard
@Serializable
data class Database(val id: DatabaseId, val domain: String, val name: String, val version: String)

Database object.

Link copied to clipboard
Link copied to clipboard
typealias DatabaseId = String

Unique identifier of Database object.

Official doc

Link copied to clipboard
@Serializable
object DisableResponse

A dummy response object for the DatabaseDomain.disable command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable
object EnableResponse

A dummy response object for the DatabaseDomain.enable command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable
data class Error(val message: String, val code: Int)

Database error.

Link copied to clipboard
@Serializable
data class ExecuteSQLRequest(val databaseId: DatabaseId, val query: String)

Request object containing input parameters for the DatabaseDomain.executeSQL command.

Link copied to clipboard
@Serializable
data class ExecuteSQLResponse(val columnNames: List<String>? = null, val values: List<JsonElement>? = null, val sqlError: Error? = null)

Response type for the DatabaseDomain.executeSQL command.

Link copied to clipboard
@Serializable
data class GetDatabaseTableNamesRequest(val databaseId: DatabaseId)

Request object containing input parameters for the DatabaseDomain.getDatabaseTableNames command.

Link copied to clipboard
@Serializable
data class GetDatabaseTableNamesResponse(val tableNames: List<String>)

Response type for the DatabaseDomain.getDatabaseTableNames command.