Package io.github.mrtesz.teszcore.api.db.manager

Interface SyncDBManager

All Superinterfaces:
Copyable<DBManager>, DBManager
All Known Implementing Classes:
MariaDBManager, SqliteManager
public interface SyncDBManager extends DBManager
Parent interface of all sync database managers

  • Method Details

    • createOrAlter

      void createOrAlter(@NotNull @NotNull DBTable dbTable) throws IllegalArgumentException
      Create a database table using a DBTable object, suitable for the DBManager (MariaDBManager: MariaDBTable SqliteManager: SqliteTable)
      Parameters:
      dbTable - Table that is created or altered
      Throws:
      IllegalArgumentException - when the dbTable param is not the suitable type for the DBManager

    • executeSql

      int executeSql(@NotNull @NotNull String sql, @NotNull @NotNull List<Object> sqlParams, @NotNull @NotNull String tableName, @Nullable @Nullable String type)
      Execute a SQL query with a List replacing the question marks in the sql
      e.g.:
      executeSql("UPDATE users SET name = ? WHERE id = ?", List.of(username, userId), "users", "update username");
      Parameters:
      sql - Query that should be executed
      sqlParams - Values replacing the ?'s in the sql query
      tableName - Name of the table, querying to
      type - Type of execution
      Returns:
      Return value of the PreparedStatement.executeUpdate()

    • executeSql

      int executeSql(@NotNull @NotNull String sql, String tableName, String type)
      Execute a SQL query
      e.g.:
      executeSql("UPDATE users SET name = " + username + " WHERE id = " + userId, "users", "update username");
      Parameters:
      sql - Query that should be executed
      tableName - Name of the table, querying to
      type - Type of execution
      Returns:
      Return value of PreparedStatement.executeUpdate()

    • executeBatchSql

      @Deprecated default int[] executeBatchSql(@NotNull @NotNull List<BatchSqlStatement> sqlStatements, @NotNull @NotNull String tableName) throws IllegalArgumentException
      Deprecated.
      use executeBatchSql(BatchSqlStatements, String) instead
      Executes multiple SQL statements with the same structure in batch mode for better performance
      e.g.:
      executeBatchSql(batchStatementList, "users", "batch update");
      Parameters:
      sqlStatements - List of SQL statements with their parameters
      tableName - Name of the table, querying to
      Returns:
      Return value of Statement.executeBatch()
      Throws:
      IllegalArgumentException - if the SQL statements are not the same structure

    • executeBatchSql

      default int[] executeBatchSql(@NotNull @NotNull BatchSqlStatements sqlStatements, @NotNull @NotNull String tableName)
      Executes multiple SQL statements with the same structure in batch mode for better performance
      e.g.:
      executeBatchSql(batchStatementList, "users", "batch update");
      Parameters:
      sqlStatements - List of SQL statements with their parameters
      tableName - Name of the table, querying to
      Returns:
      Return value of Statement.executeBatch()

    • executeSelect

      SelectionResults executeSelect(@NotNull @NotNull String sql, @NotNull @NotNull List<Object> sqlParams, @NotNull @NotNull String tableName)
      Execute a selection query with a List replacing the question marks in the sql
      e.g.
      executeSelect("SELECT email, number FROM users WHERE username = ?", List.of("Mr_Tesz"), "users");
      Parameters:
      sql - Sql query
      sqlParams - Values replacing the ?'s in the sql query
      tableName - Name of the table, to select from
      Returns:
      SelectionResults object representing the result

    • executeSelect

      SelectionResults executeSelect(@NotNull @NotNull String sql, @NotNull @NotNull String tableName)
      Execute a selection query
      e.g.
      executeSelect("SELECT email, number FROM users WHERE username = Mr_Tesz", "users");
      Parameters:
      sql - Sql query
      tableName - Name of the table, to select from
      Returns:
      SelectionResults object representing the result

    • insertInto

      int insertInto(@NotNull @NotNull String tableName, @NotNull @NotNull Map<String,Object> values)
      Insert into a table
      e.g.:
      Map<String, Object> values = new HashMapinvalid input: '<'>();
      values.put("id", userId);
      values.put("name", username);
      dbManager.insertInto("users", values);
      Parameters:
      tableName - Name of the table, inserting into
      values - Values to insert
      Returns:
      Return value of PreparedStatement.executeUpdate()

    • insertIgnore

      int insertIgnore(@NotNull @NotNull String tableName, @NotNull @NotNull Map<String,Object> values)
      Insert into a table ignoring when a unique is duplicated
      e.g.:
      Map<String, Object> values = new HashMapinvalid input: '<'>();
      values.put("id", userId);
      values.put("name", username);
      dbManager.insertInto("users", values);
      Parameters:
      tableName - Name of the table, inserting into
      values - Values to insert
      Returns:
      Return value of PreparedStatement.executeUpdate()

    • deleteFrom

      int deleteFrom(@NotNull @NotNull String tableName, @Nullable @Nullable String whereClause, @NotNull @NotNull List<Object> whereParams)
      Delete entries with a List replacing the question marks in the whereClause e.g.:
      deleteFrom("users", "userId = ?", List.of(userId));
      Parameters:
      tableName - Name of the table, deleting from
      whereClause - Clause, narrowing the targeted columns
      whereParams - Values replacing the ?'s in the whereClause
      Returns:
      Number of rows affected

    • deleteFrom

      int deleteFrom(@NotNull @NotNull String tableName, @Nullable @Nullable String whereClause)
      Delete entries e.g.:
      deleteFrom("users", "userId = " + userId);
      Parameters:
      tableName - Table name
      whereClause - WHERE clause
      Returns:
      Number of rows affected

    • update

      int update(@NotNull @NotNull String tableName, @NotNull @NotNull Map<String,Object> values, @Nullable @Nullable String whereClause, @NotNull @NotNull List<Object> whereParams)
      Update a table with a List replacing the question marks in the whereClause
      e.g.:
      Map<String, Object> values = new HashMapinvalid input: '<'>();
      values.put("name", username);
      update("users", values, "id = ?", List.of(userId);
      Parameters:
      tableName - Name of the table, updating
      values - Values to update
      whereClause - Clause, narrowing the targeted columns
      whereParams - Values replacing the ?'s in the whereClause
      Returns:
      Number of rows affected

    • update

      int update(@NotNull @NotNull String tableName, @NotNull @NotNull Map<String,Object> values, @Nullable @Nullable String whereClause)
      Update a table
      e.g.:
      Map<String, Object> values = new HashMapinvalid input: '<'>();
      values.put("name", username);
      update("users", values, "id = " + userId);
      Parameters:
      tableName - Name of the table, updating
      values - Values to update
      whereClause - Clause, narrowing the targeted columns
      Returns:
      Number of rows affected

    • dropTable

      int dropTable(@NotNull @NotNull String tableName)
      Drop a table from the database e.g.:
      dropTable("current-weak-save");
      Parameters:
      tableName - Name of the table to drop
      Returns:
      Return value of PreparedStatement.executeUpdate()

    • columnExists

      boolean columnExists(@NotNull @NotNull String tableName, @NotNull @NotNull String columnName)
      Show if a column exists in a table
      Parameters:
      tableName - Name of the table, checking
      columnName - Name of the column to be checked
      Returns:
      true if the column exists

    • indexExists

      boolean indexExists(@NotNull @NotNull String tableName, @NotNull @NotNull String indexName)
      Show if an index exists in a table
      Parameters:
      tableName - Name of the table, checking
      indexName - Name of the index to be checked
      Returns:
      true if the index exists