com.partnersoft.sql

Interface SqlDialect

All Superinterfaces:

Lib

All Known Implementing Classes:

AccessDialect, DerbyDialect, GenericSqlDialect, HsqlDialect, MySqlDialect, ProgressDialect, SqliteDialect

public interface SqlDialect
extends Lib

Interface for creating Sql flavor specific statements.

Copyright 2009 Partner Software, Inc.

Author:

Rich Stepanski

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	addColumn(java.lang.String tableName, CogStructureField newField, CogType newFieldType) Returns complete Sql to add a column.
java.lang.String	alterColumn(java.lang.String tableName, CogStructureField newField, CogType newFieldType) Returns complete Sql to alter a column.
java.lang.String	cogTypeToSqlType(CogType type) Helper for converting from a CogType to a Sql flavor specific data type.
java.lang.String	createTable(CogSchema schema, CogStructureType tableType) Returns complete Sql create table statement.
java.lang.String	createTableFromSelect(CogSchema schema, java.lang.String createTableName, DataRecordQuery query, CogStructureType queryTableType) Returns complete Sql statement for creating a table as a select from another existing table.
java.lang.Object	dbToObject(java.lang.String ogValueType, java.lang.Object dbValue) Converts and returns the passed Object, as stored in database.
java.lang.String	describeTable(java.lang.String tableName, java.lang.String databaseName) Returns sql for describing a table.
java.lang.String	describleTableColumnKey() Returns key name for column name found in describe table ResultSet
java.lang.String	describleTableTypeKey() Returns key name for column type found in describe table ResultSet
java.lang.String	dropColumn(java.lang.String tableName, java.lang.String fieldName) Returns complete Sql to drop a column.
boolean	isAlterColumnSupported() Returns true if columns can be altered.
boolean	isDescribeTableSupported() Returns true if this flavor of sql supports describe table via sql statments.
boolean	isListDatabasesSupported() Returns true if this flavor of sql supports list databases via sql statements.
boolean	isListTablesSupported() Returns true if this flavor of sql supports list tables via sql statements.
java.lang.String	listDatabases() Returns sql for listing databases If isDescribeTableSupported() returns false, should throw an UnsupportedOperationException
java.lang.String	listTables(java.lang.String databaseName) Returns sql for listing table names in database.
java.lang.Object	objectToDb(java.lang.String fieldValueType, java.lang.Object value) Converts the passed Object of passed value type into database specific equivalent.
java.lang.String	objectToDbSql(java.lang.String fieldValueType, java.lang.Object value) Converts passed Object of passed value type into database equivalent sql and returns.
java.lang.String	renameTable(java.lang.String originalName, java.lang.String renamedName) Returns Sql for renaming a given table to another.
java.lang.String	selectSql(DataRecordQuery query, CogStructureType tableType) Returns complete Sql select statement.
java.lang.String	sqlTypeToCogType(java.lang.String sqlType) Helper for converting from a Sql data type to a Cog value type.

Method Detail

selectSql

java.lang.String selectSql(DataRecordQuery query,
                         CogStructureType tableType)

Returns complete Sql select statement.

Parameters:

query - - Query describing select statement.

tableType - - CogStructureType defining table. Type name is assumed to be table name.

Returns:

Sql select statement for passed query.

createTable

java.lang.String createTable(CogSchema schema,
                           CogStructureType tableType)

Returns complete Sql create table statement.

Parameters:

schema - - Schema defining column types.

tableType - - CogStructureType defining table. Type name is assumed to be table name.

Returns:

Sql create table statement for passed schema and cog type.

objectToDb

java.lang.Object objectToDb(java.lang.String fieldValueType,
                          java.lang.Object value)

Converts the passed Object of passed value type into database specific equivalent.

Ex. Dates may be stored as Numbers or Strings.

Parameters:

fieldValueType - - CogStructureField value type for this field.

value - - Value to covert database Object

Returns:

database storage type equivalent

objectToDbSql

java.lang.String objectToDbSql(java.lang.String fieldValueType,
                             java.lang.Object value)

Converts passed Object of passed value type into database equivalent sql and returns. Includes quotes if applicable.

By default, should return SqlLib.convertToStringAndQuote(Object)

Parameters:

fieldValueType - - CogStructureField value type of value.

value - - value to convert to sql

Returns:

full sql for passed value, including quotes if applicable.

dbToObject

