Skip to content

Adds support for decoding bytes in metadata calls #2645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
michael-berlin merged 4 commits into from
Mar 24, 2017
Merged

Adds support for decoding bytes in metadata calls #2645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5a3e23a
Adds support for decoding bytes in metadata calls
bbeaudreault Feb 28, 2017
a8fc185
add a test to ensure proper class type of getObject
bbeaudreault Mar 19, 2017
7bde448
limit scope of passed Connection to just ConnectionProperties. Move s…
bbeaudreault Mar 20, 2017
e5d1cc8
change here too
bbeaudreault Mar 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 87 additions & 61 deletions java/jdbc/src/main/java/com/flipkart/vitess/jdbc/FieldWithMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import com.flipkart.vitess.util.MysqlDefs;
import com.flipkart.vitess.util.StringUtils;
import com.flipkart.vitess.util.charset.CharsetMapping;
import com.google.common.annotations.VisibleForTesting;
import com.youtube.vitess.proto.Query;

import java.sql.SQLException;
Expand All @@ -12,7 +13,7 @@

public class FieldWithMetadata {

private final VitessConnection connection;
private final ConnectionProperties connectionProperties;
private final Query.Field field;
private final Query.Type vitessType;
private final boolean isImplicitTempTable;
Expand All @@ -26,8 +27,8 @@ public class FieldWithMetadata {
private int collationIndex;
private int maxBytesPerChar;

public FieldWithMetadata(VitessConnection connection, Query.Field field) throws SQLException {
this.connection = connection;
public FieldWithMetadata(ConnectionProperties connectionProperties, Query.Field field) throws SQLException {
this.connectionProperties = connectionProperties;
this.field = field;
this.colFlag = field.getFlags();
this.vitessType = field.getType();
Expand All @@ -46,15 +47,15 @@ public FieldWithMetadata(VitessConnection connection, Query.Field field) throws

// All of the below remapping and metadata fields require the extra
// fields included when includeFields=IncludedFields.ALL
if (connection != null && connection.isIncludeAllFields()) {
if (connectionProperties != null && connectionProperties.isIncludeAllFields()) {
this.isImplicitTempTable = checkForImplicitTemporaryTable();
// Re-map BLOB to 'real' blob type
if (this.javaType == Types.BLOB) {
boolean isFromFunction = field.getOrgTable().isEmpty();
if (connection.getBlobsAreStrings() || (connection.getFunctionsNeverReturnBlobs() && isFromFunction)) {
if (connectionProperties.getBlobsAreStrings() || (connectionProperties.getFunctionsNeverReturnBlobs() && isFromFunction)) {
this.javaType = Types.VARCHAR;
} else if (collationIndex == CharsetMapping.MYSQL_COLLATION_INDEX_binary) {
if (connection.getUseBlobToStoreUTF8OutsideBMP() && shouldSetupForUtf8StringInBlob()) {
if (connectionProperties.getUseBlobToStoreUTF8OutsideBMP() && shouldSetupForUtf8StringInBlob()) {
if (this.getColumnLength() == MysqlDefs.LENGTH_TINYBLOB || this.getColumnLength() == MysqlDefs.LENGTH_BLOB) {
this.javaType = Types.VARCHAR;
} else {
Expand All @@ -76,14 +77,14 @@ public FieldWithMetadata(VitessConnection connection, Query.Field field) throws
}

// Re-map TINYINT(1) as bit or pseudo-boolean
if (this.javaType == Types.TINYINT && this.field.getColumnLength() == 1 && connection.getTinyInt1isBit()) {
if (this.javaType == Types.TINYINT && this.field.getColumnLength() == 1 && connectionProperties.getTinyInt1isBit()) {
this.javaType = Types.BIT;
}

if (!isNativeNumericType() && !isNativeDateTimeType()) {
// For non-numeric types, try to pull the encoding from the passed collationIndex
// We will do some fixup afterwards
this.encoding = connection.getEncodingForIndex(this.collationIndex);
this.encoding = getEncodingForIndex(this.collationIndex);
// ucs2, utf16, and utf32 cannot be used as a client character set, but if it was received from server
// under some circumstances we can parse them as utf16
if ("UnicodeBig".equals(this.encoding)) {
Expand Down Expand Up @@ -182,24 +183,37 @@ private boolean isNativeDateTimeType() {
}
}

public VitessConnection getConnection() throws SQLException {
checkConnection();
return connection;
@VisibleForTesting
String getEncodingForIndex(int charsetIndex) {
String javaEncoding = null;
if (charsetIndex != MysqlDefs.NO_CHARSET_INFO) {
javaEncoding = CharsetMapping.getJavaEncodingForCollationIndex(charsetIndex, connectionProperties.getEncoding());
}
// If nothing, get default based on configuration, may still be null
if (javaEncoding == null) {
javaEncoding = connectionProperties.getEncoding();
}
return javaEncoding;
}

public ConnectionProperties getConnectionProperties() throws SQLException {
checkConnectionProperties();
return connectionProperties;
}

public boolean hasConnection() {
return connection != null;
public boolean hasConnectionProperties() {
return connectionProperties != null;
}

private void checkConnection() throws SQLException {
if (!hasConnection()) {
private void checkConnectionProperties() throws SQLException {
if (!hasConnectionProperties()) {
throw new SQLException(Constants.SQLExceptionMessages.CONN_UNAVAILABLE);
}
}

private boolean shouldSetupForUtf8StringInBlob() throws SQLException {
String includePattern = connection.getUtf8OutsideBmpIncludedColumnNamePattern();
String excludePattern = connection.getUtf8OutsideBmpExcludedColumnNamePattern();
String includePattern = connectionProperties.getUtf8OutsideBmpIncludedColumnNamePattern();
String excludePattern = connectionProperties.getUtf8OutsideBmpExcludedColumnNamePattern();

// When UseBlobToStoreUTF8OutsideBMP is set, we by default set blobs to UTF-8. So we first
// look for fields to exclude from that remapping (blacklist)
Expand Down Expand Up @@ -228,85 +242,85 @@ private boolean shouldSetupForUtf8StringInBlob() throws SQLException {
}

public boolean isAutoIncrement() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return false;
}
return ((this.colFlag & Query.MySqlFlag.AUTO_INCREMENT_FLAG_VALUE) > 0);
}

public boolean isBinary() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return false;
}
return ((this.colFlag & Query.MySqlFlag.BINARY_FLAG_VALUE) > 0);
}

public boolean isBlob() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return false;
}
return ((this.colFlag & Query.MySqlFlag.BLOB_FLAG_VALUE) > 0);
}

public boolean isMultipleKey() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return false;
}
return ((this.colFlag & Query.MySqlFlag.MULTIPLE_KEY_FLAG_VALUE) > 0);
}

boolean isNotNull() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return true;
}
return ((this.colFlag & Query.MySqlFlag.NOT_NULL_FLAG_VALUE) > 0);
}

public boolean isZeroFill() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return false;
}
return ((this.colFlag & Query.MySqlFlag.ZEROFILL_FLAG_VALUE) > 0);
}

public boolean isPrimaryKey() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return false;
}
return ((this.colFlag & Query.MySqlFlag.PRI_KEY_FLAG_VALUE) > 0);
}

public boolean isUniqueKey() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return false;
}
return ((this.colFlag & Query.MySqlFlag.UNIQUE_KEY_FLAG_VALUE) > 0);
}

public boolean isUnsigned() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return true;
}
return ((this.colFlag & Query.MySqlFlag.UNSIGNED_FLAG_VALUE) > 0);
}

