mirror of
https://github.com/aljazceru/turso.git
synced 2025-12-26 20:44:23 +01:00
Add javadoc on classes and public methods for publishing to maven central
This commit is contained in:
@@ -10,6 +10,9 @@ import tech.turso.jdbc4.JDBC4Connection;
|
||||
import tech.turso.utils.Logger;
|
||||
import tech.turso.utils.LoggerFactory;
|
||||
|
||||
/**
|
||||
* Turso JDBC driver implementation.
|
||||
*/
|
||||
public final class JDBC implements Driver {
|
||||
|
||||
private static final Logger logger = LoggerFactory.getLogger(JDBC.class);
|
||||
@@ -24,6 +27,14 @@ public final class JDBC implements Driver {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new Turso JDBC connection.
|
||||
*
|
||||
* @param url the database URL
|
||||
* @param properties connection properties
|
||||
* @return a new connection instance, or null if the URL is not valid
|
||||
* @throws SQLException if a database access error occurs
|
||||
*/
|
||||
@Nullable
|
||||
public static JDBC4Connection createConnection(String url, Properties properties)
|
||||
throws SQLException {
|
||||
|
||||
@@ -23,7 +23,7 @@ public final class TursoDBFactory {
|
||||
* @param url the URL of the database
|
||||
* @param filePath the path to the database file
|
||||
* @param properties additional properties for the database connection
|
||||
* @return an instance of {@link tursoDB}
|
||||
* @return an instance of {@link TursoDB}
|
||||
* @throws SQLException if there is an error opening the connection
|
||||
* @throws IllegalArgumentException if the fileName is empty
|
||||
*/
|
||||
|
||||
@@ -57,7 +57,7 @@ public final class TursoResultSet {
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves the cursor forward one row from its current position. A {@link tursoResultSet} cursor is
|
||||
* Moves the cursor forward one row from its current position. A {@link TursoResultSet} cursor is
|
||||
* initially positioned before the first fow; the first call to the method <code>next</code> makes
|
||||
* the first row the current row; the second call makes the second row the current row, and so on.
|
||||
* When a call to the <code>next</code> method returns <code>false</code>, the cursor is
|
||||
@@ -65,6 +65,9 @@ public final class TursoResultSet {
|
||||
*
|
||||
* <p>Note that turso only supports <code>ResultSet.TYPE_FORWARD_ONLY</code>, which means that the
|
||||
* cursor can only move forward.
|
||||
*
|
||||
* @return true if the new current row is valid; false if there are no more rows
|
||||
* @throws SQLException if a database access error occurs
|
||||
*/
|
||||
public boolean next() throws SQLException {
|
||||
if (!open) {
|
||||
|
||||
@@ -91,8 +91,8 @@ public final class TursoStatement {
|
||||
private native void _close(long statementPointer);
|
||||
|
||||
/**
|
||||
* Initializes the column metadata, such as the names of the columns. Since {@link tursoStatement}
|
||||
* can only have a single {@link tursoResultSet}, it is appropriate to place the initialization of
|
||||
* Initializes the column metadata, such as the names of the columns. Since {@link TursoStatement}
|
||||
* can only have a single {@link TursoResultSet}, it is appropriate to place the initialization of
|
||||
* column metadata here.
|
||||
*
|
||||
* @throws SQLException if a database access error occurs while retrieving column names
|
||||
|
||||
@@ -9,20 +9,45 @@ import tech.turso.annotations.SkipNullableCheck;
|
||||
import tech.turso.core.TursoConnection;
|
||||
import tech.turso.core.TursoStatement;
|
||||
|
||||
/**
|
||||
* JDBC 4 Connection implementation for Turso databases.
|
||||
*/
|
||||
public final class JDBC4Connection implements Connection {
|
||||
|
||||
private final TursoConnection connection;
|
||||
|
||||
private Map<String, Class<?>> typeMap = new HashMap<>();
|
||||
|
||||
/**
|
||||
* Creates a new JDBC4 connection.
|
||||
*
|
||||
* @param url the database URL
|
||||
* @param filePath the database file path
|
||||
* @throws SQLException if a database access error occurs
|
||||
*/
|
||||
public JDBC4Connection(String url, String filePath) throws SQLException {
|
||||
this.connection = new TursoConnection(url, filePath);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new JDBC4 connection with properties.
|
||||
*
|
||||
* @param url the database URL
|
||||
* @param filePath the database file path
|
||||
* @param properties connection properties
|
||||
* @throws SQLException if a database access error occurs
|
||||
*/
|
||||
public JDBC4Connection(String url, String filePath, Properties properties) throws SQLException {
|
||||
this.connection = new TursoConnection(url, filePath, properties);
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepares a SQL statement for execution.
|
||||
*
|
||||
* @param sql the SQL statement to prepare
|
||||
* @return the prepared statement
|
||||
* @throws SQLException if a database access error occurs
|
||||
*/
|
||||
public TursoStatement prepare(String sql) throws SQLException {
|
||||
final TursoStatement statement = connection.prepare(sql);
|
||||
statement.initializeColumnMetadata();
|
||||
@@ -357,6 +382,11 @@ public final class JDBC4Connection implements Connection {
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the busy timeout for the connection.
|
||||
*
|
||||
* @param busyTimeout the timeout in milliseconds
|
||||
*/
|
||||
public void setBusyTimeout(int busyTimeout) {
|
||||
// TODO: add support for busy timeout
|
||||
}
|
||||
@@ -367,10 +397,20 @@ public final class JDBC4Connection implements Connection {
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the database URL.
|
||||
*
|
||||
* @return the database URL
|
||||
*/
|
||||
public String getUrl() {
|
||||
return this.connection.getUrl();
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the connection is open.
|
||||
*
|
||||
* @throws SQLException if the connection is closed
|
||||
*/
|
||||
public void checkOpen() throws SQLException {
|
||||
connection.checkOpen();
|
||||
}
|
||||
|
||||
@@ -13,6 +13,9 @@ import tech.turso.core.TursoPropertiesHolder;
|
||||
import tech.turso.utils.Logger;
|
||||
import tech.turso.utils.LoggerFactory;
|
||||
|
||||
/**
|
||||
* JDBC 4 DatabaseMetaData implementation for Turso databases.
|
||||
*/
|
||||
public final class JDBC4DatabaseMetaData implements DatabaseMetaData {
|
||||
|
||||
private static final Logger logger = LoggerFactory.getLogger(JDBC4DatabaseMetaData.class);
|
||||
@@ -51,6 +54,11 @@ public final class JDBC4DatabaseMetaData implements DatabaseMetaData {
|
||||
|
||||
@Nullable private PreparedStatement getColumnPrivileges = null;
|
||||
|
||||
/**
|
||||
* Creates a new JDBC4DatabaseMetaData instance.
|
||||
*
|
||||
* @param connection the database connection
|
||||
*/
|
||||
public JDBC4DatabaseMetaData(JDBC4Connection connection) {
|
||||
this.connection = connection;
|
||||
}
|
||||
|
||||
@@ -26,11 +26,21 @@ import java.util.Calendar;
|
||||
import tech.turso.annotations.SkipNullableCheck;
|
||||
import tech.turso.core.TursoResultSet;
|
||||
|
||||
/**
|
||||
* JDBC 4 PreparedStatement implementation for Turso databases.
|
||||
*/
|
||||
public final class JDBC4PreparedStatement extends JDBC4Statement implements PreparedStatement {
|
||||
|
||||
private final String sql;
|
||||
private final JDBC4ResultSet resultSet;
|
||||
|
||||
/**
|
||||
* Creates a new JDBC4PreparedStatement.
|
||||
*
|
||||
* @param connection the database connection
|
||||
* @param sql the SQL statement to prepare
|
||||
* @throws SQLException if a database access error occurs
|
||||
*/
|
||||
public JDBC4PreparedStatement(JDBC4Connection connection, String sql) throws SQLException {
|
||||
super(connection);
|
||||
this.sql = sql;
|
||||
|
||||
@@ -27,10 +27,18 @@ import tech.turso.annotations.Nullable;
|
||||
import tech.turso.annotations.SkipNullableCheck;
|
||||
import tech.turso.core.TursoResultSet;
|
||||
|
||||
/**
|
||||
* JDBC 4 ResultSet implementation for Turso databases.
|
||||
*/
|
||||
public final class JDBC4ResultSet implements ResultSet, ResultSetMetaData {
|
||||
|
||||
private final TursoResultSet resultSet;
|
||||
|
||||
/**
|
||||
* Creates a new JDBC4ResultSet.
|
||||
*
|
||||
* @param resultSet the underlying Turso result set
|
||||
*/
|
||||
public JDBC4ResultSet(TursoResultSet resultSet) {
|
||||
this.resultSet = resultSet;
|
||||
}
|
||||
@@ -1279,8 +1287,19 @@ public final class JDBC4ResultSet implements ResultSet, ResultSetMetaData {
|
||||
throw new UnsupportedOperationException("not implemented");
|
||||
}
|
||||
|
||||
/**
|
||||
* Functional interface for result set value suppliers.
|
||||
*
|
||||
* @param <T> the type of value to supply
|
||||
*/
|
||||
@FunctionalInterface
|
||||
public interface ResultSetSupplier<T> {
|
||||
/**
|
||||
* Gets a result from the result set.
|
||||
*
|
||||
* @return the result value
|
||||
* @throws Exception if an error occurs
|
||||
*/
|
||||
T get() throws Exception;
|
||||
}
|
||||
|
||||
|
||||
@@ -17,6 +17,9 @@ import tech.turso.annotations.SkipNullableCheck;
|
||||
import tech.turso.core.TursoResultSet;
|
||||
import tech.turso.core.TursoStatement;
|
||||
|
||||
/**
|
||||
* JDBC 4 Statement implementation for Turso databases.
|
||||
*/
|
||||
public class JDBC4Statement implements Statement {
|
||||
|
||||
private static final Pattern BATCH_COMPATIBLE_PATTERN =
|
||||
@@ -35,7 +38,10 @@ public class JDBC4Statement implements Statement {
|
||||
|
||||
private final JDBC4Connection connection;
|
||||
|
||||
/** The underlying Turso statement. */
|
||||
@Nullable protected TursoStatement statement = null;
|
||||
|
||||
/** The number of rows affected by the last update operation. */
|
||||
protected long updateCount;
|
||||
|
||||
// Because JDBC4Statement has different life cycle in compared to tursoStatement, let's use this
|
||||
@@ -475,8 +481,19 @@ public class JDBC4Statement implements Statement {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Functional interface for SQL callable operations.
|
||||
*
|
||||
* @param <T> the return type
|
||||
*/
|
||||
@FunctionalInterface
|
||||
protected interface SQLCallable<T> {
|
||||
/**
|
||||
* Executes the SQL operation.
|
||||
*
|
||||
* @return the result of the operation
|
||||
* @throws SQLException if a database access error occurs
|
||||
*/
|
||||
T call() throws SQLException;
|
||||
}
|
||||
|
||||
|
||||
@@ -3,7 +3,14 @@ package tech.turso.utils;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import tech.turso.annotations.Nullable;
|
||||
|
||||
/** Utility class for converting between byte arrays and strings using UTF-8 encoding. */
|
||||
public final class ByteArrayUtils {
|
||||
/**
|
||||
* Converts a UTF-8 encoded byte array to a string.
|
||||
*
|
||||
* @param buffer the byte array to convert, may be null
|
||||
* @return the string representation, or null if the input is null
|
||||
*/
|
||||
@Nullable
|
||||
public static String utf8ByteBufferToString(@Nullable byte[] buffer) {
|
||||
if (buffer == null) {
|
||||
@@ -13,6 +20,12 @@ public final class ByteArrayUtils {
|
||||
return new String(buffer, StandardCharsets.UTF_8);
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a string to a UTF-8 encoded byte array.
|
||||
*
|
||||
* @param str the string to convert, may be null
|
||||
* @return the byte array representation, or null if the input is null
|
||||
*/
|
||||
@Nullable
|
||||
public static byte[] stringToUtf8ByteArray(@Nullable String str) {
|
||||
if (str == null) {
|
||||
|
||||
Reference in New Issue
Block a user