Skip to content
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

Updated getIndexInfo() to include Columnstore indexes by using custom query. #2566

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+216 −27
Open

Updated getIndexInfo() to include Columnstore indexes by using custom query. #2566

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
420b583
Updated getIndexInfo() to include Columnstore indexes by using custom…
Ananya2 Dec 17, 2024
162f3e0
Updated changes as per review comments.
Ananya2 Dec 20, 2024
a386438
formatted code
Ananya2 Dec 20, 2024
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
46 changes: 19 additions & 27 deletions src/main/java/com/microsoft/sqlserver/jdbc/SQLServerDatabaseMetaData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1197,39 +1197,31 @@ private ResultSet executeSPFkeys(String[] procParams) throws SQLException {
}
}

private static final String[] getIndexInfoColumnNames = { /* 1 */ TABLE_CAT, /* 2 */ TABLE_SCHEM,
/* 3 */ TABLE_NAME, /* 4 */ NON_UNIQUE, /* 5 */ INDEX_QUALIFIER, /* 6 */ INDEX_NAME, /* 7 */ TYPE,
/* 8 */ ORDINAL_POSITION, /* 9 */ COLUMN_NAME, /* 10 */ ASC_OR_DESC, /* 11 */ CARDINALITY, /* 12 */ PAGES,
/* 13 */ FILTER_CONDITION};

@Override
public java.sql.ResultSet getIndexInfo(String cat, String schema, String table, boolean unique,
boolean approximate) throws SQLServerException, SQLTimeoutException {
boolean approximate) throws SQLServerException, SQLTimeoutException, SQLException {
Ananya2 marked this conversation as resolved.
Show resolved Hide resolved
Ananya2 marked this conversation as resolved.
Show resolved Hide resolved
if (loggerExternal.isLoggable(Level.FINER) && Util.isActivityTraceOn()) {
loggerExternal.finer(toString() + ACTIVITY_ID + ActivityCorrelator.getCurrent().toString());
}
checkClosed();
/*
* sp_statistics [ @table_name = ] 'table_name' [ , [ @table_owner = ] 'owner' ] [ , [ @table_qualifier = ]
* 'qualifier' ] [ , [ @index_name = ] 'index_name' ] [ , [ @is_unique = ] 'is_unique' ] [ , [ @accuracy = ]
* 'accuracy' ]
*/
String[] arguments = new String[6];
arguments[0] = table;
arguments[1] = schema;
arguments[2] = cat;
// use default for index name
arguments[3] = "%"; // index name % is default
if (unique)
arguments[4] = "Y"; // is_unique
else
arguments[4] = "N";
if (approximate)
arguments[5] = "Q";
else
arguments[5] = "E";
return getResultSetWithProvidedColumnNames(cat, CallableHandles.SP_STATISTICS, arguments,
getIndexInfoColumnNames);
String query = "SELECT " +
Ananya2 marked this conversation as resolved.
Show resolved Hide resolved
"db_name() AS CatalogName, " +
"sch.name AS SchemaName, " +
"t.name AS TableName, " +
"i.name AS IndexName, " +
"i.type_desc AS IndexType, " +
"i.is_unique AS IsUnique, " +
"c.name AS ColumnName, " +
"ic.key_ordinal AS ColumnOrder " +
"FROM sys.indexes i " +
"INNER JOIN sys.index_columns ic ON i.object_id = ic.object_id AND i.index_id = ic.index_id " +
"INNER JOIN sys.columns c ON ic.object_id = c.object_id AND ic.column_id = c.column_id " +
"INNER JOIN sys.tables t ON i.object_id = t.object_id " +
"INNER JOIN sys.schemas sch ON t.schema_id = sch.schema_id " +
"WHERE t.name = '" + table + "' " +
"AND sch.name = '" + schema + "' " +
"ORDER BY t.name, i.name, ic.key_ordinal";
return getResultSetFromInternalQueries(cat, query);
}

@Override
Expand Down
174 changes: 174 additions & 0 deletions .../java/com/microsoft/sqlserver/jdbc/databasemetadata/DatabaseMetadataGetIndexInfoTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
package com.microsoft.sqlserver.jdbc.databasemetadata;

