codemc-api/io.codemc.api.database

Package-level declarations

Types

DBConfig

data class DBConfig(val url: String, val username: String, val password: String)

The MariaDB configuration.

Request

data class Request(val messageId: Long, val userId: Long, val githubName: String, val repoName: String)

Represents a request in the database.

Requests

object Requests : Table

Represents the requests SQL table.

User

data class User(val username: String, val discord: Long)

Represents a user in the database.

Users

object Users : Table

Represents the users SQL table.

Properties

database

lateinit var database: Database

Represents the database connection.

dbConfig

var dbConfig: DBConfig

The DBConfig instance.

Functions

addUser

fun addUser(username: String, discord: Long): InsertStatement<Number>

Adds a user to the database.

connect

fun connect(): Database

Attempts to connect to the database.

createRequest

fun createRequest(messageId: Long, userId: Long, githubName: String, repoName: String): InsertStatement<Number>

Adds a request to the database.

getAllRequests

fun getAllRequests(): List<Request>

Gets all requests currently linked in the database.

getAllUsers

fun getAllUsers(): List<User>

Gets all users currently linked in the database.

getRequest

fun getRequest(messageId: Long): Request?

Gets a Request by its unique ID.

getUser

fun getUser(username: String): User?

Gets a User by its jenkins username.

removeAllRequests

fun removeAllRequests(): Int

Removes all requests from the database.

removeAllUsers

fun removeAllUsers(): Int

Removes all users from the database.

removeRequest

fun removeRequest(messageId: Long): Int

Removes a request from the database.

removeUser

fun removeUser(username: String): Int

Removes a user from the database.

requestExists

fun requestExists(messageId: Long): Boolean

Checks if a request exists by its unique ID.

updateUser

fun updateUser(username: String, discord: Long): Int

Updates the user linked in the database.