Database Utils

Database Utils

🔎 Пояснения

Этот мод включает в себя утилиты для работы с базами данных.
Самые популярные коннекторы включены прямо в JAR мода, что избавляет от необходимости импортировать их в каждый мод и помогает уменьшить общий размер ваших проектов.
Чтобы импортировать эту библиотеку, добавьте следующее в ваш файл build.gradle.

repositories {
    maven { url "https://api.modrinth.com/maven" }
}

dependencies {
    implementation "maven.modrinth:database-utils:1.0.0"
}

🖥️ Использование

Конфигурацией управляет эта библиотека. При использовании следующей строки автоматически создаётся файл .properties (если его ещё нет) и загружается из папки config.

Config config = new Config(MOD_ID);

В этом примере файл будет называться MOD_ID.properties.
Вот пример файла конфигурации.

storage=postgres
host=127.0.0.1
port=5432
database=minecraft_db
user=user
password=password

Затем вам нужно определить свой собственный класс MyCustomDB, который расширяет DatabaseQueries.
Этот класс предназначен для хранения всех методов, связанных с SQL. В этом контексте вам доступны некоторые методы из DatabaseQueries, например getType, которые помогают создать реализацию, совместимую с несколькими базами данных.

public class MyCustomDB extends DatabaseQueries {

    public MyCustomDB(Database db) {
        super(db);
    }
    
    @Override
    public void init() {
        try (Connection connection = getConnection()) {
            /* ... */
        } catch (SQLException | DatabaseLinkException e) {
            LOGGER.error("Unable to initialize: {}", e.getMessage());
        }
    }
    
    /* other methods */
    
    public void someMethod() {
        /* ... */
    }
}

Вам также потребуется создать экземпляр базы данных. Здесь и используется объект Config. Следующий фрагмент кода извлекает базу данных, определённую в конфигурации, и инициализирует вашу реализацию DatabaseQueries.

Database database = DatabaseUtils.getDatabase(config);
MyCustomDB custom = new MyCustomDB(database);

Теперь вы можете вызывать любой запрос, определённый в вашей реализации DatabaseQueries, через ваш экземпляр custom.

custom.someMethod();