import static org.junit.jupiter.api.Assertions.*;
Ananya2 marked this conversation as resolved.
Show resolved Hide resolved

import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import com.microsoft.sqlserver.testframework.AbstractTest;
import com.microsoft.sqlserver.jdbc.SQLServerException;
import com.microsoft.sqlserver.jdbc.TestResource;
import com.microsoft.sqlserver.jdbc.TestUtils;
import com.microsoft.sqlserver.testframework.AbstractSQLGenerator;

public class DatabaseMetadataGetIndexInfoTest extends AbstractTest {

private static String tableName = AbstractSQLGenerator.escapeIdentifier("DBMetadataTestTable");
Ananya2 marked this conversation as resolved.
Show resolved Hide resolved
private static String col1Name = AbstractSQLGenerator.escapeIdentifier("p1");
private static String col2Name = AbstractSQLGenerator.escapeIdentifier("p2");
private static String col3Name = AbstractSQLGenerator.escapeIdentifier( "p3");

@BeforeAll
public static void setupTests() throws Exception {
Ananya2 marked this conversation as resolved.
Show resolved Hide resolved
setConnection();
}

@BeforeEach
public void init() throws Exception {
try (Connection con = getConnection()) {
con.setAutoCommit(false);
try (Statement stmt = con.createStatement()) {
TestUtils.dropTableIfExists(tableName, stmt);
String createTableSQL = "CREATE TABLE " + tableName + " (" +
col1Name + " INT, " +
col2Name + " INT, " +
col3Name + " INT)";

stmt.executeUpdate(createTableSQL);
assertNull(connection.getWarnings(), "Expecting NO SQLWarnings from 'create table', at Connection.");
assertNull(stmt.getWarnings(), "Expecting NO SQLWarnings from 'create table', at Statement.");
Ananya2 marked this conversation as resolved.
Show resolved Hide resolved

String createClusteredIndexSQL = "CREATE CLUSTERED INDEX IDX_Clustered ON " + tableName + "(" + col1Name + ")";
stmt.executeUpdate(createClusteredIndexSQL);
assertNull(connection.getWarnings(), "Expecting NO SQLWarnings from 'create index', at Connection.");
assertNull(stmt.getWarnings(), "Expecting NO SQLWarnings from 'create index', at Statement.");

String createNonClusteredIndexSQL = "CREATE NONCLUSTERED INDEX IDX_NonClustered ON " + tableName + "(" + col2Name + ")";
stmt.executeUpdate(createNonClusteredIndexSQL);
assertNull(connection.getWarnings(), "Expecting NO SQLWarnings from 'create index', at Connection.");
assertNull(stmt.getWarnings(), "Expecting NO SQLWarnings from 'create index', at Statement.");

String createColumnstoreIndexSQL = "CREATE COLUMNSTORE INDEX IDX_Columnstore ON " + tableName + "(" + col3Name + ")";
stmt.executeUpdate(createColumnstoreIndexSQL);
assertNull(connection.getWarnings(), "Expecting NO SQLWarnings from 'create index', at Connection.");
assertNull(stmt.getWarnings(), "Expecting NO SQLWarnings from 'create index', at Statement.");
}
con.commit();
}
}

@AfterEach
public void terminate() throws Exception {
try (Connection con = getConnection(); Statement stmt = con.createStatement()) {
try {
TestUtils.dropTableIfExists(tableName, stmt);
} catch (SQLException e) {
fail(TestResource.getResource("R_unexpectedException") + e.getMessage());
}
}
}

@Test
public void testGetIndexInfo() throws SQLException, SQLServerException {
Ananya2 marked this conversation as resolved.
Show resolved Hide resolved
ResultSet rs1, rs2 = null;
try (Connection connection = getConnection(); Statement stmt = connection.createStatement()) {
String catalog = connection.getCatalog();
String schema = "dbo";
String table = "DBMetadataTestTable";
DatabaseMetaData dbMetadata = connection.getMetaData();
rs1 = dbMetadata.getIndexInfo(catalog, schema, table, false, false);

boolean hasClusteredIndex = false;
boolean hasNonClusteredIndex = false;
boolean hasColumnstoreIndex = false;

String query =
"SELECT " +
" db_name() AS CatalogName, " +
" sch.name AS SchemaName, " +
" t.name AS TableName, " +
" i.name AS IndexName, " +
" i.type_desc AS IndexType, " +
" i.is_unique AS IsUnique, " +
" c.name AS ColumnName, " +
" ic.key_ordinal AS ColumnOrder " +
"FROM " +
" sys.indexes i " +
"INNER JOIN " +
" sys.index_columns ic ON i.object_id = ic.object_id AND i.index_id = ic.index_id " +
"INNER JOIN " +
" sys.columns c ON ic.object_id = c.object_id AND ic.column_id = c.column_id " +
"INNER JOIN " +
" sys.tables t ON i.object_id = t.object_id " +
"INNER JOIN " +
" sys.schemas sch ON t.schema_id = sch.schema_id " +

"WHERE t.name = '" + table + "' " +
"AND sch.name = '" + schema + "' " +
"ORDER BY " +
" t.name, i.name, ic.key_ordinal;";
rs2 = stmt.executeQuery(query);

while (rs1.next() && rs2.next()) {
String indexType = rs1.getString("IndexType");
String indexName = rs1.getString("IndexName");

assertEquals(rs1.getString("CatalogName"), rs2.getString("CatalogName"));
Ananya2 marked this conversation as resolved.
Show resolved Hide resolved
assertEquals(rs1.getString("SchemaName"), rs2.getString("SchemaName"));
assertEquals(rs1.getString("TableName"), rs2.getString("TableName"));
assertEquals(indexName, rs2.getString("IndexName"));
assertEquals(indexType, rs2.getString("IndexType"));
assertEquals(rs1.getString("IsUnique"), rs2.getString("IsUnique"));
assertEquals(rs1.getString("ColumnName"), rs2.getString("ColumnName"));
assertEquals(rs1.getString("ColumnOrder"), rs2.getString("ColumnOrder"));

if (indexType.contains("COLUMNSTORE")) {
hasColumnstoreIndex = true;
} else if (indexType.equals("CLUSTERED")) {
hasClusteredIndex = true;
} else if (indexType.equals("NONCLUSTERED")) {
hasNonClusteredIndex = true;
}
}

assertTrue(hasColumnstoreIndex, "COLUMNSTORE index not found.");
assertTrue(hasClusteredIndex, "CLUSTERED index not found.");
assertTrue(hasNonClusteredIndex, "NONCLUSTERED index not found.");
}
}

@Test
public void testGetIndexInfoCaseSensitivity() throws SQLException, SQLServerException {
Ananya2 marked this conversation as resolved.
Show resolved Hide resolved
ResultSet rs1, rs2 = null;
try (Connection connection = getConnection(); Statement stmt = connection.createStatement()) {
Ananya2 marked this conversation as resolved.
Show resolved Hide resolved
String catalog = connection.getCatalog();
String schema = "dbo";
String table = "DBMetadataTestTable";

DatabaseMetaData dbMetadata = connection.getMetaData();
rs1 = dbMetadata.getIndexInfo(catalog, schema, table, false, false);
rs2 = dbMetadata.getIndexInfo(catalog, schema, table.toUpperCase(), false, false);

while (rs1.next() && rs2.next()) {
String indexType = rs1.getString("IndexType");
String indexName = rs1.getString("IndexName");

assertEquals(rs1.getString("CatalogName"), rs2.getString("CatalogName"));
assertEquals(rs1.getString("SchemaName"), rs2.getString("SchemaName"));
assertEquals(rs1.getString("TableName"), rs2.getString("TableName"));
assertEquals(indexName, rs2.getString("IndexName"));
assertEquals(indexType, rs2.getString("IndexType"));
assertEquals(rs1.getString("IsUnique"), rs2.getString("IsUnique"));
assertEquals(rs1.getString("ColumnName"), rs2.getString("ColumnName"));
assertEquals(rs1.getString("ColumnOrder"), rs2.getString("ColumnOrder"));
}
}
}
}
Loading