1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
/*
* Copyright 2004-2011 H2 Group.
* Copyright 2011 James Moger.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.iciql;
import java.sql.DatabaseMetaData;
import com.iciql.TableDefinition.IndexDefinition;
/**
* This interface defines points where iciql can build different statements
* depending on the database used.
*/
public interface SQLDialect {
/**
* Configure the dialect from the database metadata.
*
* @param databaseName
* @param data
*/
void configureDialect(String databaseName, DatabaseMetaData data);
/**
* Allows a dialect to substitute an SQL type.
*
* @param sqlType
* @return the dialect-safe type
*/
String convertSqlType(String sqlType);
/**
* Returns a properly formatted table name for the dialect.
*
* @param schemaName
* the schema name, or null for no schema
* @param tableName
* the properly formatted table name
* @return the SQL snippet
*/
String prepareTableName(String schemaName, String tableName);
/**
* Returns a properly formatted column name for the dialect.
*
* @param name
* the column name
* @return the properly formatted column name
*/
String prepareColumnName(String name);
/**
* Get the CREATE TABLE statement.
*
* @param stat
* @param def
*/
<T> void prepareCreateTable(SQLStatement stat, TableDefinition<T> def);
/**
* Get the DROP TABLE statement.
*
* @param stat
* @param def
*/
<T> void prepareDropTable(SQLStatement stat, TableDefinition<T> def);
/**
* Get the CREATE INDEX statement.
*
* @param schemaName
* the schema name
* @param tableName
* the table name
* @param index
* the index definition
* @return the SQL statement
*/
void prepareCreateIndex(SQLStatement stat, String schemaName, String tableName, IndexDefinition index);
/**
* Get a MERGE or REPLACE INTO statement.
*
* @param schemaName
* the schema name
* @param tableName
* the table name
* @param index
* the index definition
*/
<T> void prepareMerge(SQLStatement stat, String schemaName, String tableName, TableDefinition<T> def,
Object obj);
/**
* Append "LIMIT limit OFFSET offset" to the SQL statement.
*
* @param stat
* the statement
* @param limit
* the limit
* @param offset
* the offset
*/
void appendLimitOffset(SQLStatement stat, long limit, long offset);
/**
* Returns the preferred DATETIME class for the database.
* <p>
* Either java.util.Date or java.sql.Timestamp
*
* @return preferred DATETIME class
*/
Class<? extends java.util.Date> getDateTimeClass();
/**
* When building static string statements this method flattens an object to
* a string representation suitable for a static string statement.
*
* @param o
* @return the string equivalent of this object
*/
String prepareParameter(Object o);
}
|
