连接数据库
使用Go驱动时，调用Go sql的标准接口open创建数据库连接，返回一个连接对象，传入驱动名称和描述字符串。
函数原型
Go驱动提供了如下的方法用于生成一个数据库连接对象。
func Open(driverName, dataSourceName string) (*DB, error)
参数说明：
- driverName为驱动的名称，数据库的驱动名称为“gaussdb”。
- dataSourceName为连接的数据源，支持DSN和URL两种：
- DSN格式：key1 = value1 key2 = value2 …，每组关键字间使用空格隔开，等号左右的空格是可选的。
- URL格式：driverName://[userspec@][hostspec][/dbname][?paramspec]，
其中，driverName为驱动名称，数据库的驱动名称为“gaussdb”。
userspec表示user[:password]，需要注意的是使用URL进行连接时，密码中不可包含URL串中的分隔符。如果密码中包含分隔符的话，建议采用DSN格式。
hostspec表示[host][:port][,…]
dbname为数据库名称。注意：不允许使用初始化用户进行远程登录。paramspec为name=value[&…]。
- 在DSN格式中，对于多IP的场景：
- 当num(ip) = num(port)时，ip和port是一一对应匹配。
- 当num(ip) > num(port)时，无法匹配到port的ip均与第一个port匹配。例如，host = ip1, ip2, ip3 port = port1, port2的匹配情况为ip1:port1, ip2:port2, ip3:port1。
- 当num(ip) < num(port)时，则多余的port被舍弃，即使用不到。例如host = ip1, ip2, ip3 port = port1, port2, port3, port4的匹配情况为ip1:port1, ip2:port2, ip3:port3。
- 在URL格式中，对于多IP的场景：
- URL串中ip:port必须成对出现，即num(ip) = num(port)，并以逗号隔开。例如， gaussdb://user:password@ip1:port1, ip2:port2, ip3:port3/gaussdb。
- URL串中仅包含多ip，port由环境变量指定或采用默认值5432。例如gaussdb://user:password@ip1, ip2, ip3/gaussdb并设置环境变量PGPORT = "port1, port2"，其匹配情况为ip1:port1, ip2:port2, ip3:port1。未设置环境变量的匹配情况为ip1:5432,ip2:5432,ip3:5432。
- 若输入ip为ipv6格式，则URL格式连接串中需在ip两边增加'[]'，例如：gaussdb://user:password@[ip1]:port1, [ip2]:port2, [ip3]:port3/gaussdb。
参数
|
参数名称 |
参数说明 |
|---|---|
|
host |
主机IP地址，也可通过环境变量${PGHOST}来指定。 |
|
port |
主机服务器的端口号，也可通过环境变量${PGPORT}来指定。 |
|
dbname |
数据库名，也可通过环境变量${PGDATABASE}来指定。 |
|
user |
要连接的用户名，也可通过环境变量${PGUSER}来指定。 |
|
password |
要连接用户对应的连接密码。 |
|
connect_timeout |
用于连接服务器操作的超时值，也可通过环境变量${PGCONNECT_TIMEOUT}来指定。 |
|
sslmode |
启用SSL加密的方式，也可通过环境变量${PGSSLMODE}来指定。 参数取值范围：
|
|
sslkey |
指定用于客户端证书的密钥位置，如果需要使用SSL连接，并且该参数未指定，可通过设置环境变量${PGSSLKEY}来指定。 |
|
sslcert |
指定客户端SSL证书的文件名，或者通过设置环境变量${PGSSLCERT}来指定。 |
|
sslrootcert |
指定一个包含SSL证书机构（CA）证书的文件名称，或者通过设置环境变量${PGSSLROOTCERT}来指定。 |
|
sslcrl |
指定SSL证书撤销列表（CRL）的文件名。列在这个文件中的证书如果存在，在尝试认证该服务器证书时会被拒绝，从而连接失败。也可通过环境变量${PGSSLCRL}来指定。 |
|
sslpassword |
指定对密钥解密成明文的密码短语，当指定该参数的时候表示sslkey是一个加密存储的文件，当前sslkey支持des/aes加密方式。
说明：
DES加密算法安全性低，存在安全风险，建议使用更安全的加密算法。 |
|
disable_prepared_binary_result |
字符串类型，若设置为yes，表示此连接在从预准备语句接收查询结果时不应使用二进制格式。该参数仅用于调试。 取值范围：yes/no。 |
|
binary_parameters |
字符串类型，该参数表示是否始终以二进制形式发送[]byte。取值范围：yes/no。若该参数设置为yes，建议绑定参数按照[]byte绑定，可以减少内部类型转换。 |
|
target_session_attrs |
指定数据库的连接类型，该参数用于识别主备节点，也可通过环境变量${PGTARGETSESSIONATTRS}来指定。默认值为“any”，共有六种：any、master、slave、preferSlave、read-write、read-only。
|
|
loggerLevel |
日志级别，打印相关调试信息，也可通过环境变量${PGLOGGERLEVEL}来指定。 支持trace/debug/info/warn/error/none，级别从高到低。
说明：
日志或报错信息中若含有安全相关关键字（PASSWORD、GS_ENCRYPT、IDENTIFIED等），Go驱动会使用******代替相关信息。 |
|
application_name |
设置正在使用连接的GO驱动的名称。缺省值为go-driver，该参数不建议用户配置。 |
|
RuntimeParams |
设置连接会话时默认运行的set类型的guc参数的值。例如参数名search_path、application_name、timezone等。各参数的详细介绍参见客户端连接缺省设置，可通过show语法查看参数是否设置成功。 |
|
enable_ce |
密态数据库开关。enable_ce=1表示go驱动支持密态等值查询基本能力，enable_ce=3表示go驱动支持内存解密逃生通道，不设置或其他值表示不开启密态数据库。 |
|
key_info |
与enable_ce一起使用，在密态数据库中，用于设置访问外部密钥管理者的参数。 |
|
auto_sendtoken |
自动传输密钥模式开关。auto_sendtoken=yes表示在DB实例连接池connection初始化时自动触发密钥传输操作，设置为no或不设置表示关闭该模式。注意，该模式无法保证密钥信息及时更新，同时当且仅当设置enable_ce=3时该模式可以被开启。 |
|
tcp_syn_retries |
设置TCP连接的重试次数。若不设置此参数则与连接时设备上默认的重试次数一致。此参数建议设置时间小于connect_timeout设置时间。 |
|
socketTimeout |
设置读写超时时间，如果业务语句执行或者从网络读取数据流超过此阈值，连接中断（即语句超过规定时间执行，没有数据返回的时候）。
说明：
该参数限制单SQL最长的执行时间，单语句执行超过该值则会中断重连，建议根据业务特征进行配置，如果未配置，默认为0，即不会超时。 |
