Package com.github.collinalpert.java2db.database

Class DBConnection

  • All Implemented Interfaces:
    java.lang.AutoCloseable
    public class DBConnection
extends java.lang.Object
implements java.lang.AutoCloseable
    Author:
    Collin Alpert
    See Also:
    GitHub

    • Constructor Summary

      Constructors 
      Constructor Description
      DBConnection()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Closes the connection to the database.
      java.sql.ResultSet execute​(java.lang.String query)
      Executes a DQL statement on the database without Java parameters.
      java.sql.ResultSet execute​(java.lang.String query, java.lang.Object... params)
      Executes a DQL statement on the database with Java parameters.
      boolean isOpen()
      Determines if a connection to the database still exists or not.
      boolean isValid()
      Checks if the connection is valid/successful.
      void update​(java.lang.String query)
      This command is used for any DDL/DML queries.
      void update​(java.lang.String query, java.lang.Object... params)
      This command is used for any DDL/DML queries with Java parameters.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • HOST

        public static java.lang.String HOST

      • DATABASE

        public static java.lang.String DATABASE

      • USERNAME

        public static java.lang.String USERNAME

      • PASSWORD

        public static java.lang.String PASSWORD

      • PORT

        public static int PORT

      • LOG_QUERIES

        public static boolean LOG_QUERIES

    • Constructor Detail

      • DBConnection

        public DBConnection()

    • Method Detail

      • isValid

        public boolean isValid()
        Checks if the connection is valid/successful.
        Returns:
        True if connection was successful, false if not.

      • execute

        public java.sql.ResultSet execute​(java.lang.String query)
                           throws java.sql.SQLException
        Executes a DQL statement on the database without Java parameters.
        Parameters:
        query - The query to be executed.
        Returns:
        The ResultSet containing the result from the DQL statement.
        Throws:
        java.sql.SQLException - if the query is malformed or cannot be executed.

      • execute

        public java.sql.ResultSet execute​(java.lang.String query,
                                  java.lang.Object... params)
                           throws java.sql.SQLException
        Executes a DQL statement on the database with Java parameters.
        Parameters:
        query - The query to be executed.
        params - The Java parameters to be inserted into the query.
        Returns:
        The ResultSet containing the result from the DQL statement.
        Throws:
        java.sql.SQLException - if the query is malformed or cannot be executed.

      • update

        public void update​(java.lang.String query)
            throws java.sql.SQLException
        This command is used for any DDL/DML queries.
        Parameters:
        query - The query to be executed.
        Throws:
        java.sql.SQLException - if the query is malformed or cannot be executed.

      • update

        public void update​(java.lang.String query,
                   java.lang.Object... params)
            throws java.sql.SQLException
        This command is used for any DDL/DML queries with Java parameters.
        Parameters:
        query - The query to be executed.
        params - The Java parameters to be inserted into the query.
        Throws:
        java.sql.SQLException - if the query is malformed or cannot be executed.

      • isOpen

        public boolean isOpen()
        Determines if a connection to the database still exists or not.
        Returns:
        True if a connection exists, false if not. This method will return false if an exception occurs.

      • close

        public void close()
        Closes the connection to the database.
        Specified by:
        close in interface java.lang.AutoCloseable