public boolean isSigned() throws SQLException {
checkConnection();
checkConnectionProperties();
return !isUnsigned();
}

boolean isOpaqueBinary() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return false;
}

Expand All @@ -329,8 +343,8 @@ boolean isOpaqueBinary() throws SQLException {
* statement.
*/
boolean isReadOnly() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return false;
}
String orgColumnName = getOrgName();
Expand All @@ -339,7 +353,7 @@ boolean isReadOnly() throws SQLException {
}

public synchronized String getCollation() throws SQLException {
if (!connection.isIncludeAllFields()) {
if (!connectionProperties.isIncludeAllFields()) {
return null;
}

Expand All @@ -356,63 +370,75 @@ public synchronized String getCollation() throws SQLException {


public synchronized int getMaxBytesPerCharacter() {
if (!connection.isIncludeAllFields()) {
if (!connectionProperties.isIncludeAllFields()) {
return 0;
}

if (this.maxBytesPerChar == 0) {
this.maxBytesPerChar = this.connection.getMaxBytesPerChar(getCollationIndex(), getEncoding());
this.maxBytesPerChar = getMaxBytesPerChar(getCollationIndex(), getEncoding());
}
return this.maxBytesPerChar;
}

@VisibleForTesting
int getMaxBytesPerChar(Integer charsetIndex, String javaCharsetName) {
// if we can get it by charsetIndex just doing it
String charset = CharsetMapping.getMysqlCharsetNameForCollationIndex(charsetIndex);
// if we didn't find charset name by its full name
if (charset == null) {
charset = CharsetMapping.getMysqlCharsetForJavaEncoding(javaCharsetName);
}
// checking against static maps
return CharsetMapping.getMblen(charset);
}

public String getName() {
return field.getName();
}

public String getTable() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return null;
}
return field.getTable();
}

public String getOrgTable() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return null;
}
return field.getOrgTable();
}

public String getDatabase() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return null;
}
return field.getDatabase();
}

public String getOrgName() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return null;
}
return field.getOrgName();
}

public int getColumnLength() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return 0;
}
return field.getColumnLength();
}

public int getDecimals() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return 0;
}
return field.getDecimals();
Expand All @@ -431,14 +457,14 @@ public int getVitessTypeValue() {
}

boolean isImplicitTemporaryTable() {
if (!connection.isIncludeAllFields()) {
if (!connectionProperties.isIncludeAllFields()) {
return false;
}
return isImplicitTempTable;
}

public String getEncoding() {
if (!connection.isIncludeAllFields()) {
if (!connectionProperties.isIncludeAllFields()) {
return null;
}
return encoding;
Expand All @@ -450,16 +476,16 @@ public String getEncoding() {
* numeric types
*/
public int getPrecisionAdjustFactor() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return 0;
}
return precisionAdjustFactor;
}

public boolean isSingleBit() throws SQLException {
checkConnection();
if (!connection.isIncludeAllFields()) {
checkConnectionProperties();
if (!connectionProperties.isIncludeAllFields()) {
return false;
}
return isSingleBit;
Expand Down
Loading