-
Notifications
You must be signed in to change notification settings - Fork 754
/
cqlclient.go
306 lines (269 loc) · 9.64 KB
/
cqlclient.go
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package cassandra
import (
"context"
"errors"
"fmt"
"log"
"time"
"go.temporal.io/server/common/auth"
"go.temporal.io/server/common/config"
"go.temporal.io/server/common/persistence/nosql/nosqlplugin/cassandra/gocql"
"go.temporal.io/server/common/resolver"
"go.temporal.io/server/tools/common/schema"
)
type (
cqlClient struct {
nReplicas int
datacenter string
keyspace string
timeout time.Duration
session gocql.Session
}
// CQLClientConfig contains the configuration for cql client
CQLClientConfig struct {
Hosts string
Port int
User string
Password string
Keyspace string
Timeout int
numReplicas int
Datacenter string
TLS *auth.TLS
}
)
var errNoHosts = errors.New("Cassandra Hosts list is empty or malformed")
var errGetSchemaVersion = errors.New("Failed to get current schema version from cassandra")
const (
defaultTimeout = 30 // Timeout in seconds
systemKeyspace = "system"
)
const (
readSchemaVersionCQL = `SELECT curr_version from schema_version where keyspace_name=?`
listTablesCQL = `SELECT table_name from system_schema.tables where keyspace_name=?`
listTypesCQL = `SELECT type_name from system_schema.types where keyspace_name=?`
writeSchemaVersionCQL = `INSERT into schema_version(keyspace_name, creation_time, curr_version, min_compatible_version) VALUES (?,?,?,?)`
writeSchemaUpdateHistoryCQL = `INSERT into schema_update_history(year, month, update_time, old_version, new_version, manifest_md5, description) VALUES(?,?,?,?,?,?,?)`
createSchemaVersionTableCQL = `CREATE TABLE IF NOT EXISTS schema_version(keyspace_name text PRIMARY KEY, ` +
`creation_time timestamp, ` +
`curr_version text, ` +
`min_compatible_version text);`
createSchemaUpdateHistoryTableCQL = `CREATE TABLE IF NOT EXISTS schema_update_history(` +
`year int, ` +
`month int, ` +
`update_time timestamp, ` +
`description text, ` +
`manifest_md5 text, ` +
`new_version text, ` +
`old_version text, ` +
`PRIMARY KEY ((year, month), update_time));`
createKeyspaceCQL = `CREATE KEYSPACE IF NOT EXISTS %v ` +
`WITH replication = { 'class' : 'SimpleStrategy', 'replication_factor' : %v};`
createKeyspaceNetworkTopologyCQL = `CREATE KEYSPACE IF NOT EXISTS %v ` +
`WITH replication = { 'class' : 'NetworkTopologyStrategy', '%v' : %v};`
)
var _ schema.DB = (*cqlClient)(nil)
// newCQLClient returns a new instance of CQLClient
func newCQLClient(cfg *CQLClientConfig) (*cqlClient, error) {
var err error
cassandraConfig := cfg.toCassandraConfig()
cassandraConfig.ConnectTimeout = time.Duration(cfg.Timeout) * time.Second
log.Println("validating connection to cassandra cluster")
session, err := gocql.NewSession(*cassandraConfig, resolver.NewNoopResolver())
if err != nil {
log.Printf("connection validation failed: %+v\r\n", err)
return nil, err
}
log.Println("connection validation succeeded")
return &cqlClient{
keyspace: cfg.Keyspace,
nReplicas: cfg.numReplicas,
datacenter: cfg.Datacenter,
timeout: time.Duration(cfg.Timeout) * time.Second,
session: session,
}, nil
}
func (cfg *CQLClientConfig) toCassandraConfig() *config.Cassandra {
cassandraConfig := config.Cassandra{
Hosts: cfg.Hosts,
Port: cfg.Port,
User: cfg.User,
Password: cfg.Password,
Keyspace: cfg.Keyspace,
TLS: cfg.TLS,
Datacenter: cfg.Datacenter,
}
return &cassandraConfig
}
func (client *cqlClient) CreateDatabase(name string) error {
return client.createKeyspace(name)
}
func (client *cqlClient) DropDatabase(name string) error {
return client.dropKeyspace(name)
}
// createKeyspace creates a cassandra Keyspace if it doesn't exist
func (client *cqlClient) createKeyspace(name string) error {
if client.datacenter != "" {
log.Printf("Creating Keyspace %v using NetworkTopologyStrategy in Datacenter %v with RF=%v\n", name, client.datacenter, client.nReplicas)
return client.Exec(fmt.Sprintf(createKeyspaceNetworkTopologyCQL, name, client.datacenter, client.nReplicas))
}
log.Printf("Creating Keyspace %v using SimpleStrategy with RF=%v\n", name, client.nReplicas)
return client.Exec(fmt.Sprintf(createKeyspaceCQL, name, client.nReplicas))
}
// dropKeyspace drops a Keyspace
func (client *cqlClient) dropKeyspace(name string) error {
return client.Exec(fmt.Sprintf("DROP KEYSPACE IF EXISTS %v", name))
}
func (client *cqlClient) DropAllTables() error {
return client.dropAllTablesTypes()
}
// CreateSchemaVersionTables sets up the schema version tables
func (client *cqlClient) CreateSchemaVersionTables() error {
if err := client.Exec(createSchemaVersionTableCQL); err != nil {
return err
}
return client.Exec(createSchemaUpdateHistoryTableCQL)
}
// ReadSchemaVersion returns the current schema version for the Keyspace
func (client *cqlClient) ReadSchemaVersion() (string, error) {
query := client.session.Query(readSchemaVersionCQL, client.keyspace)
// when querying the DB schema version, override to local quorum
// in case Cassandra node down (compared to using ALL)
query.Consistency(gocql.LocalQuorum)
iter := query.Iter()
var version string
if !iter.Scan(&version) {
iter.Close()
return "", errGetSchemaVersion
}
if err := iter.Close(); err != nil {
return "", err
}
return version, nil
}
// UpdateShemaVersion updates the schema version for the Keyspace
func (client *cqlClient) UpdateSchemaVersion(newVersion string, minCompatibleVersion string) error {
query := client.session.Query(writeSchemaVersionCQL, client.keyspace, time.Now().UTC(), newVersion, minCompatibleVersion)
return query.Exec()
}
// WriteSchemaUpdateLog adds an entry to the schema update history table
func (client *cqlClient) WriteSchemaUpdateLog(oldVersion string, newVersion string, manifestMD5 string, desc string) error {
now := time.Now().UTC()
query := client.session.Query(writeSchemaUpdateHistoryCQL)
query.Bind(now.Year(), int(now.Month()), now, oldVersion, newVersion, manifestMD5, desc)
return query.Exec()
}
// Exec executes a cql statement
func (client *cqlClient) Exec(stmt string, args ...interface{}) error {
if err := client.session.Query(stmt, args...).Exec(); err != nil {
return err
}
return client.waitSchemaAgreement()
}
// Close closes the cql client
func (client *cqlClient) Close() {
if client.session != nil {
client.session.Close()
}
}
// ListTables lists the table names in a Keyspace
func (client *cqlClient) ListTables() ([]string, error) {
query := client.session.Query(listTablesCQL, client.keyspace)
iter := query.Iter()
var names []string
var name string
for iter.Scan(&name) {
names = append(names, name)
}
if err := iter.Close(); err != nil {
return nil, err
}
return names, nil
}
// listTypes lists the User defined types in a Keyspace
func (client *cqlClient) listTypes() ([]string, error) {
qry := client.session.Query(listTypesCQL, client.keyspace)
iter := qry.Iter()
var names []string
var name string
for iter.Scan(&name) {
names = append(names, name)
}
if err := iter.Close(); err != nil {
return nil, err
}
return names, nil
}
// dropTable drops a given table from the Keyspace
func (client *cqlClient) dropTable(name string) error {
return client.Exec(fmt.Sprintf("DROP TABLE %v", name))
}
// dropType drops a given type from the Keyspace
func (client *cqlClient) dropType(name string) error {
return client.Exec(fmt.Sprintf("DROP TYPE %v", name))
}
// dropAllTablesTypes deletes all tables/types in the
// Keyspace without deleting the Keyspace
func (client *cqlClient) dropAllTablesTypes() error {
tables, err := client.ListTables()
if err != nil {
return err
}
log.Printf("Dropping following tables: %v\n", tables)
for _, table := range tables {
err1 := client.dropTable(table)
if err1 != nil {
log.Printf("Error dropping table %v, err=%v\n", table, err1)
}
}
types, err := client.listTypes()
if err != nil {
return err
}
log.Printf("Dropping following types: %v\n", types)
numOfTypes := len(types)
for i := 0; i < numOfTypes && len(types) > 0; i++ {
var erroredTypes []string
for _, t := range types {
err = client.dropType(t)
if err != nil {
log.Printf("Error dropping type %v, err=%v\n", t, err)
erroredTypes = append(erroredTypes, t)
}
}
types = erroredTypes
}
if len(types) > 0 {
return err
}
return nil
}
// waitSchemaAgreement wait for schema change agreements
func (client *cqlClient) waitSchemaAgreement() error {
ctx, cancel := context.WithTimeout(context.Background(), client.timeout)
defer cancel()
return client.session.AwaitSchemaAgreement(ctx)
}