├── LICENSE
├── README.md
└── me
└── wixi
├── database
├── Database.java
├── DatabaseContainer.java
└── types
│ ├── MySQLDatabase.java
│ └── SQLiteDatabase.java
└── managers
└── DatabaseManager.java
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # DatabaseAPI
2 | A simple MySQL and SQLite database API for anyone whos frustrated with the sql's syntax for Minecraft plugins.
3 |
4 | ### Example Code:
5 | ```java
6 | // databaseManager have to only registered once.
7 | val databaseManager = new DatabaseManager();
8 |
9 | // here we create the table.
10 | databaseManager.createTable("Test", "name VARCHAR(40) NOT NULL, age INT DEFAULT 1");
11 |
12 | // we set the row if there isn't any matching with that unique id.
13 | // use DatabaseContainer to define the columns (no need to put the uniqueId)
14 | databaseManager.setIfAbsent("Test", new DatabaseContainer("name", "age"), player.getUniqueId(), "SomeonesName", 18);
15 | ```
16 |
17 | ## There are more. (DatabaseManager class)
18 |
19 | - Use ``prepareStatement()`` method, to prepare any statement of choice.
20 | - Use ``createTable()`` method, to create a table.
21 | - Use ``update()`` method, to update existing row in database table.
22 | - Use ``exists()`` method, to check if a row exists.
23 | - Use ``delete()`` method, to delete a row with maching uniqueId.
24 | - Use ``get()`` method, to get a row.
25 | - Use ``setIfAbsent()`` method, to set a row if it doesn't exist.
26 |
27 | ## How to use
28 | Add repository and dependencies to maven.
29 | ```xml
30 |
31 |
32 |
33 | jitpack.io
34 | https://jitpack.io
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 | com.github.WixiDev
44 | DatabaseAPI
45 | LATEST_COMMIT_TAG
46 |
47 |
48 |
49 |
50 | org.projectlombok
51 | lombok
52 | 1.18.28
53 | provided
54 |
55 |
56 |
57 |
58 | mysql
59 | mysql-connector-java
60 | 8.0.33
61 | provided
62 |
63 |
64 |
65 | ```
66 |
67 | ## Pro TIP:
68 | Use [SQLite Viewer App](https://sqliteviewer.app/) to see your rows and tables. It's free!
69 |
70 | #### Was it helpful? consider giving a star!
71 |
--------------------------------------------------------------------------------
/me/wixi/database/Database.java:
--------------------------------------------------------------------------------
1 | package me.wixi.database;
2 |
3 | import lombok.Getter;
4 | import lombok.Setter;
5 | import lombok.SneakyThrows;
6 |
7 | import java.sql.Connection;
8 |
9 | public abstract class Database {
10 |
11 | @Getter
12 | @Setter
13 | private Connection connection;
14 |
15 | public abstract void connect();
16 |
17 | @SneakyThrows
18 | public boolean isConnected() {
19 | return !(this.connection == null || this.connection.isClosed());
20 | }
21 |
22 | @SneakyThrows
23 | public void disconnect() {
24 | if (!isConnected()) return;
25 | this.connection.close();
26 | }
27 |
28 | }
--------------------------------------------------------------------------------
/me/wixi/database/DatabaseContainer.java:
--------------------------------------------------------------------------------
1 | package me.wixi.database;
2 |
3 | import java.util.Collections;
4 |
5 | public class DatabaseContainer {
6 |
7 | private final String[] strings;
8 |
9 | public DatabaseContainer(String... strings) {
10 | this.strings = strings;
11 | }
12 |
13 | public String getColumnsAndQuestionMarks() {
14 | return "(uniqueId, " + String.join(", ", this.strings) + ") VALUES (" + String.join(", ", Collections.nCopies(this.strings.length + 1, "?")) + ')';
15 | }
16 |
17 | }
--------------------------------------------------------------------------------
/me/wixi/database/types/MySQLDatabase.java:
--------------------------------------------------------------------------------
1 | package me.wixi.database.types;
2 |
3 | import me.wixi.database.Database;
4 | import lombok.AllArgsConstructor;
5 | import lombok.SneakyThrows;
6 | import lombok.val;
7 | import org.bukkit.plugin.java.JavaPlugin;
8 |
9 | import java.sql.DriverManager;
10 |
11 | @AllArgsConstructor
12 | public class MySQLDatabase extends Database {
13 |
14 | private final JavaPlugin plugin;
15 |
16 | @SneakyThrows
17 | @Override
18 | public void connect() {
19 |
20 | if (isConnected()) return;
21 |
22 | val logger = this.plugin.getLogger();
23 | val config = this.plugin.getConfig();
24 |
25 | try {
26 | setConnection(
27 | DriverManager.getConnection("jdbc:mysql://" + config.getString("database.host") + ":" + config.getInt("database.port") + "/"
28 | + config.getString("database.database-name"), config.getString("database.username"), config.getString("database.password"))
29 | );
30 | } catch (Exception exception) {
31 | logger.severe("[ERROR] Failed to connect to MySQL server. are the credentials correct?");
32 | this.plugin.getServer().getPluginManager().disablePlugin(this.plugin);
33 | return;
34 | }
35 |
36 | logger.info("[INFO] Successfully connected to MySQL.");
37 | }
38 |
39 | }
40 |
--------------------------------------------------------------------------------
/me/wixi/database/types/SQLiteDatabase.java:
--------------------------------------------------------------------------------
1 | package me.wixi.database.types;
2 |
3 | import me.wixi.database.Database;
4 | import lombok.AllArgsConstructor;
5 | import lombok.SneakyThrows;
6 | import lombok.val;
7 | import org.bukkit.plugin.java.JavaPlugin;
8 |
9 | import java.io.File;
10 | import java.sql.DriverManager;
11 |
12 | @AllArgsConstructor
13 | public class SQLiteDatabase extends Database {
14 |
15 | private final JavaPlugin plugin;
16 |
17 | @SneakyThrows
18 | @Override
19 | public void connect() {
20 |
21 | if (isConnected()) return;
22 |
23 | val logger = this.plugin.getLogger();
24 | val databaseFile = new File(this.plugin.getDataFolder(), "database.db");
25 |
26 | if (!databaseFile.exists())
27 | if (!databaseFile.createNewFile()) {
28 | logger.severe("[ERROR] Khata Dar Sakhtan File Database");
29 | this.plugin.getServer().getPluginManager().disablePlugin(this.plugin);
30 | return;
31 | }
32 |
33 | try {
34 | Class.forName("org.sqlite.JDBC");
35 |
36 | setConnection(
37 | DriverManager.getConnection("jdbc:sqlite:" + databaseFile)
38 | );
39 | } catch (ClassNotFoundException exception) {
40 | logger.severe("[ERROR] Failed to connect to SQLite server.");
41 | return;
42 | }
43 |
44 | logger.info("[INFO] Successfully connected to SQLite.");
45 | }
46 |
47 | }
48 |
--------------------------------------------------------------------------------
/me/wixi/managers/DatabaseManager.java:
--------------------------------------------------------------------------------
1 | package me.wixi.managers;
2 |
3 | import me.wixi.database.Database;
4 | import me.wixi.database.DatabaseContainer;
5 | import me.wixi.database.types.MySQLDatabase;
6 | import me.wixi.database.types.SQLiteDatabase;
7 | import lombok.Getter;
8 | import lombok.SneakyThrows;
9 | import lombok.val;
10 | import org.bukkit.plugin.java.JavaPlugin;
11 |
12 | import java.sql.PreparedStatement;
13 | import java.util.UUID;
14 |
15 | public class DatabaseManager {
16 |
17 | @Getter
18 | private final Database database;
19 | private final boolean mysql;
20 |
21 | public DatabaseManager(JavaPlugin plugin) {
22 | this.mysql = plugin.getConfig().getString("database.type").equalsIgnoreCase("MySQL");
23 | this.database = this.mysql ? new MySQLDatabase(plugin) : new SQLiteDatabase(plugin);
24 | this.database.connect();
25 | }
26 |
27 | @SneakyThrows
28 | public PreparedStatement prepareStatement(String sql, Object... objectsToSet) {
29 | val statement = this.database.getConnection().prepareStatement(sql);
30 | for (int i = 0; i < objectsToSet.length; i++) statement.setObject(i + 1, objectsToSet[i]);
31 | return statement;
32 | }
33 |
34 | @SneakyThrows
35 | public void createTable(String tableName, String columns) {
36 | val id = this.mysql ? "id INT AUTO_INCREMENT PRIMARY KEY" : "id INTEGER PRIMARY KEY AUTOINCREMENT";
37 | val query = "CREATE TABLE IF NOT EXISTS " + tableName + "(" + id + ", uniqueId VARCHAR(36) NOT NULL, " + columns + ")";
38 | val statement = prepareStatement(query);
39 |
40 | statement.executeUpdate();
41 | statement.close();
42 | }
43 |
44 | @SneakyThrows
45 | public boolean exists(String table, UUID uniqueId) {
46 | val query = "SELECT * FROM " + table + " WHERE uniqueId = ?";
47 | val statement = prepareStatement(query, uniqueId.toString());
48 | val resultSet = statement.executeQuery();
49 | val exists = resultSet.next();
50 |
51 | statement.close();
52 | resultSet.close();
53 |
54 | return exists;
55 | }
56 |
57 | @SneakyThrows
58 | public Object get(String table, UUID uniqueId, String column) {
59 | val query = "SELECT * FROM " + table + " WHERE uniqueId = ?";
60 | val statement = prepareStatement(query, uniqueId.toString());
61 | val resultSet = statement.executeQuery();
62 |
63 | if (!resultSet.next()) return null;
64 | val result = resultSet.getObject(column);
65 |
66 | statement.close();
67 | resultSet.close();
68 |
69 | return result;
70 | }
71 |
72 | @SneakyThrows
73 | public void setIfAbsent(String table, DatabaseContainer databaseContainer, UUID uniqueId, Object... objects) {
74 | if (exists(table, uniqueId)) return;
75 |
76 | val query = "INSERT INTO " + table + databaseContainer.getColumnsAndQuestionMarks();
77 | val objectToSet = new Object[objects.length + 1];
78 | objectToSet[0] = uniqueId.toString();
79 | System.arraycopy(objects, 0, objectToSet, 1, objects.length);
80 | val statement = prepareStatement(query, objectToSet);
81 |
82 | statement.executeUpdate();
83 | statement.close();
84 | }
85 |
86 | @SneakyThrows
87 | public void update(String table, UUID uniqueId, String column, Object objectToSet) {
88 | if (!exists(table, uniqueId)) return;
89 |
90 | val query = "UPDATE " + table + " SET " + column + " = ? WHERE uniqueId = ?";
91 | val statement = prepareStatement(query, objectToSet, uniqueId.toString());
92 |
93 | statement.executeUpdate();
94 | statement.close();
95 | }
96 |
97 | @SneakyThrows
98 | public void delete(String table, UUID uniqueId) {
99 | if (!exists(table, uniqueId)) return;
100 |
101 | val query = "DELETE FROM " + table + " WHERE uniqueId = ?";
102 | val statement = prepareStatement(query, uniqueId.toString());
103 |
104 | statement.executeUpdate();
105 | statement.close();
106 | }
107 |
108 | }
109 |
--------------------------------------------------------------------------------