forked from redpanda-data/connect
-
Notifications
You must be signed in to change notification settings - Fork 0
/
conn_fields.go
240 lines (207 loc) · 10.1 KB
/
conn_fields.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
package sql
import (
"context"
"database/sql"
"fmt"
"net/url"
"strings"
"sync"
"time"
"github.com/benthosdev/benthos/v4/internal/filepath"
"github.com/benthosdev/benthos/v4/internal/filepath/ifs"
"github.com/benthosdev/benthos/v4/public/service"
)
var driverField = service.NewStringEnumField("driver", "mysql", "postgres", "clickhouse", "mssql", "sqlite", "oracle", "snowflake", "trino").
Description("A database [driver](#drivers) to use.")
var dsnField = service.NewStringField("dsn").
Description(`A Data Source Name to identify the target database.
#### Drivers
The following is a list of supported drivers, their placeholder style, and their respective DSN formats:
| Driver | Data Source Name Format |
|---|---|
` + "| `clickhouse` | [`clickhouse://[username[:password]@][netloc][:port]/dbname[?param1=value1&...¶mN=valueN]`](https://github.com/ClickHouse/clickhouse-go#dsn) |" + `
` + "| `mysql` | `[username[:password]@][protocol[(address)]]/dbname[?param1=value1&...¶mN=valueN]` |" + `
` + "| `postgres` | `postgres://[user[:password]@][netloc][:port][/dbname][?param1=value1&...]` |" + `
` + "| `mssql` | `sqlserver://[user[:password]@][netloc][:port][?database=dbname¶m1=value1&...]` |" + `
` + "| `sqlite` | `file:/path/to/filename.db[?param&=value1&...]` |" + `
` + "| `oracle` | `oracle://[username[:password]@][netloc][:port]/service_name?server=server2&server=server3` |" + `
` + "| `snowflake` | `username[:password]@account_identifier/dbname/schemaname[?param1=value&...¶mN=valueN]` |" + `
` + "| `trino` | [`http[s]://user[:pass]@host[:port][?parameters]`](https://github.com/trinodb/trino-go-client#dsn-data-source-name)" + `
Please note that the ` + "`postgres`" + ` driver enforces SSL by default, you can override this with the parameter ` + "`sslmode=disable`" + ` if required.
The ` + "`snowflake`" + ` driver supports multiple DSN formats. Please consult [the docs](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#hdr-Connection_String) for more details. For [key pair authentication](https://docs.snowflake.com/en/user-guide/key-pair-auth.html#configuring-key-pair-authentication), the DSN has the following format: ` + "`<snowflake_user>@<snowflake_account>/<db_name>/<schema_name>?warehouse=<warehouse>&role=<role>&authenticator=snowflake_jwt&privateKey=<base64_url_encoded_private_key>`" + `, where the value for the ` + "`privateKey`" + ` parameter can be constructed from an unencrypted RSA private key file ` + "`rsa_key.p8`" + ` using ` + "`openssl enc -d -base64 -in rsa_key.p8 | basenc --base64url -w0`" + ` (you can use ` + "`gbasenc`" + ` insted of ` + "`basenc`" + ` on OSX if you install ` + "`coreutils`" + ` via Homebrew). If you have a password-encrypted private key, you can decrypt it using ` + "`openssl pkcs8 -in rsa_key_encrypted.p8 -out rsa_key.p8`. Also, make sure fields such as the username are URL-encoded.").
Example("clickhouse://username:password@host1:9000,host2:9000/database?dial_timeout=200ms&max_execution_time=60").
Example("foouser:foopassword@tcp(localhost:3306)/foodb").
Example("postgres://foouser:foopass@localhost:5432/foodb?sslmode=disable").
Example("oracle://foouser:foopass@localhost:1521/service_name")
func connFields() []*service.ConfigField {
return []*service.ConfigField{
service.NewStringListField("init_files").
Description(`
An optional list of file paths containing SQL statements to execute immediately upon the first connection to the target database. This is a useful way to initialise tables before processing data. Glob patterns are supported, including super globs (double star).
Care should be taken to ensure that the statements are idempotent, and therefore would not cause issues when run multiple times after service restarts. If both ` + "`init_statement` and `init_files` are specified the `init_statement` is executed _after_ the `init_files`." + `
If a statement fails for any reason a warning log will be emitted but the operation of this component will not be stopped.
`).
Example([]any{`./init/*.sql`}).
Example([]any{`./foo.sql`, `./bar.sql`}).
Optional().
Advanced().
Version("4.10.0"),
service.NewStringField("init_statement").
Description(`
An optional SQL statement to execute immediately upon the first connection to the target database. This is a useful way to initialise tables before processing data. Care should be taken to ensure that the statement is idempotent, and therefore would not cause issues when run multiple times after service restarts.
If both ` + "`init_statement` and `init_files` are specified the `init_statement` is executed _after_ the `init_files`." + `
If the statement fails for any reason a warning log will be emitted but the operation of this component will not be stopped.
`).
Example(`
CREATE TABLE IF NOT EXISTS some_table (
foo varchar(50) not null,
bar integer,
baz varchar(50),
primary key (foo)
) WITHOUT ROWID;
`).
Optional().
Advanced().
Version("4.10.0"),
service.NewDurationField("conn_max_idle_time").
Description(`An optional maximum amount of time a connection may be idle. Expired connections may be closed lazily before reuse. If value <= 0, connections are not closed due to a connection's idle time.`).
Optional().
Advanced(),
service.NewDurationField("conn_max_life_time").
Description(`An optional maximum amount of time a connection may be reused. Expired connections may be closed lazily before reuse. If value <= 0, connections are not closed due to a connection's age.`).
Optional().
Advanced(),
service.NewIntField("conn_max_idle").
Description(`An optional maximum number of connections in the idle connection pool. If conn_max_open is greater than 0 but less than the new conn_max_idle, then the new conn_max_idle will be reduced to match the conn_max_open limit. If value <= 0, no idle connections are retained. The default max idle connections is currently 2. This may change in a future release.`).
Default(2).
Optional().
Advanced(),
service.NewIntField("conn_max_open").
Description(`An optional maximum number of open connections to the database. If conn_max_idle is greater than 0 and the new conn_max_open is less than conn_max_idle, then conn_max_idle will be reduced to match the new conn_max_open limit. If value <= 0, then there is no limit on the number of open connections. The default is 0 (unlimited).`).
Optional().
Advanced(),
}
}
func rawQueryField() *service.ConfigField {
return service.NewStringField("query").
Description("The query to execute. The style of placeholder to use depends on the driver, some drivers require question marks (`?`) whereas others expect incrementing dollar signs (`$1`, `$2`, and so on). The style to use is outlined in this table:" + `
| Driver | Placeholder Style |
|---|---|
` + "| `clickhouse` | Dollar sign |" + `
` + "| `mysql` | Question mark |" + `
` + "| `postgres` | Dollar sign |" + `
` + "| `mssql` | Question mark |" + `
` + "| `sqlite` | Question mark |" + `
` + "| `oracle` | Colon |" + `
` + "| `snowflake` | Question mark |" + `
` + "| `trino` | Question mark |" + `
`)
}
type connSettings struct {
connMaxLifetime time.Duration
connMaxIdleTime time.Duration
maxIdleConns int
maxOpenConns int
initOnce sync.Once
initFileStatements [][2]string // (path,statement)
initStatement string
}
func (c *connSettings) apply(ctx context.Context, db *sql.DB, log *service.Logger) {
db.SetConnMaxIdleTime(c.connMaxIdleTime)
db.SetConnMaxLifetime(c.connMaxLifetime)
db.SetMaxIdleConns(c.maxIdleConns)
db.SetMaxOpenConns(c.maxOpenConns)
c.initOnce.Do(func() {
for _, fileStmt := range c.initFileStatements {
if _, err := db.ExecContext(ctx, fileStmt[1]); err != nil {
log.Warnf("Failed to execute init_file '%v': %v", fileStmt[0], err)
} else {
log.Debugf("Successfully ran init_file '%v'", fileStmt[0])
}
}
if c.initStatement != "" {
if _, err := db.ExecContext(ctx, c.initStatement); err != nil {
log.Warnf("Failed to execute init_statement: %v", err)
} else {
log.Debug("Successfully ran init_statement")
}
}
})
}
func connSettingsFromParsed(
conf *service.ParsedConfig,
mgr *service.Resources,
) (c *connSettings, err error) {
c = &connSettings{}
if conf.Contains("conn_max_life_time") {
if c.connMaxLifetime, err = conf.FieldDuration("conn_max_life_time"); err != nil {
return
}
}
if conf.Contains("conn_max_idle_time") {
if c.connMaxIdleTime, err = conf.FieldDuration("conn_max_idle_time"); err != nil {
return
}
}
if conf.Contains("conn_max_idle") {
if c.maxIdleConns, err = conf.FieldInt("conn_max_idle"); err != nil {
return
}
}
if conf.Contains("conn_max_open") {
if c.maxOpenConns, err = conf.FieldInt("conn_max_open"); err != nil {
return
}
}
if conf.Contains("init_statement") {
if c.initStatement, err = conf.FieldString("init_statement"); err != nil {
return
}
}
if conf.Contains("init_files") {
var tmpFiles []string
if tmpFiles, err = conf.FieldStringList("init_files"); err != nil {
return
}
if tmpFiles, err = filepath.Globs(mgr.FS(), tmpFiles); err != nil {
err = fmt.Errorf("failed to expand init_files glob patterns: %w", err)
return
}
for _, p := range tmpFiles {
var statementBytes []byte
if statementBytes, err = ifs.ReadFile(mgr.FS(), p); err != nil {
return
}
c.initFileStatements = append(c.initFileStatements, [2]string{
p, string(statementBytes),
})
}
}
return
}
func sqlOpenWithReworks(logger *service.Logger, driver, dsn string) (*sql.DB, error) {
if driver == "clickhouse" && strings.HasPrefix(dsn, "tcp") {
u, err := url.Parse(dsn)
if err != nil {
return nil, err
}
u.Scheme = "clickhouse"
uq := u.Query()
u.Path = uq.Get("database")
if username, password := uq.Get("username"), uq.Get("password"); username != "" {
if password != "" {
u.User = url.User(username)
} else {
u.User = url.UserPassword(username, password)
}
}
uq.Del("database")
uq.Del("username")
uq.Del("password")
u.RawQuery = uq.Encode()
newDSN := u.String()
logger.Warnf("Detected old-style Clickhouse Data Source Name: '%v', replacing with new style: '%v'", dsn, newDSN)
dsn = newDSN
}
return sql.Open(driver, dsn)
}