README
¶
-
添加
GOINSEVURE环境变量GOINSECURE=gitlab.cloudwave.cn //此处设置私库域名
-
关闭vpn，不然可能会出现下面的错误
注意：如果本地浏览器访问 127.0.0.1能看到gitlab，使用proxy.cloudwave.cn却访问不到，这时请把vpn关掉，重启goland所有的窗口
Go-CloudWave-Driver
A CloudWave-Driver for Go's database/sql package
Features
- Lightweight and fast
- Native Go implementation. No C-bindings, just pure Go
- Connections over TCP/IPv4, TCP/IPv6, Unix domain sockets or custom protocols
- Automatic handling of broken connections
- Automatic Connection Pooling (by database/sql package)
- Supports queries larger than 16MB
- Full
sql.RawBytessupport. - Intelligent
LONG DATAhandling in prepared statements - Secure
LOAD DATA LOCAL INFILEsupport with file allowlisting andio.Readersupport - Optional
time.Timeparsing - Optional placeholder interpolation
Requirements
- Go 1.13 or higher. We aim to support the 3 latest versions of Go.
- MySQL (4.1+), MariaDB, Percona Server, Google CloudSQL or Sphinx (2.2.3+)
Installation
Simple install the package to your $GOPATH with the go tool from shell:
$ go get -u github.com/go-sql-driver/mysql
Make sure Git is installed on your machine and in your system's PATH.
Usage
Go CloudWave Driver is an implementation of Go's database/sql/driver interface. You only need to import the driver and can use the full database/sql API then.
Use mysql as driverName and a valid DSN as dataSourceName:
import (
"database/sql"
"time"
_ "github.com/CloudwaveDatabase/database_sql_cloudwave"
)
// ...
db, err := sql.Open("cloudwave", "user:password@/dbname")
if err != nil {
panic(err)
}
// See "Important settings" section.
db.SetConnMaxLifetime(time.Minute * 3)
db.SetMaxOpenConns(10)
db.SetMaxIdleConns(10)
Examples are available in our Wiki.
Important settings
db.SetConnMaxLifetime() is required to ensure connections are closed by the driver safely before connection is closed by MySQL server, OS, or other middlewares. Since some middlewares close idle connections by 5 minutes, we recommend timeout shorter than 5 minutes. This setting helps load balancing and changing system variables too.
db.SetMaxOpenConns() is highly recommended to limit the number of connection used by the application. There is no recommended limit number because it depends on application and MySQL server.
db.SetMaxIdleConns() is recommended to be set same to db.SetMaxOpenConns(). When it is smaller than SetMaxOpenConns(), connections can be opened and closed much more frequently than you expect. Idle connections can be closed by the db.SetConnMaxLifetime(). If you want to close idle connections more rapidly, you can use db.SetConnMaxIdleTime() since Go 1.15.
DSN (Data Source Name)
The Data Source Name has a common format, like e.g. PEAR DB uses it, but without type-prefix (optional parts marked by squared brackets):
[username[:password]@][protocol[(address)]]/dbname[?param1=value1&...¶mN=valueN]
A DSN in its fullest form:
username:password@protocol(address)/dbname?param=value
Except for the databasename, all values are optional. So the minimal DSN is:
/dbname
If you do not want to preselect a database, leave dbname empty:
/
This has the same effect as an empty DSN string:
Alternatively, Config.FormatDSN can be used to create a DSN string by filling a struct.
Password
Passwords can consist of any character. Escaping is not necessary.
Protocol
See net.Dial for more information which networks are available. In general you should use an Unix domain socket if available and TCP otherwise for best performance.
Address
For TCP and UDP networks, addresses have the form host[:port].
If port is omitted, the default port will be used.
If host is a literal IPv6 address, it must be enclosed in square brackets.
The functions net.JoinHostPort and net.SplitHostPort manipulate addresses in this form.
For Unix domain sockets the address is the absolute path to the MySQL-Server-socket, e.g. /var/run/mysqld/mysqld.sock or /tmp/mysql.sock.
Parameters
Parameters are case-sensitive!
Notice that any of true, TRUE, True or 1 is accepted to stand for a true boolean value. Not surprisingly, false can be specified as any of: false, FALSE, False or 0.
allowAllFiles
Type: bool
Valid Values: true, false
Default: false
allowAllFiles=true disables the file allowlist for LOAD DATA LOCAL INFILE and allows all files.
Might be insecure!
allowCleartextPasswords
Type: bool
Valid Values: true, false
Default: false
allowCleartextPasswords=true allows using the cleartext client side plugin if required by an account, such as one defined with the PAM authentication plugin. Sending passwords in clear text may be a security problem in some configurations. To avoid problems if there is any possibility that the password would be intercepted, clients should connect to MySQL Server using a method that protects the password. Possibilities include TLS / SSL, IPsec, or a private network.
allowNativePasswords
Type: bool
Valid Values: true, false
Default: true
allowNativePasswords=false disallows the usage of MySQL native password method.
allowOldPasswords
Type: bool
Valid Values: true, false
Default: false
allowOldPasswords=true allows the usage of the insecure old password method. This should be avoided, but is necessary in some cases. See also the old_passwords wiki page.
charset
Type: string
Valid Values: <name>
Default: none
Sets the charset used for client-server interaction ("SET NAMES <value>"). If multiple charsets are set (separated by a comma), the following charset is used if setting the charset failes. This enables for example support for utf8mb4 (introduced in MySQL 5.5.3) with fallback to utf8 for older servers (charset=utf8mb4,utf8).
Usage of the charset parameter is discouraged because it issues additional queries to the server.
Unless you need the fallback behavior, please use collation instead.
checkConnLiveness
Type: bool
Valid Values: true, false
Default: true
On supported platforms connections retrieved from the connection pool are checked for liveness before using them. If the check fails, the respective connection is marked as bad and the query retried with another connection.
checkConnLiveness=false disables this liveness check of connections.
collation
Type: string
Valid Values: <name>
Default: utf8mb4_general_ci
Sets the collation used for client-server interaction on connection. In contrast to charset, collation does not issue additional queries. If the specified collation is unavailable on the target server, the connection will fail.
A list of valid charsets for a server is retrievable with SHOW COLLATION.
The default collation (utf8mb4_general_ci) is supported from MySQL 5.5. You should use an older collation (e.g. utf8_general_ci) for older MySQL.
Collations for charset "ucs2", "utf16", "utf16le", and "utf32" can not be used (ref).
clientFoundRows
Type: bool
Valid Values: true, false
Default: false
clientFoundRows=true causes an UPDATE to return the number of matching rows instead of the number of rows changed.
columnsWithAlias
Type: bool
Valid Values: true, false
Default: false
When columnsWithAlias is true, calls to sql.Rows.Columns() will return the table alias and the column name separated by a dot. For example:
SELECT u.id FROM users as u
will return u.id instead of just id if columnsWithAlias=true.
interpolateParams
Type: bool
Valid Values: true, false
Default: false
If interpolateParams is true, placeholders (?) in calls to db.Query() and db.Exec() are interpolated into a single query string with given parameters. This reduces the number of roundtrips, since the driver has to prepare a statement, execute it with given parameters and close the statement again with interpolateParams=false.
This can not be used together with the multibyte encodings BIG5, CP932, GB2312, GBK or SJIS. These are rejected as they may introduce a SQL injection vulnerability!
loc
Type: string
Valid Values: <escaped name>
Default: UTC
Sets the location for time.Time values (when using parseTime=true). "Local" sets the system's location. See time.LoadLocation for details.
Note that this sets the location for time.Time values but does not change MySQL's time_zone setting. For that see the time_zone system variable, which can also be set as a DSN parameter.
Please keep in mind, that param values must be url.QueryEscape'ed. Alternatively you can manually replace the / with %2F. For example US/Pacific would be loc=US%2FPacific.
maxAllowedPacket
Type: decimal number
Default: 4194304
Max packet size allowed in bytes. The default value is 4 MiB and should be adjusted to match the server settings. maxAllowedPacket=0 can be used to automatically fetch the max_allowed_packet variable from server on every connection.
multiStatements
Type: bool
Valid Values: true, false
Default: false
Allow multiple statements in one query. While this allows batch queries, it also greatly increases the risk of SQL injections. Only the result of the first query is returned, all other results are silently discarded.
When multiStatements is used, ? parameters must only be used in the first statement.
parseTime
Type: bool
Valid Values: true, false
Default: false
parseTime=true changes the output type of DATE and DATETIME values to time.Time instead of []byte / string
The date or datetime like 0000-00-00 00:00:00 is converted into zero value of time.Time.
readTimeout
Type: duration
Default: 0
I/O read timeout. The value must be a decimal number with a unit suffix ("ms", "s", "m", "h"), such as "30s", "0.5m" or "1m30s".
rejectReadOnly
Type: bool
Valid Values: true, false
Default: false
rejectReadOnly=true causes the driver to reject read-only connections. This
is for a possible race condition during an automatic failover, where the mysql
client gets connected to a read-only replica after the failover.
Note that this should be a fairly rare case, as an automatic failover normally happens when the primary is down, and the race condition shouldn't happen unless it comes back up online as soon as the failover is kicked off. On the other hand, when this happens, a MySQL application can get stuck on a read-only connection until restarted. It is however fairly easy to reproduce, for example, using a manual failover on AWS Aurora's MySQL-compatible cluster.
If you are not relying on read-only transactions to reject writes that aren't supposed to happen, setting this on some MySQL providers (such as AWS Aurora) is safer for failovers.
Note that ERROR 1290 can be returned for a read-only server and this option will
cause a retry for that error. However the same error number is used for some
other cases. You should ensure your application will never cause an ERROR 1290
except for read-only mode when enabling this option.
serverPubKey
Type: string
Valid Values: <name>
Default: none
Server public keys can be registered with mysql.RegisterServerPubKey, which can then be used by the assigned name in the DSN.
Public keys are used to transmit encrypted data, e.g. for authentication.
If the server's public key is known, it should be set manually to avoid expensive and potentially insecure transmissions of the public key from the server to the client each time it is required.
timeout
Type: duration
Default: OS default
Timeout for establishing connections, aka dial timeout. The value must be a decimal number with a unit suffix ("ms", "s", "m", "h"), such as "30s", "0.5m" or "1m30s".
tls
Type: bool / string
Valid Values: true, false, skip-verify, preferred, <name>
Default: false
tls=true enables TLS / SSL encrypted connection to the server. Use skip-verify if you want to use a self-signed or invalid certificate (server side) or use preferred to use TLS only when advertised by the server. This is similar to skip-verify, but additionally allows a fallback to a connection which is not encrypted. Neither skip-verify nor preferred add any reliable security. You can use a custom TLS config after registering it with mysql.RegisterTLSConfig.
writeTimeout
Type: duration
Default: 0
I/O write timeout. The value must be a decimal number with a unit suffix ("ms", "s", "m", "h"), such as "30s", "0.5m" or "1m30s".
System Variables
Any other parameters are interpreted as system variables:
<boolean_var>=<value>:SET <boolean_var>=<value><enum_var>=<value>:SET <enum_var>=<value><string_var>=%27<value>%27:SET <string_var>='<value>'
Rules:
- The values for string variables must be quoted with
'. - The values must also be url.QueryEscape'ed!
(which implies values of string variables must be wrapped with
%27).
Examples:
autocommit=1:SET autocommit=1time_zone=%27Europe%2FParis%27:SET time_zone='Europe/Paris'transaction_isolation=%27REPEATABLE-READ%27:SET transaction_isolation='REPEATABLE-READ'
Examples
user@unix(/path/to/socket)/dbname
root:pw@unix(/tmp/mysql.sock)/myDatabase?loc=Local
user:password@tcp(localhost:5555)/dbname?tls=skip-verify&autocommit=true
Treat warnings as errors by setting the system variable sql_mode:
user:password@/dbname?sql_mode=TRADITIONAL
TCP via IPv6:
user:password@tcp([de:ad:be:ef::ca:fe]:80)/dbname?timeout=90s&collation=utf8mb4_unicode_ci
TCP on a remote host, e.g. Amazon RDS:
id:password@tcp(your-amazonaws-uri.com:3306)/dbname
Google Cloud SQL on App Engine:
user:password@unix(/cloudsql/project-id:region-name:instance-name)/dbname
TCP using default port (3306) on localhost:
user:password@tcp/dbname?charset=utf8mb4,utf8&sys_var=esc%40ped
Use the default protocol (tcp) and host (localhost:3306):
user:password@/dbname
No Database preselected:
user:password@/
Connection pool and timeouts
The connection pool is managed by Go's database/sql package. For details on how to configure the size of the pool and how long connections stay in the pool see *DB.SetMaxOpenConns, *DB.SetMaxIdleConns, and *DB.SetConnMaxLifetime in the database/sql documentation. The read, write, and dial timeouts for each individual connection are configured with the DSN parameters readTimeout, writeTimeout, and timeout, respectively.
ColumnType Support
This driver supports the ColumnType interface introduced in Go 1.8, with the exception of ColumnType.Length(), which is currently not supported. All Unsigned database type names will be returned UNSIGNED with INT, TINYINT, SMALLINT, BIGINT.
context.Context Support
Go 1.8 added database/sql support for context.Context. This driver supports query timeouts and cancellation via contexts.
See context support in the database/sql package for more details.
LOAD DATA LOCAL INFILE support
For this feature you need direct access to the package. Therefore you must change the import path (no _):
import "github.com/go-sql-driver/mysql"
Files must be explicitly allowed by registering them with mysql.RegisterLocalFile(filepath) (recommended) or the allowlist check must be deactivated by using the DSN parameter allowAllFiles=true (Might be insecure!).
To use a io.Reader a handler function must be registered with mysql.RegisterReaderHandler(name, handler) which returns a io.Reader or io.ReadCloser. The Reader is available with the filepath Reader::<name> then. Choose different names for different handlers and DeregisterReaderHandler when you don't need it anymore.
See the godoc of Go-CloudWave-Driver for details.
time.Time support
The default internal output type of MySQL DATE and DATETIME values is []byte which allows you to scan the value into a []byte, string or sql.RawBytes variable in your program.
However, many want to scan MySQL DATE and DATETIME values into time.Time variables, which is the logical equivalent in Go to DATE and DATETIME in MySQL. You can do that by changing the internal output type from []byte to time.Time with the DSN parameter parseTime=true. You can set the default time.Time location with the loc DSN parameter.
Caution: As of Go 1.1, this makes time.Time the only variable type you can scan DATE and DATETIME values into. This breaks for example sql.RawBytes support.
Unicode support
Since version 1.5 Go-CloudWave-Driver automatically uses the collation utf8mb4_general_ci by default.
Other collations / charsets can be set using the collation DSN parameter.
Version 1.0 of the driver recommended adding &charset=utf8 (alias for SET NAMES utf8) to the DSN to enable proper UTF-8 support. This is not necessary anymore. The collation parameter should be preferred to set another collation / charset than the default.
See http://dev.mysql.com/doc/refman/8.0/en/charset-unicode.html for more details on MySQL's Unicode support.
Testing / Development
To run the driver tests you may need to adjust the configuration. See the Testing Wiki-Page for details.
Go-CloudWave-Driver is not feature-complete yet. Your help is very appreciated. If you want to contribute, you can work on an open issue or review a pull request.
See the Contribution Guidelines for details.
License
Go-CloudWave-Driver is licensed under the Mozilla Public License Version 2.0
Mozilla summarizes the license scope as follows:
MPL: The copyleft applies to any files containing MPLed code.
That means:
- You can use the unchanged source code both in private and commercially.
- When distributing, you must publish the source code of any changed files licensed under the MPL 2.0 under a) the MPL 2.0 itself or b) a compatible license (e.g. GPL 3.0 or Apache License 2.0).
- You needn't publish the source code of your library as long as the files licensed under the MPL 2.0 are unchanged.
Please read the MPL 2.0 FAQ if you have further questions regarding the license.
You can read the full terms here: LICENSE.
Documentation
¶
Overview ¶
Package cloudwave provides a cloudwave driver for Go's database/sql package.
The driver should be used via the database/sql package:
import "database/sql"
import _ "github.com/CloudwaveDatabase/database_sql_cloudwave"
db, err := sql.Open("cloudwave", "user:password@/dbname")
See https://github.com/CloudwaveDatabase/database_sql_cloudwave#usage for details
Index ¶
- Constants
- Variables
- func DeregisterLocalFile(filePath string)
- func DeregisterReaderHandler(name string)
- func DeregisterServerPubKey(name string)
- func DeregisterTLSConfig(key string)
- func NewConnector(cfg *Config) (driver.Connector, error)
- func PullData(i int) []byte
- func ReadLengthEncodedString(b []byte) ([]byte, bool, int, error)
- func RegisterDial(network string, dial DialFunc)deprecated
- func RegisterDialContext(net string, dial DialContextFunc)
- func RegisterLocalFile(filePath string)
- func RegisterReaderHandler(name string, handler func() io.Reader)
- func RegisterServerPubKey(name string, pubKey *rsa.PublicKey)
- func RegisterTLSConfig(key string, config *tls.Config) error
- func SetLogger(logger Logger) error
- func Ucs2ToUtf8(ucs2 []byte, count int) ([]byte, int, error)
- func Utf8ToUcs2(utf8 []byte, utf8len int) ([]byte, int, int, error)
- type CloudBlob
- type CloudClob
- type CloudWaveDriver
- type CloudWaveError
- type Config
- type DialContextFunc
- type DialFuncdeprecated
- type Expand
- func (e *Expand) Chat(hisstring []string, inputText string) (string, error)
- func (e *Expand) ChatResult() (string, error)
- func (e Expand) CloseStatement(int32) error
- func (e Expand) CreateStatement() (int32, error)
- func (e *Expand) NextStreamingChat() (string, error)
- func (e Expand) Open(dsn string) (driver.Conn, error)
- func (e *Expand) QueryKnowledge(hisstring []string, inputText string) (string, error)
- func (e *Expand) StreamingChat(hisstring []string, inputText string) (string, error)
- func (e *Expand) StreamingChatBegin(dns string) error
- func (e *Expand) StreamingChatEnd()
- func (e *Expand) StreamingChatType(chattype string)
- func (e *Expand) UseSchema(schemaname string) error
- type Logger
- type NullTimedeprecated
Constants ¶
const ( INT_MIN_VALUE = 0x80000000 INT_MAX_VALUE = 0x7fffffff LONG_MIN_VALUE = 0x8000000000000000 LONG_MAX_VALUE = 0x7fffffffffffffff INT_CHUNK_SIZE = 8192 )
const ( BIT = -7 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code TINYINT}. */ TINYINT = -6 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code SMALLINT}. */ SMALLINT = 5 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code INTEGER}. */ INTEGER = 4 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code BIGINT}. */ BIGINT = -5 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code FLOAT}. */ FLOAT = 6 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code REAL}. */ REAL = 7 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code DOUBLE}. */ DOUBLE = 8 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code NUMERIC}. */ NUMERIC = 2 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code DECIMAL}. */ DECIMAL = 3 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code CHAR}. */ CHAR = 1 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code VARCHAR}. */ VARCHAR = 12 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code LONGVARCHAR}. */ LONGVARCHAR = -1 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code DATE}. */ DATE = 91 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code TIME}. */ TIME = 92 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code TIMESTAMP}. */ TIMESTAMP = 93 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code BINARY}. */ BINARY = -2 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code VARBINARY}. */ VARBINARY = -3 /** * <P>The constant in the Java programming language, sometimes referred * to as a type code, that identifies the generic SQL type * {@code LONGVARBINARY}. */ LONGVARBINARY = -4 /** * <P>The constant in the Java programming language * that identifies the generic SQL value * {@code NULL}. */ NULL = 0 /** * The constant in the Java programming language that indicates * that the SQL type is database-specific and * gets mapped to a Java object that can be accessed via * the methods {@code getObject} and {@code setObject}. */ OTHER = 1111 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type * {@code JAVA_OBJECT}. * @since 1.2 */ JAVA_OBJECT = 2000 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type * {@code DISTINCT}. * @since 1.2 */ DISTINCT = 2001 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type * {@code STRUCT}. * @since 1.2 */ STRUCT = 2002 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type * {@code ARRAY}. * @since 1.2 */ ARRAY = 2003 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type * {@code BLOB}. * @since 1.2 */ BLOB = 2004 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type * {@code CLOB}. * @since 1.2 */ CLOB = 2005 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type * {@code REF}. * @since 1.2 */ REF = 2006 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type {@code DATALINK}. * * @since 1.4 */ DATALINK = 70 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type {@code BOOLEAN}. * * @since 1.4 */ BOOLEAN = 16 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type {@code ROWID} * * @since 1.6 * */ ROWID = -8 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type {@code NCHAR} * * @since 1.6 */ NCHAR = -15 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type {@code NVARCHAR}. * * @since 1.6 */ NVARCHAR = -9 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type {@code LONGNVARCHAR}. * * @since 1.6 */ LONGNVARCHAR = -16 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type {@code NCLOB}. * * @since 1.6 */ NCLOB = 2011 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type {@code XML}. * * @since 1.6 */ SQLXML = 2009 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type {@code REF CURSOR}. * * @since 1.8 */ REF_CURSOR = 2012 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type * {@code TIME WITH TIMEZONE}. * * @since 1.8 */ TIME_WITH_TIMEZONE = 2013 /** * The constant in the Java programming language, sometimes referred to * as a type code, that identifies the generic SQL type * {@code TIMESTAMP WITH TIMEZONE}. * * @since 1.8 */ TIMESTAMP_WITH_TIMEZONE = 2014 )
const ( //ODBC CLOUD_TYPE_INTEGER = 0 CLOUD_TYPE_CHAR = 1 CLOUD_TYPE_VARCHAR = 2 CLOUD_TYPE_FLOAT = 3 CLOUD_TYPE_DOUBLE = 4 CLOUD_TYPE_DATE = 5 CLOUD_TYPE_TIME = 6 CLOUD_TYPE_TIMESTAMP = 7 CLOUD_TYPE_BOOLEAN = 8 CLOUD_TYPE_ARRAY = 9 CLOUD_TYPE_TINY_DECIMAL = 10 CLOUD_TYPE_SMALL_DECIMAL = 11 CLOUD_TYPE_BIG_DECIMAL = 12 CLOUD_TYPE_SINGLE_CHAR = 13 CLOUD_TYPE_BINARY = 14 CLOUD_TYPE_VARBINARY = 15 CLOUD_TYPE_SINGLE_BYTE = 16 CLOUD_TYPE_LONG = 17 CLOUD_TYPE_INTERVAL = 18 CLOUD_TYPE_REVERSE = 19 CLOUD_TYPE_BLOB = 20 CLOUD_TYPE_CLOB = 21 CLOUD_TYPE_LONGVARBINARY = 22 CLOUD_TYPE_LONGVARCHAR = 23 CLOUD_TYPE_ROWID = 24 CLOUD_TYPE_BIG_INTEGER = 25 CLOUD_TYPE_SMALL_INTEGER = 26 CLOUD_TYPE_TINY_INTEGER = 27 CLOUD_TYPE_DAY_TIME_INTERVAL = 28 CLOUD_TYPE_YEAR_MONTH_INTERVAL = 29 CLOUD_TYPE_TIME_INTERVAL = 30 CLOUD_TYPE_PAIR = 31 CLOUD_TYPE_BYTE = 32 CLOUD_TYPE_BFILE = 33 //3.6.6 JDBC CLOUD_TYPE_INTS = 34 CLOUD_TYPE_JAVA_STRING = 35 CLOUD_TYPE_X1_LONG = 36 CLOUD_TYPE_X2_LONG = 37 CLOUD_TYPE_X_LONG = 38 CLOUD_TYPE_X_BYTES = 39 CLOUD_TYPE_RANGE_STRING = 40 CLOUD_TYPE_DEFAULT = 41 CLOUD_TYPE_RANK = 42 CLOUD_TYPE_COLLECTOR_SELECTION = 43 CLOUD_TYPE_GROUPING = 44 CLOUD_TYPE_NULL = 45 CLOUD_TYPE_NOTHING = 46 CLOUD_TYPE_MEDIA = 47 CLOUD_TYPE_FISCAL_YEAR = 48 CLOUD_TYPE_FISCAL_QUARTER = 49 CLOUD_TYPE_YEAR_MONTH = 50 CLOUD_TYPE_YEAR_MONTH_DAY = 51 CLOUD_TYPE_NUMBER = 52 //2021.9.12 HU give wei JDBC CLOUD_TYPE_DOUBLE_LONG = 53 CLOUD_TYPE_COMPACT_DATE = 54 CLOUD_TYPE_SHARED_COLUMN = 55 CLOUD_TYPE_ZONE_AUTO_SEQUENCE = 56 CLOUD_TYPE_JSON_ARRAY = 57 CLOUD_TYPE_JSON_KEYWORD = 58 CLOUD_TYPE_JSON_BINARY = 59 CLOUD_TYPE_JSON_TEXT = 60 CLOUD_TYPE_JSON_OBJECT = 61 CLOUD_TYPE_JSON_BIGDECIMAL = 62 CLOUD_TYPE_OTHER = -1 )
const ( CLOUDWAVE_EXECUTE = 0 CLOUDWAVE_EXECUTE_UPDATE = 1 CLOUDWAVE_EXECUTE_QUERY = 2 CLOUDWAVE_SELFUSEDRIVE = 0xff )
for cloudwave
const ( B_REQ_TAG byte = 0x02 E_REQ_TAG byte = 0x03 B_REQ_BUILD_CONNECTION = -1 B_REQ_CLOSE_CONNECTION = -2 B_REQ_PING = -3 B_REQ_STOP_SERVER = -4 B_REQ_BFILE_WRITE = -5 B_REQ_BFILE_READ = -6 B_REQ_BFILE_CREATE = -7 B_REQ_BFILE_SYNC = -8 B_REQ_BFILE_GETBYNAME = -9 B_REQ_BFILE_GETALL = -10 B_REQ_BFILE_GET_SEGMENT_TABLET_SERVER = -11 B_REQ_BFILE_DELETE = -12 B_REQ_TABLET_SERVER_CONNECT = -13 B_REQ_BFILE_CLOSE = -14 B_REQ_BFILE_GET_BY_ID = -15 B_REQ_BFILE_BATCH_WRITE = -16 B_REQ_BFILE_BATCH_CREATE = -17 B_REQ_BFILE_NFSBFILE_CREATE = -18 B_REQ_BFILE_GET_NFSBFILE_INPUTSTREAM = -19 B_REQ_GET_NEXT_TABLET_SERVER = -31 B_REQ_AUTO_TABLET_INSERT_FILES = -32 B_REQ_AUTO_TABLET_SYNC = -33 CONNECTION_SET_AUTO_COMMIT = 1 CONNECTION_CREATE_STATEMENT = 2 CONNECTION_CREATE_BLOB = 3 CONNECTION_CREATE_CLOB = 4 CLOSE_STATEMENT = 5 EXECUTE_STATEMENT = 6 EXECUTE_BATCH = 7 CONNECTION_PREPARED_STATEMENT = 8 CLOSE_PREPARED_STATEMENT = 9 EXECUTE_PREPARED_STATEMENT = 10 RESULT_SET_QUERY_NEXT = 11 RESULT_SET_QUERY_PREV = 12 RESULT_SET_RESOVE_LARGE_STRING_REF = 13 RESULT_SET_CLOSE = 14 DATABASE_META_DATA_GET_SCHEMAS = 15 DATABASE_META_DATA_GET_TABLESPACES = 16 DATABASE_META_DATA_GET_TABLES = 17 DATABASE_META_DATA_GET_TABLE_PRIVILEGES = 18 DATABASE_META_DATA_GET_USER_TABLE_PRIVILEGES = 19 DATABASE_META_DATA_GET_COLUMNS = 20 DATABASE_META_DATA_GET_PRIMARY_KEYS = 21 DATABASE_META_DATA_GET_EXPORTED_KEYS = 22 DATABASE_META_DATA_GET_IMPORTED_KEYS = 23 DATABASE_META_DATA_GET_CATALOGS = 24 DATABASE_META_DATA_GET_USERS = 25 BLOB_GET_BINARY_STREAM = 26 CONNECTION_COMMIT = 27 CONNECTION_ROLLBACK = 28 LOB_READ_BUFFER = 29 LOB_WRITE_BUFFER = 30 LOB_GET_DATA_BLOCK_INFO = 31 BLOB_LENGTH = 32 BLOB_GET_BYTES = 33 BLOB_POSITION_BYTEARRAY_PATTERN = 34 BLOB_POSITION_BLOB_PATTERN = 35 BLOB_SET_BYTES = 36 BLOB_SET_BINARY_STREAM = 37 BLOB_TRUNCATE = 38 BLOB_FREE = 39 CLOB_FREE = 40 CLOB_READ = 41 CLOB_WRITE = 42 CLOB_GET_ASCII_STREAM = 43 CLOB_GET_CHARACTER_STREAM = 44 CLOB_GET_SUB_STRING = 45 CLOB_LENGTH = 46 CLOB_POSITION_STRING = 47 CLOB_POSITION_CLOB = 48 CLOB_SET_ASCII_STREAM = 49 CLOB_SET_CHARACTER_STREAM = 50 CLOB_SET_STRING = 51 CLOB_TRUNCATE = 52 DISPLAY = 53 CONNECTION_SHUT_DOWN_SERVER = 54 CLEAR_CACHE = 55 DATABASE_META_DATA_LIST_SCHEMAS = 56 DATABASE_META_DATA_LIST_TABLES = 57 EXECUTE_STATEMENT_BATCH_INSERT = 58 CONNECTION_CREATE_BLOBS = 59 CONNECTION_CREATE_CLOBS = 60 CONNECTION_SET_TABLET_SPLIT_THRESHOLD = 61 EXECUTE_BATCH_PREPARED = 62 DATABASE_META_DATA_GET_TYPE_INFO = 63 CREATE_FULL_TEXT_INDEX = 64 FULL_TEXT_SEARCH = 65 DELETE_FULL_TEXT_INDEX = 66 HIGHLIGHT = 67 RESULT_SET_GET_RECORD_COUNT = 68 RESULT_SET_GET_EXECUTION_INFO = 69 DATABASE_META_DATA_GET_SERVERS = 70 DATABASE_META_DATA_GET_TABLETS = 71 DATABASE_META_DATA_GET_SEQUENCES = 72 DATA_LOAD = 73 CHECK_POINT = 74 GET_TABLET_RESULT_SET = 75 GET_INFO_FROM_HDFS = 76 GET_CPU_INFO = 77 GET_HDFS_DATA_BLOCK_SIZE = 78 EXECUTE_GC = 79 GET_RUNNING_SQL = 80 GET_RUNNING_TASK = 81 GET_ONLINE_USER = 82 GET_CACHE = 83 SET_TRANSACTION_ISOLATION = 84 CREATE_UDF = 85 DELETE_UDF = 86 GET_UDF_CLASS_NAME = 87 GET_UDF_METHOD_NAMES = 88 CONNECTION_CALLABLE_STATEMENT = 89 EXECUTE_CALLABLE_STATEMENT = 90 DATABASE_META_DATA_GET_RECORD_COUNT_OF_ALL_TABLETS = 91 DATABASE_META_DATA_GET_TABLET_COUNT = 92 GET_THREAD_INFO = 93 GET_FULLTEXTINDEX_INFO = 94 SET_AUTO_TABLET_RECORDCOUNT = 95 RESULT_SET_GET_TABLET_IDS = 96 GET_INC_LOGS = 97 REDO_INC_LOGS = 98 DATABASE_META_DATA_GET_DB_FILES = 99 DATABASE_META_DATA_GET_DB_FILE_DATA = 100 INSERT_DB_FILE_DATA = 101 CLOSE_DB_FILE_OUTPUT = 102 GET_SERVER_VERSION = 103 CONNECTION_CANCEL_STATEMENT = 104 GET_TRANSACTION_ISOLATION = 105 DATABASE_META_DATA_GET_SYSTEM_UTILIZATION = 106 DATABASE_META_DATA_GET_MEMORY_SIZE = 107 GET_CONFIG_OPTIONS = 108 GET_SYSTEM_OVERVIEW = 109 CONNECTION_SET_CLIENT_PROPERTIES = 110 DATABASE_META_DATA_GET_SCHEMA_OWNER = 111 DATABASE_UPDATE_PATCH = 112 DATABASE_RESTART_SERVER = 113 DATABASE_META_DATA_GET_USER_PRIVILEGES = 114 GET_INDEX_INFO = 115 DATABASE_UPDATE_LICENSE = 116 GET_BFILE_TABLE_TOTAL_LENGTH = 117 GET_BFILE_CONTENT_TABLE_TOTAL_LENGTH = 118 GET_BFILE_CONTENT_TABLE_EVERY_LENGTH = 119 GET_INFO_FOR_MAP_REDUCE = 120 IS_BFILE_UFS_STORE = 121 EXECUTE_STATEMENT_4_MR = 122 GET_TEXTINDEX_INFO = 123 DATABASE_META_DATA_GET_UNIQUE_KEYS = 124 RELOAD_CONFIGURATION = 125 CONNECTION_SET_CHECK_CONSTRAINTS = 126 TABLE_GET_RECORDS_BY_PKS = 127 DATABASE_GET_SQL_HISTORYS = 128 DATABASE_SET_SHARE_QUERYAREA = 129 DATABASE_GET_RUNTIME_REPORT = 130 UPDATE_CONFIG_OPTIONS = 131 DATABASE_META_DATA_GET_NETWORK_STATUS = 132 DATABASE_HEALTH_DIAGNOSTIC = 133 DATABASE_META_DATA_GET_COLUMNS_DEFAULT = 134 DATABASE_GET_SQL_STATISTICS = 135 RESULT_SET_GET_DISTRIBUTION = 136 RESULT_SET_GET_EXECUTION_STATISTICS = 137 RESULT_SET_GET_TABLET_PARTITION_IDS = 138 AUTO_TABLET_APPEND = 139 GET_SERVER_LOGGER = 140 DATABASE_COLLECT_LOGGER = 141 DATABASE_META_DATA_GET_TABLE_TYPES = 142 SET_FULLTEXT_INDEX_IS_AND_OPERATOR = 143 GET_FULLTEXT_INDEX_IS_AND_OPERATOR = 144 DATABASE_META_DATA_GET_SYNONYM_COLUMNS = 145 GET_SYNONYM_HINTS = 146 CONNECTION_SET_ENABLE_SAME_COLUMN_LINK = 147 GET_ALL_DOWNLEVELS = 148 DATABASE_META_DATA_GET_TABLE_SYNONYMS = 149 DATABASE_META_DATA_GET_TABLE_BASESEARCH_COLUMNS = 150 DATABASE_META_DATA_GET_LINK_KEYS = 151 GET_DOWNLEVEL_CHAINS = 152 DATABASE_META_DATA_GET_SCHEMA_FILES = 153 REFRESH = 154 SET_SCHEMA = 155 DATABASE_META_DATA_GET_SHARES = 156 GET_ZONE_SERVERS = 157 CREATE_TABLET = 158 EXECUTE_CHAT = 166 EXECUTE_STREAMING_CHAT = 167 GET_CHAT_RESULT = 173 QUERY_KNOWLEDGE = 174 )
for cloudwave
const DATAAREALEN = 32
const DataAvailableTime = 3 //Seconds
const END_OF_STREAMING_CHAT = "__end_of_streaming_chat__"
Variables ¶
var ( ErrInvalidConn = errors.New("invalid connection") ErrMalformPkt = errors.New("malformed packet") ErrNoTLS = errors.New("TLS requested but server does not support TLS") ErrCleartextPassword = errors.New("this user requires clear text authentication. If you still want to use it, please add 'allowCleartextPasswords=1' to your DSN") ErrNativePassword = errors.New("this user requires cloudwave native password authentication.") ErrOldPassword = errors.New("this user requires old password authentication. If you still want to use it, please add 'allowOldPasswords=1' to your DSN. See also https://github.com/CloudwaveDatabase/database_sql_cloudwave/wiki/old_passwords") ErrUnknownPlugin = errors.New("this authentication plugin is not supported") ErrOldProtocol = errors.New("CloudWave server does not support required protocol 41+") ErrPktSync = errors.New("commands out of sync. You can't run this command now") ErrPktSyncMul = errors.New("commands out of sync. Did you run multiple statements at once?") ErrPktTooLarge = errors.New("packet for query is too large. Try adjusting the 'max_allowed_packet' variable on the server") ErrBusyBuffer = errors.New("busy buffer") )
Various errors the driver might return. Can change between driver versions.
Functions ¶
func DeregisterLocalFile ¶
func DeregisterLocalFile(filePath string)
DeregisterLocalFile removes the given filepath from the allowlist.
func DeregisterReaderHandler ¶
func DeregisterReaderHandler(name string)
DeregisterReaderHandler removes the ReaderHandler function with the given name from the registry.
func DeregisterServerPubKey ¶
func DeregisterServerPubKey(name string)
DeregisterServerPubKey removes the public key registered with the given name.
func DeregisterTLSConfig ¶
func DeregisterTLSConfig(key string)
DeregisterTLSConfig removes the tls.Config associated with key.
func NewConnector ¶
NewConnector returns new driver.Connector.
func ReadLengthEncodedString ¶
returns the string read as a bytes slice, wheter the value is NULL, the number of bytes read and an error, in case the string is longer than the input slice
func RegisterDial
deprecated
RegisterDial registers a custom dial function. It can then be used by the network address mynet(addr), where mynet is the registered new network. addr is passed as a parameter to the dial function.
Deprecated: users should call RegisterDialContext instead
func RegisterDialContext ¶
func RegisterDialContext(net string, dial DialContextFunc)
RegisterDialContext registers a custom dial function. It can then be used by the network address mynet(addr), where mynet is the registered new network. The current context for the connection and its address is passed to the dial function.
func RegisterLocalFile ¶
func RegisterLocalFile(filePath string)
RegisterLocalFile adds the given file to the file allowlist, so that it can be used by "LOAD DATA LOCAL INFILE <filepath>". Alternatively you can allow the use of all local files with the DSN parameter 'allowAllFiles=true'
filePath := "/home/gopher/data.csv"
cloudwave.RegisterLocalFile(filePath)
err := db.Exec("LOAD DATA LOCAL INFILE '" + filePath + "' INTO TABLE foo")
if err != nil {
...
func RegisterReaderHandler ¶
RegisterReaderHandler registers a handler function which is used to receive a io.Reader. The Reader can be used by "LOAD DATA LOCAL INFILE Reader::<name>". If the handler returns a io.ReadCloser Close() is called when the request is finished.
cloudwave.RegisterReaderHandler("data", func() io.Reader {
var csvReader io.Reader // Some Reader that returns CSV data
... // Open Reader here
return csvReader
})
err := db.Exec("LOAD DATA LOCAL INFILE 'Reader::data' INTO TABLE foo")
if err != nil {
...
func RegisterServerPubKey ¶
RegisterServerPubKey registers a server RSA public key which can be used to send data in a secure manner to the server without receiving the public key in a potentially insecure way from the server first. Registered keys can afterwards be used adding serverPubKey=<name> to the DSN.
Note: The provided rsa.PublicKey instance is exclusively owned by the driver after registering it and may not be modified.
data, err := ioutil.ReadFile("mykey.pem")
if err != nil {
log.Fatal(err)
}
block, _ := pem.Decode(data)
if block == nil || block.Type != "PUBLIC KEY" {
log.Fatal("failed to decode PEM block containing public key")
}
pub, err := x509.ParsePKIXPublicKey(block.Bytes)
if err != nil {
log.Fatal(err)
}
if rsaPubKey, ok := pub.(*rsa.PublicKey); ok {
cloudwave.RegisterServerPubKey("mykey", rsaPubKey)
} else {
log.Fatal("not a RSA public key")
}
func RegisterTLSConfig ¶
RegisterTLSConfig registers a custom tls.Config to be used with sql.Open. Use the key as a value in the DSN where tls=value.
Note: The provided tls.Config is exclusively owned by the driver after registering it.
rootCertPool := x509.NewCertPool()
pem, err := ioutil.ReadFile("/path/ca-cert.pem")
if err != nil {
log.Fatal(err)
}
if ok := rootCertPool.AppendCertsFromPEM(pem); !ok {
log.Fatal("Failed to append PEM.")
}
clientCert := make([]tls.Certificate, 0, 1)
certs, err := tls.LoadX509KeyPair("/path/client-cert.pem", "/path/client-key.pem")
if err != nil {
log.Fatal(err)
}
clientCert = append(clientCert, certs)
cloudwave.RegisterTLSConfig("custom", &tls.Config{
RootCAs: rootCertPool,
Certificates: clientCert,
})
db, err := sql.Open("cloudwave", "user@tcp(localhost:3306)/test?tls=custom")
Types ¶
type CloudBlob ¶
type CloudBlob struct {
// contains filtered or unexported fields
}
func (*CloudBlob) GetBlob_File ¶
type CloudClob ¶
type CloudClob struct {
// contains filtered or unexported fields
}
func (*CloudClob) GetClob_File ¶
type CloudWaveDriver ¶
type CloudWaveDriver struct{}
CloudWaveDriver is exported to make the driver directly accessible. In general the driver is used via the database/sql package.
func (CloudWaveDriver) Open ¶
func (d CloudWaveDriver) Open(dsn string) (driver.Conn, error)
Open new Connection. See https://github.com/go-sql-driver/mysql#dsn-data-source-name for how the DSN string is formatted
func (CloudWaveDriver) OpenConnector ¶
func (d CloudWaveDriver) OpenConnector(dsn string) (driver.Connector, error)
OpenConnector implements driver.DriverContext.
type CloudWaveError ¶
type CloudWaveError struct {
Message string
// contains filtered or unexported fields
}
CloudWaveError is an error type which represents a single MySQL error
func (*CloudWaveError) Error ¶
func (me *CloudWaveError) Error() string
func (*CloudWaveError) Is ¶
func (me *CloudWaveError) Is(err error) bool
type Config ¶
type Config struct {
User string // Username
Passwd string // Password (requires User)
Net string // Network type
Addr string // Network address (requires Net)
DBName string // Database name
Params map[string]string // Connection parameters
Collation string // Connection collation
Loc *time.Location // Location for time.Time values
MaxAllowedPacket int // Max packet size allowed
ServerPubKey string // Server public key name
TLSConfig string // TLS configuration name
Timeout time.Duration // Dial timeout
ReadTimeout time.Duration // I/O read timeout
WriteTimeout time.Duration // I/O write timeout
AllowAllFiles bool // Allow all files to be used with LOAD DATA LOCAL INFILE
AllowCleartextPasswords bool // Allows the cleartext client side plugin
AllowNativePasswords bool // Allows the native password authentication method
AllowOldPasswords bool // Allows the old insecure password method
CheckConnLiveness bool // Check connections for liveness before using them
ClientFoundRows bool // Return number of matching rows instead of rows changed
ColumnsWithAlias bool // Prepend table alias to column names
InterpolateParams bool // Interpolate placeholders into query string
MultiStatements bool // Allow multiple statements in one query
ParseTime bool // Parse time values to time.Time
RejectReadOnly bool // Reject read-only connections
// contains filtered or unexported fields
}
Config is a configuration parsed from a DSN string. If a new Config is created instead of being parsed from a DSN string, the NewConfig function should be used, which sets default values.
type DialContextFunc ¶
DialContextFunc is a function which can be used to establish the network connection. Custom dial functions must be registered with RegisterDialContext
type Expand ¶
type Expand struct {
//Dsn string
Db *sql.DB
StmtId int32
ChatType string
// contains filtered or unexported fields
}
func (*Expand) ChatResult ¶
func (Expand) CloseStatement ¶
func (Expand) CreateStatement ¶
func (*Expand) NextStreamingChat ¶
func (*Expand) QueryKnowledge ¶
func (*Expand) StreamingChat ¶
func (*Expand) StreamingChatBegin ¶
func (*Expand) StreamingChatEnd ¶
func (e *Expand) StreamingChatEnd()
func (*Expand) StreamingChatType ¶
type Logger ¶
type Logger interface {
Print(v ...interface{})
}
Logger is used to log critical error messages.
type NullTime
deprecated
NullTime represents a time.Time that may be NULL. NullTime implements the Scanner interface so it can be used as a scan destination:
var nt NullTime
err := db.QueryRow("SELECT time FROM foo WHERE id=?", id).Scan(&nt)
...
if nt.Valid {
// use nt.Time
} else {
// NULL value
}
This NullTime implementation is not driver-specific ¶
Deprecated: NullTime doesn't honor the loc DSN parameter. NullTime.Scan interprets a time as UTC, not the loc DSN parameter. Use sql.NullTime instead.
Source Files
Directories