JDBC4FabricMySQLConnection.java
3.26 KB
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
/*
Copyright (c) 2013, 2014, Oracle and/or its affiliates. All rights reserved.
The MySQL Connector/J is licensed under the terms of the GPLv2
<http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most MySQL Connectors.
There are special exceptions to the terms and conditions of the GPLv2 as it is applied to
this software, see the FOSS License Exception
<http://www.mysql.com/about/legal/licensing/foss-exception.html>.
This program is free software; you can redistribute it and/or modify it under the terms
of the GNU General Public License as published by the Free Software Foundation; version 2
of the License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this
program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth
Floor, Boston, MA 02110-1301 USA
*/
package com.mysql.fabric.jdbc;
import java.sql.SQLException;
import java.util.Set;
import com.mysql.fabric.Server;
import com.mysql.fabric.ServerGroup;
public interface JDBC4FabricMySQLConnection extends com.mysql.jdbc.JDBC4MySQLConnection {
/**
* Clear all the state that is used to determine which server to
* send queries to.
*/
void clearServerSelectionCriteria() throws SQLException;
/**
* Set the shard key for the data being accessed.
*/
void setShardKey(String shardKey) throws SQLException;
/**
* Get the shard key for the data being accessed.
*/
String getShardKey();
/**
* Set the table being accessed. Can be a table name or a
* "database.table" pair. The table must be known by Fabric
* as a sharded table.
*/
void setShardTable(String shardTable) throws SQLException;
/**
* Get the table being accessed.
*/
String getShardTable();
/**
* Set the server group name to connect to. Direct server group selection
* is mutually exclusive of sharded data access.
*/
void setServerGroupName(String serverGroupName) throws SQLException;
/**
* Get the server group name when using direct server group selection.
*/
String getServerGroupName();
/**
* Get the current server group.
*
* @returns The currently chosen group if sufficient server group selection
* criteria has been provided. Otherwise null.
*/
ServerGroup getCurrentServerGroup();
/**
* Clear the list of tables for the last query. This also clears the
* shard mapping/table and must be given again for the next query via {@link setShardTable} or {@addQueryTable}.
*/
void clearQueryTables() throws SQLException;
/**
* Add a table to the set of tables used for the next query on this connection.
* This is used for:
* <ul>
* <li>Choosing a shard given the tables used</li>
* <li>Preventing cross-shard queries</li>
* </ul>
*/
void addQueryTable(String tableName) throws SQLException;
/**
* The set of tables to be used in the next query on this connection.
*/
Set<String> getQueryTables();
}