java.lang.Object dbToObject(java.lang.String ogValueType,
                          java.lang.Object dbValue)

Converts and returns the passed Object, as stored in database. to the original value type.

This should reverse any flavor specific conversion done in objectToDb(String, Object)

Parameters:

ogValueType - - Original Cog value type name.

dbValue - - Value from database

Returns:

converted database object

createTableFromSelect

java.lang.String createTableFromSelect(CogSchema schema,
                                     java.lang.String createTableName,
                                     DataRecordQuery query,
                                     CogStructureType queryTableType)

Returns complete Sql statement for creating a table as a select from another existing table.

Parameters:

schema - - Schema defining column types.

createTableName - - Name of table to create

query - - DataRecordQuery to create from

queryTableType - - CogStructureType defining table to be queried.

Returns:

Sql create table from select statement for passed schema and cog type.

alterColumn

java.lang.String alterColumn(java.lang.String tableName,
                           CogStructureField newField,
                           CogType newFieldType)

Returns complete Sql to alter a column.

Parameters:

tableName - - Name of table to alter column in.

newField - - Field to change.

newFieldType - - CogType for the passed field.

Returns:

Sql to alter a column.

addColumn

java.lang.String addColumn(java.lang.String tableName,
                         CogStructureField newField,
                         CogType newFieldType)

Returns complete Sql to add a column.

Parameters:

tableName - - Name of table to add a column to.

newField - - Field to add.

newFieldType - - CogType of field to add.

Returns:

Sql to add a column.

dropColumn

java.lang.String dropColumn(java.lang.String tableName,
                          java.lang.String fieldName)

Returns complete Sql to drop a column.

Parameters:

tableName - - Name of table to drop column from.

fieldName - - Name of field to drop.

Returns:

complete Sql to drop a column.

cogTypeToSqlType

java.lang.String cogTypeToSqlType(CogType type)

Helper for converting from a CogType to a Sql flavor specific data type. Default returns the CogPrimitiveType's sqlType, or VARCHAR(255)

Parameters:

type - - CogType to convert to Sql type.

Returns:

Sql flavor specific data type for the passed cog type.

sqlTypeToCogType

java.lang.String sqlTypeToCogType(java.lang.String sqlType)

Helper for converting from a Sql data type to a Cog value type.

Parameters:

sqlType - - String representing sql type (ie, varchar(255))

Returns:

Cog value type that matches sql type

isListTablesSupported

boolean isListTablesSupported()

Returns true if this flavor of sql supports list tables via sql statements. False if it does not.

Returns:

True if list tables is supported via sql statements, false otherwise

isListDatabasesSupported

boolean isListDatabasesSupported()

Returns true if this flavor of sql supports list databases via sql statements. False if it does not.

Returns:

True if list databases is supported via sql statements, false otherwise

isDescribeTableSupported

boolean isDescribeTableSupported()

Returns true if this flavor of sql supports describe table via sql statments. False if it does not.

Returns:

True if describe tables is supported via sql statements, false otherwise.

isAlterColumnSupported

boolean isAlterColumnSupported()

Returns true if columns can be altered.

Returns:

true if columns can be altered.

renameTable

java.lang.String renameTable(java.lang.String originalName,
                           java.lang.String renamedName)

Returns Sql for renaming a given table to another.

Parameters:

originalName - - Original table name to rename

renamedName - - Name to rename to.

Returns:

Sql for renaming tables.

listDatabases

java.lang.String listDatabases()

Returns sql for listing databases If isDescribeTableSupported() returns false, should throw an UnsupportedOperationException

Returns:

Sql for listing databases

listTables

java.lang.String listTables(java.lang.String databaseName)

Returns sql for listing table names in database. If isListTablesSupported() returns false, throws an UnsupportedOperationException

Parameters:

databaseName - - Name of database to list tables from

Returns:

Sql for listing table names

describeTable

java.lang.String describeTable(java.lang.String tableName,
                             java.lang.String databaseName)

Returns sql for describing a table. if isDescribeTableSupported() returns false, throws an UnsupportedOperationException

Parameters:

tableName - - Name of table to describe

databaseName - - Name of database containing table

Returns:

Sql for describing a table

describleTableColumnKey

java.lang.String describleTableColumnKey()

Returns key name for column name found in describe table ResultSet

Returns:

key name for column name

describleTableTypeKey

java.lang.String describleTableTypeKey()

Returns key name for column type found in describe table ResultSet

Returns:

key name for column type