This repository has been archived on 2025-03-19. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file

Contributors Forks Stargazers Issues MIT License


Logo

MySQL Toolkit

About The Project

This is a small project for quickly managing a MySQL database in Java. It makes everyday life with a database much easier.

Installation

  1. Add the jitpack repository to your pom.xml
    <repositories>
       <repository>
          <id>jitpack.io</id>
          <url>https://jitpack.io</url>
       </repository>
    </repositories>
    
  2. Add the dependency to your pom.xml
    <dependency>
         <groupId>com.github.gnmyt</groupId>
         <artifactId>sqltoolkit</artifactId>
         <version>master-SNAPSHOT</version>
    </dependency>
    

Usage Examples

  1. Create a connection
    • Example of a constructor without optional specifications
    MySQLConnection connection = new MySQLConnection(hostname, username, password, database).connect();
    
    • Example of a constructor with optional login parameters
    MySQLConnection connection = new MySQLConnection(hostname, username, password, database, LoginParam.AUTO_RECONNECT, LoginParam.NO_SSL).connect();
    

    Login Parameters

    • DEFAULT (useSSL=false&autoReconnect=true&useUnicode=yes&characterEncoding=UTF-8&useTimezone=true&serverTimezone=UTC)
    • NO_SSL (useSSL=false)
    • USE_SSL (useSSL=true)
    • AUTO_RECONNECT (autoReconnect=true)
    • UTF8_ENCODING (characterEncoding=UTF-8)
    • USE_UNICODE (useUnicode=yes)
    • USE_TIMEZONE (useTimezone=true)
    • TIMEZONE_UTC (serverTimezone=UTC)
  2. Perform a standard SQL query
    • Get a ResultSet
      connection.getResultSet("default query", "parameters");
      
    • Perform an update
      connection.update("query", "parameters");
      
  3. Get something from a table with managers
    1. Getting a Result (For one result)
      String value = connection.getResult("query", "parameters")
                               .getString("column");
      
    2. Getting Results (For more than one)
      ArrayList<String> list = connection.getResult("query", "parameters")
                                         .getList("column");
      
    3. Choosing Results
      connection
            .selectFrom("table")
            .where("column", "value")
            .limit(10)
            .getResult();
      
    4. Choosing Results + Print the current statement
      connection.select()
             .from("table")
             .where("column", "value")
             .add("LIMIT 2,5")
             .printStatement();
      
  4. Perform an update using managers
    1. Update a Table
      connection
            .update()
            .toTable("table")
            .where("column", "value")
            .set("column", "newValue")
            .update();
      
    2. Generate a Table
      connection
            .update()
            .generateTable("table")
            .useID()
            .addField(new SQLField(SQLType.STRING, "column", 999))
            .addField(new SQLField(SQLType.STRING, "column2", 25))
            .create();
      

License

Distributed under the MIT License. See LICENSE for more information.

End

Currently there are not many features yet, so feel free to write me some suggestions!

Description
This is a small wrapper for quickly managing a MySQL database in Java. It makes everyday life with a database much easier.
Readme MIT 285 KiB
2021-11-21 01:53:18 +00:00
Languages
Java 100%