华为云用户手册

执行批处理 用一条预处理语句处理多条相似的数据，数据库只创建一次执行计划，节省了语句的编译和优化时间。可以按如下步骤执行： 调用Connection的prepareStatement方法创建预编译语句对象。 1 2 3 4 5 6 // 认证用的用户名和密码直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中存放（密码应密文存放，使用时解密），确保安全。 // 本示例以用户名和密码保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量（环境变量名称请根据自身情况进行设置）EXAMPLE_USERNAME_ENV和EXAMPLE_PASSWORD_ENV。 String userName = System.getenv("EXAMPLE_USERNAME_ENV"); String password = System.getenv("EXAMPLE_PASSWORD_ENV"); Connection conn = DriverManager.getConnection("url",userName,password); PreparedStatement pstmt = conn.prepareStatement("INSERT INTO customer_t1 VALUES (?)"); 针对每条数据都要调用setShort设置参数，以及调用addBatch确认该条设置完毕。 1 2 pstmt.setShort(1, (short)2); pstmt.addBatch(); 调用PreparedStatement的executeBatch方法执行批处理。 1 int[] rowcount = pstmt.executeBatch(); 调用PreparedStatement的close方法关闭预编译语句对象。 1 pstmt.close(); 在实际的批处理过程中，通常不终止批处理程序的执行，否则会降低数据库的性能。因此在批处理程序时，应该关闭自动提交功能，每几行提交一次。关闭自动提交功能的语句为： conn.setAutoCommit(false)。

Oracle兼容模式启用重载时，调用存储过程 打开参数behavior_compat_options='proc_outparam_override'后，JDBC调用事先创建的存储过程，步骤如下： 调用Connection的prepareCall方法创建调用语句对象。 1 2 3 4 5 6 // 认证用的用户名和密码直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中存放（密码应密文存放，使用时解密），确保安全。 // 本示例以用户名和密码保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量（环境变量名称请根据自身情况进行设置）EXAMPLE_USERNAME_ENV和EXAMPLE_PASSWORD_ENV。 String userName = System.getenv("EXAMPLE_USERNAME_ENV"); String password = System.getenv("EXAMPLE_PASSWORD_ENV"); Connection conn = DriverManager.getConnection("url",userName,password); CallableStatement cs = conn.prepareCall("{ CALL TEST_PROC(?,?,?,?) }"); 调用CallableStatement的setInt方法设置参数。 1 2 3 4 5 6 7 8 PGobject pGobject = new PGobject(); pGobject.setType("public.compfoo"); // 设置复合类型名，格式为“schema.typename”。 pGobject.setValue("(1,demo)"); // 绑定复合类型值，格式为“(value1,value2)”。 cs.setObject(1, pGobject); pGobject = new PGobject(); pGobject.setType("public.compfoo_table"); // 设置Table类型名，格式为"schema.typename"。 pGobject.setValue("{\"(10,demo10)\",\"(11,demo111)\"}"); //绑定Table类型值，格式为"{\"(value1,value2)\",\"(value1,value2)\",...}"。 cs.setObject(2, pGobject); 调用CallableStatement的registerOutParameter方法注册输出参数。 1 2 3 4 // 注册out类型的参数，类型为复合类型,格式为“schema.typename”。 cs.registerOutParameter(3, Types.STRUCT, "public.compfoo"); // 注册out类型的参数，类型为Table类型,格式为“schema.typename”。 cs.registerOutParameter(4, Types.ARRAY, "public.compfoo_table"); 调用CallableStatement的execute方法调用。 1 cs.execute(); 调用CallableStatement的getObject方法获取输出参数。 1 2 3 4 5 6 7 8 9 10 11 12 // 返回结构是自定义类型。 PGobject result = (PGobject)cs.getObject(3); // 获取out参数 result.getValue(); // 获取复合类型字符串形式值。 result.getArrayValue(); //获取复合类型数组形式值，以复合数据类型字段顺序排序。 result.getStruct(); //获取复合类型子类型名，按创建顺序排序。 result.getAttributes(); //返回自定义类型每列组成类型的对象，对于array类型和table类型返回的是PgArray,对于自定义类型，封装的是PGobject，对于其他类型数据存储方式为字符串类型。 // 返回结果是Table类型。 PgArray pgArray = (PgArray) cs.getObject(4); ResultSet rs = pgArray.getResultSet(); while (rs.next()) { rs.getObject(2);// table类型每行的数据构建成的对象。 } 如果出参的table类型组成为自定义类型，例如create type compfoo_table is table of compfoo，此时接收到的返回对象为PgArray，在通过rs.getObject(2)遍历获取到的组成对象也为PgArray，此时无法获取到组成它的compfoo类型对应的每列数据，需要通过getPGobject()获取到PgObject再操作获取。 调用CallableStatement的close方法关闭调用语句。 1 cs.close(); Oracle兼容模式开启参数后，调用存储过程必须使用{call proc_name(?,?,?)}形式调用，调用函数必须使用{? = call func_name(?,?)}形式调用（等号左侧的“？”为函数返回值的占位符，用于注册函数返回值）。 参数behavior_compat_options='proc_outparam_override行为变更后，业务需要重新建立连接，否则无法正确调用存储过程和函数。 函数和存储过程中包含复合类型时，参数的绑定与注册需要使用schema.typename形式。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 // 在数据库创建复合数据类型。 CREATE TYPE compfoo AS (f1 int, f3 text); // 在数据库中创建table类型。 create type compfoo_table is table of compfoo; // 在数据库中已创建了如下存储过程，它带有out参数。 create or replace procedure test_proc ( psv_in in compfoo, table_in in compfoo_table, psv_out out compfoo, table_out out compfoo_table ) as begin psv_out := psv_in; table_out:=compfoo_table(); table_out.extend(table_in.count); for i in 1..table_in.count loop table_out(i):=table_in(i); end loop; end; /

调用存储过程 GaussDB 支持通过JDBC直接调用事先创建的存储过程，步骤如下： 调用Connection的prepareCall方法创建调用语句对象。 1 2 3 4 5 6 // 认证用的用户名和密码直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中存放（密码应密文存放，使用时解密），确保安全。 // 本示例以用户名和密码保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量（环境变量名称请根据自身情况进行设置）EXAMPLE_USERNAME_ENV和EXAMPLE_PASSWORD_ENV。 String userName = System.getenv("EXAMPLE_USERNAME_ENV"); String password = System.getenv("EXAMPLE_PASSWORD_ENV"); Connection myConn = DriverManager.getConnection("url",userName,password); CallableStatement cstmt = myConn.prepareCall("{? = CALL TESTPROC(?,?,?)}"); 调用CallableStatement的setInt方法设置参数。 1 2 3 cstmt.setInt(2, 50); cstmt.setInt(1, 20); cstmt.setInt(3, 90); 调用CallableStatement的registerOutParameter方法注册输出参数。 1 cstmt.registerOutParameter(4, Types.INTEGER); //注册out类型的参数，类型为整型。 调用CallableStatement的execute方法调用。 1 cstmt.execute(); 调用CallableStatement的getInt方法获取输出参数。 1 int out = cstmt.getInt(4); //获取out参数 示例： 1 2 3 4 5 6 7 8 9 10 11 12 //在数据库中已创建了如下存储过程，它带有out参数。 create or replace procedure testproc ( psv_in1 in integer, psv_in2 in integer, psv_inout inout integer ) as begin psv_inout := psv_in1 + psv_in2 + psv_inout; end; / 调用CallableStatement的close方法关闭调用语句。 1 cstmt.close(); 很多数据库类如Connection、Statement和ResultSet都有close()方法，在使用完对象后应把它们关闭。Connection的关闭将间接关闭所有与它关联的Statement，Statement的关闭间接关闭了ResultSet。 一些JDBC驱动程序提供命名参数的方法来设置参数。命名参数的方法允许根据名称而不是顺序来设置参数，若参数有默认值，则可以不用指定参数值就可以使用此参数的默认值。即使存储过程中参数的顺序发生了变更，也不必修改应用程序。目前 GaussDB数据库 的JDBC驱动程序不支持此方法。 GaussDB数据库不支持带有输出参数的函数，也不支持存储过程和函数参数默认值。 myConn.prepareCall("{? = CALL TESTPROC(?,?,?)}")，执行存储过程绑定参数时，可以按照占位符的顺序绑定参数，注册第一个参数为出参，也可以按照存储过程中的参数顺序绑定参数，注册第四个参数为出参，上述用例为此场景，注册第四个参数为出参。 当游标作为存储过程的返回值时，如果使用JDBC调用该存储过程，返回的游标将不可用。 存储过程不能和普通SQL在同一条语句中执行。 存储过程中inout类型参数必需注册出参。

连接数据库（UDS方式） Unix domain socket用于同一主机上不同进程间的数据交换，通过添加junixsocket获取套接字工厂使用。 需要引用的jar包有junixsocket-core-XXX.jar、junixsocket-common-XXX.jar、junixsocket-native-common-XXX.jar。同时需要在URL连接串中添加：socketFactory=org.newsclub.net.unix.AFUNIXSocketFactory$FactoryArg&socketFactoryArg=[path-to-the-unix-socket]。 示例： // 认证用的用户名和密码直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中存放（密码应密文存放，使用时解密），确保安全。 // 本示例以用户名和密码保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量（环境变量名称请根据自身情况进行设置）EXAMPLE_USERNAME_ENV和EXAMPLE_PASSWORD_ENV。 import java.sql.Connection; import java.sql.DriverManager; import java.sql.Statement; import java.util.Properties; public class Test { public static void main(String[] args) { String driver = "com.huawei.gaussdb.jdbc.Driver"; String userName = System.getenv("EXAMPLE_USERNAME_ENV"); String password = System.getenv("EXAMPLE_PASSWORD_ENV"); Connection conn; try { Class.forName(driver).newInstance(); Properties properties = new Properties(); properties.setProperty("user", userName); properties.setProperty("password", password); conn = DriverManager.getConnection("jdbc:gaussdb://$ip:$port/postgres?socketFactory=org.newsclub" + ".net.unix" + ".AFUNIXSocketFactory$FactoryArg&socketFactoryArg=/data/tmp/.s.PGSQL.8000", properties); System.out.println("Connection Successful!"); Statement statement = conn.createStatement(); statement.executeQuery("select 1"); } catch (Exception e) { e.printStackTrace(); } } } socketFactoryArg参数配置根据真实路径进行配置，与GUC参数unix_socket_directory的值保持一致。 连接主机名必须设置为“localhost”。 父主题： 基于JDBC开发

示例 注：示例1和示例2选择其一。 // 认证用的用户名和密码直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中存放（密码应密文存放，使用时解密），确保安全。 // 本示例以用户名和密码保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量（环境变量名称请根据自身情况进行设置）EXAMPLE_USERNAME_ENV和EXAMPLE_PASSWORD_ENV。 import java.sql.Connection; import java.sql.DriverManager; import java.util.Properties; public class SSL{ public static void main(String[] args) { Properties urlProps = new Properties(); String urls = "jdbc:gaussdb://$ip:$port/postgres"; String userName = System.getenv("EXAMPLE_USERNAME_ENV"); String password = System.getenv("EXAMPLE_PASSWORD_ENV"); /** * ================== 示例1 使用NonValidatingFactory通道 */ urlProps.setProperty("sslfactory","com.huawei.gaussdb.jdbc.ssl.NonValidatingFactory"); urlProps.setProperty("user", userName); urlProps.setProperty("password", password); urlProps.setProperty("ssl", "true"); /** * ================== 示例2 使用证书 */ urlProps.setProperty("sslcert", "client.crt"); urlProps.setProperty("sslkey", "client.key.pk8"); urlProps.setProperty("sslrootcert", "cacert.pem"); urlProps.setProperty("user", userName); urlProps.setProperty("password", password); urlProps.setProperty("ssl", "true"); /* sslmode可配置为：require、verify-ca、verify-full，以下三个示例选择其一*/ /* ================== 示例2.1 设置sslmode为require，使用证书 */ urlProps.setProperty("sslmode", "require"); /* ================== 示例2.2 设置sslmode为verify-ca，使用证书 */ urlProps.setProperty("sslmode", "verify-ca"); /* ================== 示例2.3 设置sslmode为verify-full，使用证书（Linux下验证） */ urls = "jdbc:gaussdb://world:8000/postgres"; urlProps.setProperty("sslmode", "verify-full"); try { Class.forName("com.huawei.gaussdb.jdbc.Driver").newInstance(); } catch (Exception e) { e.printStackTrace(); } try { Connection conn; conn = DriverManager.getConnection(urls,urlProps); conn.close(); } catch (Exception e) { e.printStackTrace(); } } } /** * 注：将客户端密钥转化为DER格式: * openssl pkcs8 -topk8 -outform DER -in client.key -out client.key.pk8 -nocrypt * openssl pkcs8 -topk8 -inform PEM -in client.key -outform DER -out client.key.der -v1 PBE-MD5-DES * openssl pkcs8 -topk8 -inform PEM -in client.key -outform DER -out client.key.der -v1 PBE-SHA1-3DES * 以上算法由于安全级别较低，不推荐使用。 * 如果客户需要采用更高级别的私钥加密算法，启用bouncycastle或者其他第三方私钥解密密码包后可以使用的私钥加密算法如下： * openssl pkcs8 -in client.key -topk8 -outform DER -out client.key.der -v2 AES128 * openssl pkcs8 -in client.key -topk8 -outform DER -out client.key.der -v2 aes-256-cbc -iter 1000000 * openssl pkcs8 -in client.key -topk8 -out client.key.der -outform Der -v2 aes-256-cbc -v2prf hmacWithSHA512 * 启用bouncycastle：使用jdbc的项目引入依赖：bcpkix-jdk15on.jar包，版本建议：1.65以上。 */

参数 表1 数据库连接参数 参数 描述 url gaussdbjdbc.jar数据库连接描述符。 host为服务器名称或IPv4时，格式如下： jdbc:gaussdb:(数据库名称缺省则与用户名一致) jdbc:gaussdb:database jdbc:gaussdb://host/database jdbc:gaussdb://host:port/database jdbc:gaussdb://host:port/database?param1=value1¶m2=value2 jdbc:gaussdb://host1:port1,host2:port2/database?param1=value1¶m2=value2 host为IPv6时，格式如下： jdbc:gaussdb:(数据库名称缺省则与用户名一致) jdbc:gaussdb:database jdbc:gaussdb://host/database 或 jdbc:gaussdb://[host]/database jdbc:gaussdb://[host]:port/database jdbc:gaussdb://[host]:port/database?param1=value1¶m2=value2 jdbc:gaussdb://[host1]:port1,[host2]:port2/database?param1=value1¶m2=value2 说明： database为要连接的数据库名称。 host为数据库服务器名称或IP地址，同时支持IPv4和IPv6。 由于安全原因，数据库主节点禁止数据库内部其他节点无认证接入。如果要在数据库内部访问数据库主节点，请将JDBC程序部署在数据库主节点所在机器，host使用“127.0.0.1”。否则可能会出现“FATAL: Forbid remote connection with trust method!”错误。 建议业务系统单独部署在数据库外部，否则可能会影响数据库运行性能。 缺省情况下，连接服务器为localhost。 port为数据库服务器端口。 缺省情况下，会尝试连接到5432端口的database。 当host为IPv6且在url中指定port时，需要通过“[]”分隔IP，如：[IP]:port。 param为参数名称，即数据库连接属性。 参数可以配置在URL中，以“?”开始配置，以“=”给参数赋值，以“&”作为不同参数的间隔。也可以采用info对象的属性方式进行配置，详情见示例。 value为参数值，即数据库连接属性值。 连接时需配置connectTimeout、socketTimeout，如果未配置，默认为0，即不会超时。在DN与客户端出现网络故障时，客户端一直未收到DN侧ACK确认报文，会启动超时重传机制，不断的进行重传。当超时时间达到系统默认的600s后才会报超时错误，这会导致RTO时间很高。 建议使用JDBC标准接口建立连接时，确保url格式的合法性，不合法的url会导致异常，且异常中包含原始url字符串，可能造成敏感信息泄漏。 info 数据库连接属性（所有属性大小写敏感）。常用的属性如下： PGDBNAME：String类型。表示数据库名称（URL中无需配置该参数，自动从URL中解析）。 PGHOST：String类型。主机IP地址，同时支持IPv4和IPv6。详情见示例。 PGPORT：Integer类型。主机端口号。详情见示例。 user：String类型。表示创建连接的数据库用户。 password：String类型。表示数据库用户的密码。 enable_ce：String类型。其中enable_ce=1表示JDBC支持密态等值查询基本能力，enable_ce=3表示在密态等值查询能力的基础上支持内存解密逃生通道。 key_info：String类型。与enable_ce一起使用，在密态数据库中，用于设置访问外部密钥管理者的参数。 refreshClientEncryption：String类型。缺省值为NULL。refreshClientEncryption=1表示密态数据库支持客户端缓存刷新（默认值为1）。 loggerLevel：String类型。缺省值为NULL，不启用。目前支持4种级别：OFF、INFO、DEBUG、TRACE。设置为OFF关闭日志。设置为INFO、DEBUG和TRACE记录的日志信息详细程度不同。 loggerFile：String类型。用于指定日志输出路径（目录和文件名）。需要明确指定日志目录和文件名，若未指定目录则会在客户端运行程序目录下生成日志文件。此参数已废弃，不再生效，仅在开启连接监控功能时用于指定输出监控日志路径，如需将JDBC日志输出到指定路径，可通过 java.util.logging 属性文件或系统属性进行配置。 logger：String类型。表示JDBC Driver要使用的日志输出框架。JDBC Driver支持对接用户应用程序使用的日志输出框架。目前支持的第三方日志输出框架只有基于Slf4j-API的日志框架。具体使用方式，请参见日志管理。如果缺省或设置为JDK LOG GER，则JDBC Driver使用JDK LOGGER。否则必须设置采用基于slf4j-API 第三方日志框架。 allowEncodingChanges：Boolean类型。缺省值为false。设置该参数值为true进行字符集类型更改，配合参数characterEncoding设置字符集，二者使用“&”分隔。characterEncoding取值范围为UTF8、GBK、LATIN1、GB18030、GB18030_2022、ZHS16GBK。例：allowEncodingChanges=true&characterEncoding=UTF8。 currentSchema：String类型。在search-path中指定要设置的schema。如果schema名包含除字母、数字、下划线之外的特殊字符，建议在schema名上加引号，注意schema名大小写敏感。如需配置多个schema，要用逗号（,）进行分隔，包含特殊字符的schema也需要加引号处理。 例如：currentSchema=schema_a、"schema-b"、"schema/c"。 hostRecheckSeconds：Integer类型。JDBC尝试连接主机后会保存主机状态：连接成功或连接失败。在hostRecheckSeconds时间内保持可信，超过则状态失效。缺省值是10秒。 ssl：Boolean类型。以SSL方式连接。 ssl=true可支持NonValidatingFactory通道和使用证书的方式： 1、NonValidatingFactory通道需要配置用户名和密码，同时将SSL设置为true。 2、配置客户端证书、密钥、根证书，将SSL设置为true。 sslmode：String类型。SSL认证方式。取值范围为：disable、allow、prefer、require、verify-ca、verify-full。 disable：不使用SSL安全连接。 allow：如果数据库服务器要求使用，则可以使用SSL安全加密连接，但不验证数据库服务器的真实性。 prefer：如果数据库支持，那么首选使用SSL连接，但不验证数据库服务器的真实性。 require只尝试SSL连接，如果存在CA文件，则应设置成verify-ca的方式验证。 verify-ca只尝试SSL连接，并且验证服务器是否具有由可信任的证书机构签发的证书。 verify-full只尝试SSL连接，并且验证服务器是否具有由可信任的证书机构签发的证书，以及验证服务器主机名是否与证书中的一致。 sslcert：String类型。提供证书文件的完整路径。客户端和服务端证书的类型为End Entity。 sslkey：String类型。提供密钥文件的完整路径。使用时将客户端证书转换为DER格式。 openssl pkcs8 -topk8 -outform DER -in client.key -out client.key.pk8 -nocrypt sslrootcert：String类型。SSL根证书的文件名。根证书的类型为CA。 sslpassword：String类型。提供给ConsoleCallbackHandler使用。 sslpasswordcallback：String类型。SSL密码提供者的类名。缺省值：com.huawei.gaussdb.jdbc.ssl.jdbc4.LibPQFactory.ConsoleCallbackHandler。 sslfactory：String类型。提供的值是SSLSocketFactory在建立SSL连接时用的类名。 sslprivatekeyfactory: String类型。提供的值是实现私钥解密方法的接口com.huawei.gaussdb.jdbc.ssl.PrivateKeyFactory的实现类的完整限定类名。如果不提供，首先尝试默认的jdk私钥解密算法，如果无法解密，则使用com.huawei.gaussdb.jdbc.ssl.BouncyCastlePrivateKeyFactory，用户需要提供bcpkix-jdk15on.jar包，版本建议：1.65以上。 sslfactoryarg：String类型。此值是sslfactory类的构造函数的可选参数（不推荐使用）。 sslhostnameverifier：String类型。主机名验证程序的类名。接口实现javax.net.ssl.HostnameVerifier，默认使用com.huawei.gaussdb.jdbc.ssl.PGjdbcHostnameVerifier。 loginTimeout：Integer类型。指建立数据库连接的等待时间。超时时间单位为秒。当url配置多IP时，若获取连接花费的时间超过此值，则连接失败，不再尝试后续IP。缺省值为0。 connectTimeout：Integer类型。用于连接服务器操作的超时值。如果连接到服务器花费的时间超过此值，则连接断开。超时时间单位为秒，值为0时表示已禁用，timeout不生效。当url配置多IP时，表示连接单个IP的超时时间。缺省值为0。 socketTimeout：Integer类型。用于socket读取操作的超时值。如果从服务器读取所花费的时间超过此值，则连接关闭。超时时间单位为秒，值为0时表示已禁用，timeout不生效。缺省值为0。如果不配置该参数，在数据库进程异常情况下，会导致客户端出现长时间等待，建议根据业务可接受的SQL执行时间进行配置。 当JDBC侧触发超时且连接关闭时，其下发给数据库侧正在运行的业务会被强制终止。该能力受GUC参数check_disconnect_query控制，设置为on表示支持该能力，设置为off表示不支持该能力。 socketTimeoutInConnecting：Integer类型。用于控制建连阶段socket读取操作的超时值。如果建连时从服务器读取所花费的时间超过此值，则查找下一个节点建连。超时时间单位为秒，默认为5s。 statementTimeout：Integer类型。用于控制connection中statement执行时间的超时值。如果statement执行时间超过此值，则取消该statement执行。超时时间单位为毫秒，值为0表示已禁用，timeout不生效，缺省值为0。 cancelSignalTimeout：Integer类型。发送取消消息本身可能会阻塞，用于控制取消命令的“connect超时”和“socket超时”。如果取消命令超过指定时间未响应，会中断该连接，减少占用客户端资源。超时时间单位为秒，默认值为10秒。 tcpKeepAlive：Boolean类型。启用或禁用TCP保活探测功能。默认为false。 logUnclosedConnections：Boolean类型，缺省值为false。客户端可能由于未调用Connection对象的close()方法而泄漏Connection对象。最终这些对象将被垃圾回收，并且调用finalize()方法。设置为true之后，如果调用者忽略了此操作，该方法将关闭Connection。 assumeMinServerVersion（废弃）：String类型。客户端会发送请求进行float精度设置。该参数设置要连接的服务器版本，如assumeMinServerVersion=9.0，可以在建立时减少相关包的发送。 ApplicationName：String类型。设置正在使用连接的JDBC驱动的名称。通过在数据库主节点上查询pg_stat_activity表可以看到正在连接的客户端信息，JDBC驱动名称显示在application_name列。缺省值为GaussDB JDBC Driver。 connectionExtraInfo：Boolean类型。表示驱动是否将当前驱动的部署路径、进程属主用户、url连接配置信息上报到数据库。 取值范围：true或false，默认值为false。设置connectionExtraInfo为true，JDBC驱动会将当前驱动的部署路径、进程属主用户、url连接配置信息上报到数据库中，记录在connection_info参数里，同时可以在PG_STAT_ACTIVITY中查询到。 autosave：String类型。共有3种："always"、 "never"、 "conservative"，缺省值为never。如果查询失败，指定驱动程序应该执行的操作。在autosave=always模式下，JDBC驱动程序在每次查询之前设置一个保存点，并在失败时回滚到该保存点。在autosave=never模式（默认）下，无保存点。在autosave=conservative模式下，每次查询都会设置保存点，但是只会在“statement XXX无效”等情况下回滚并重试。 protocolVersion：Integer类型。连接协议版本号，目前仅支持1和3。设置1时仅代表连接的是V1服务端。设置3时将采用MD5加密方式，需要同步修改数据库的加密方式，将GUC参数password_encryption_type设置为1，重启数据库生效后需要创建用MD5方式加密口令的用户。同时修改gs_hba.conf，将客户端连接方式修改为MD5，用新建用户进行登录（因为设置该值后，只能使用低等级的加密方式（MD5），降低安全性，所以不推荐设置）。 说明： MD5加密算法安全性低，存在安全风险，建议使用更安全的加密算法。 prepareThreshold：Integer类型。该值决定着PreparedStatement对象在执行多少次以后使用服务端已经准备好的statement。默认值是5，意味着在执行同一个PreparedStatement对象时，在第五次以及以上执行时不再向服务端发送parse消息对statement进行解析，而使用之前在服务端已经解析好的statement。 preparedStatementCacheQueries：Integer类型。确定每个连接中缓存的查询数，默认情况下是256。若在prepareStatement()调用中使用超过256个不同的查询，则最近最少使用的查询缓存将被丢弃。“0”表示禁用缓存。 preparedStatementCacheSizeMiB：Integer类型。该参数确定了每个连接的cache缓存Statement对象所生成query的最大值（以兆字节为单位），默认情况下是5。若缓存了超过5MB的query，则最近最少使用的查询缓存将被丢弃。“0”表示禁用缓存。 databaseMetadataCacheFields：Integer类型。默认值是65536。指定每个连接可缓存的最大字段的个数。“0”表示禁用缓存。 databaseMetadataCacheFieldsMiB：Integer类型。默认值是5。每个连接可缓存的字段的最大值，单位是MB。“0”表示禁用缓存。 stringtype：String类型。可选字段为：unspecified、varchar。设置通过setString()方法使用的PreparedStatement参数的类型，如果stringtype设置为VARCHAR（默认值），则这些参数将作为varchar参数发送给服务器。若stringtype设置为unspecified，则参数将作为untyped值发送到服务器，服务器将尝试推断适当的类型。 batchMode：String类型。用于确定是否使用batch模式连接。默认值为on，表示开启batch模式。设置batchMode=on执行成功的返回结果为[count, 0, 0...0]，数组第一个元素为批量影响的总条数，设置batchMode=off执行成功的返回结果为[1, 1, 1...1]，数组各元素对应单次修改的影响条数。注意：配置batchMode=on时，执行批量插入/批量修改操作，每一列的数据类型以第一条数据指定的类型为准，若数据类型混用可能会导致报错或者插入的数据异常。 fetchsize：Integer类型。用于设置数据库连接所创建statement的默认fetchsize。默认值为0，表示一次获取所有结果。与defaultRowFetchSize功能等价，如果同时设置，以fetchsize为准。 reWriteBatchedInserts：Boolean类型。缺省值为false。批量导入时，该参数设置为true，可将N条插入语句合并为一条：insert into TABLE_NAME values(values1, ..., valuesN), ..., (values1, ..., valuesN)。使用该参数时，需设置batchMode=off。 unknownLength：Integer类型。默认为Integer.MAX_VALUE。某些GaussDB类型（例如TEXT）没有明确定义的长度，当通过ResultSetMetaData.getColumnDisplaySize和ResultSetMetaData.getPrecision等函数返回关于这些类型的数据时，此参数指定未知长度类型的长度。 uppercaseAttributeName：Boolean类型。默认值为false不开启，为true时开启。该参数开启后会将获取元数据的接口的查询结果转为大写。适用场景为数据库中存储元数据全为小写，但要使用大写的元数据作为出参和入参。 涉及到的接口请参见：java.sql.DatabaseMetaData、java.sql.ResultSetMetaData。 defaultRowFetchSize：Integer类型。确定一次fetch在ResultSet中读取的行数。限制每次访问数据库时读取的行数可以避免不必要的内存消耗，从而避免OutOfMemoryException。缺省值是0，意味着ResultSet中将一次获取所有行。本参数不允许设置为负值。 binaryTransfer：Boolean类型。使用二进制格式发送和接收数据，默认值为false。 binaryTransferEnable：String类型。启用二进制传输的类型列表，以逗号分隔。OID编号和名称二选一，例如：binaryTransferEnable=Integer4_ARRAY,Integer8_ARRAY。比如：OID名称为BLOB，编号为88，可以进行如下配置：binaryTransferEnable=BLOB 或 binaryTransferEnable=88。 binaryTransferDisable：String类型。禁用二进制传输的类型列表，以逗号分隔。OID编号和名称二选一。覆盖binaryTransferEnable的设置。 blobMode：String类型。用于设置setBinaryStream方法为不同类型的数据赋值，设置为on时表示为blob类型数据赋值，设置为off时表示为bytea类型数据赋值，默认为on。建议从Oracle数据库、Mysql数据库迁移的系统将该值设定为on，从Postgresql迁移的系统设定为off。 socketFactory：String类型。用于创建与服务器socket连接的类的名称。该类必须实现接口“javax.net.SocketFactory”，并定义无参或单String参数的构造函数。 socketFactoryArg：String类型。此值是上面提供的socketFactory类的构造函数的可选参数，不推荐使用。 receiveBufferSize：Integer类型。该值用于设置连接流上的SO_RCVBUF。 sendBufferSize：Integer类型。该值用于设置连接流上的SO_SNDBUF。 preferQueryMode：String类型。共有4种："extended"、 "extendedForPrepared"、"extendedCacheEverything"、"simple"。用于指定执行查询的模式，simple模式会excute，不parse和bind；extended模式会bind和excute；extendedForPrepared模式为prepared statement扩展使用；extendedCacheEverything模式会缓存每个statement。 targetServerType：String类型。该参数识别主备数据节点是通过查询URL连接串中，数据节点是否允许写操作来实现的，默认为"any"。共有五种："any"、"master"、"slave"、"preferSlave"、"clusterMainNode"。 master则尝试连接到URL连接串中的主节点，如果找不到将抛出异常。 slave则尝试连接到URL连接串中的备节点，如果找不到将抛出异常。 preferSlave则尝试连接到URL连接串中的备数据节点（如果有可用节点），否则连接到主数据节点。 any则尝试连接URL连接串中的任何一个数据节点。 clusterMainNode则尝试连接到URL串中的主节点或首备节点（容灾主节点），如果找不到将抛出异常。 priorityServers：Integer类型。此值用于指定url上配置的前n个节点作为主数据库实例被优先连接。默认值为NULL。该值为数字，大于0且小于url上配置的DN数量。用于流式容灾场景。 例如：jdbc:gaussdb://host1:port1,host2:port2,host3:port3,host4:port4,/database?priorityServers=2。即表示host1与host2为主数据库实例节点，host3与host4为容灾数据库实例节点。 forceTargetServerSlave：Boolean类型。此值用于控制是否开启强制连接备机功能，并在数据库实例发生主备切换时，禁止已存在的连接在升主备机上继续使用。默认值为false，表示不开启强制连接备机功能。true，表示开启强制连接备机功能。 traceInterfaceClass：String类型。默认值为NULL，用于获取traceId的实现类。值是实现获取traceId方法接口com.huawei.gaussdb.jdbc.log.Tracer的实现类的完整限定类名。 use_boolean：Boolean类型。用于设置extended模式下setBoolean方法绑定的oid类型，默认为false，绑定int2类型。设置为true则绑定Boolean类型。 allowReadOnly：Boolean类型。用于设置是否允许连接开启只读模式，默认为true，允许设置只读模式。设置为false则禁用只读模式，此时调用connection.setReadOnly(true)不生效，仍可以修改数据。 TLSCiphersSupperted：String类型。用于设置支持的TLS加密套件，默认为TLS_DHE_RSA_WITH_AES_128_GCM_SHA256,TLS_DHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384。 stripTrailingZeros：Boolean类型。默认值为false，设置为true则去除numeric类型后的0，仅对ResultSet.getObject(int columnIndex)生效。 enableTimeZone：Boolean类型。默认值为true，用于指定是否启用服务端时区设置，true表示获取JVM时区指定数据库时区，false表示使用数据库时区。 loadBalanceHosts：Boolean类型。在默认模式下（禁用），默认顺序连接URL中指定的多个主机。如果启用，则使用洗牌算法从候选主机中随机选择一个主机建立连接。集中式环境下，如果使用此参数需要保证业务中没有写操作。 compatibilityTags：String类型。默认为NULL，用于将驱动的部分特性恢复到早期版本，以确保前向兼容。可配置一个或多个tag，每个tag代表开启对应的前向兼容性特性，不同tag之间用“,”隔开。一般不建议使用该参数，除非有明确的前向兼容问题。目前支持的tag如下： typeMapInitNull：使用该tag后，兼容驱动早期版本的行为，java.sql.Connection中typeMap的初始值为NULL，如果不使用该tag，初始值为空Map。 parseCandidatesByDomain：Boolean类型。默认值false，用于指定是否根据 域名 获得候选节点。true表示启用，false表示禁用。开启后需要将url中的host信息配置成域名+端口的形式，驱动会基于域名获得IP，生成备节点集合，并可以配合autoBalance参数做负载均衡，或者配合targetServerType参数做自动寻主。 primaryDomains：Integer类型。用于指定url上配置的前n个域名作为主数据库实例被优先连接。默认为0，表示关闭。需要将parseCandidatesByDomain参数设置为true时才能生效，大于0表示开启，且取值要小于url上配置的域名数量。将url中的域名拆分成两个分组，前一个分组为主数据库实例，后一个分组为备数据库实例。发生主备切换后，两个分组交换位置，前一个分组为备数据库实例，后一个分组为主数据库实例。适用于流式容灾和Dorado双数据库实例场景。 例如：jdbc:gaussdb://domain1:port1,domain2:port2,domain3:port3,domain4:port4/database?parseCandidatesByDomain=true&primaryDomains=2，即表示domain1和domain2对应主数据库实例，优先连domain1和domain2对应的IP。如果发生主备切换，将domain3和domain4标记为主数据库实例，优先对domain3和domain4建立连接。 priorityDomains：Integer类型。用于指定url上配置的前n个域名作为优先连接的域名。默认为0，表示关闭，需要将parseCandidatesByDomain参数设置为true时才能生效，大于0表示开启，且取值要小于url上配置的域名数量，如果配置了primaryDomains，则需要小于primaryDomains配置的数值。 例如：jdbc:gaussdb://domain1:port1,domain2:port2,domain3:port3,domain4:port4/database?parseCandidatesByDomain=true&primaryDomains=2&priorityDomains=1，即表示domain1和domain2对应主数据库实例，但是优先连domain1对应的IP，domain2是备用域名，只有domain1不可连后才尝试连domain2。如果发生主备切换，将domain3和domain4标记成主数据库实例，但是优先连domain3对应的IP，domain3不可以连后才尝试连domain4对应的IP。 refreshDomainResolveTime：Integer类型。默认为10，单位是秒，最小值为1，最大值为2147483647。代表域名解析结果的刷新周期，需要将parseCandidatesByDomain参数设置为true时才能生效，生效后会将url中涉及的域名解析刷新时间设置为指定的数值，并在异步线程中定时更新域名解析结果。注意驱动仅通过应用所在环境的DNS服务获取域名解析结果，为保障域名绑定的变更被驱动及时感知，需要应用所在环境的DNS服务保障域名绑定关系变更后能够及时生效。 oracleCompatible：String类型。默认为false。用户控制驱动接口的A兼容特性。有以下几种取值： 设置为true或on：表示开启驱动侧所有的A兼容特性。 设置为false或off：表示关闭驱动侧所有的A兼容特性。 设置为"tag1,tag2,tag3"：配置一个或多个tag，tag之间用逗号隔开，表示开启驱动侧部分的A兼容特性，每个tag对应一个A兼容特性。 当前支持的tag有： getProcedureColumns：DatabaseMetaData#getProcedureColumns接口的行为兼容A行为。 getCallableStatementResults：开启后，调用CallableStatement的getLong、getInt、getShort、getByte四个接口时与A模式数据库保持一致。在注册出参类型为java.sql.Types#NUMERIC时，调用CallableStatement的getLong、getInt、getShort、getByte接口，能够正常接收out的值，只有out数值超过java数值，数据类型取值范围会提示SQLException异常。 batchInsertAffectedRows：reWriteBatchedInserts开启后，执行批量插入接口Statement#executeBatch的返回结果兼容A行为。 printSqlInLog：Boolean类型。默认值为true，用于指定异常信息中或日志中是否输出sql语句，true表示启用，false表示禁用。 useGsClobBlobClass：Boolean类型。默认为false，表示关闭。 设置为true开启后，使用java.sql.ResultSet#getObject接口获取获取clob字段时会返回PGClob类型的对象，获取blob字段时会返回PGBlob类型的对象。通过元数据接口java.sql.ResultSetMetaData#getColumnClassName获取clob字段的类型名称会返回java.sql.Clob，获取blob字段的类型名称时会返回java.sql.Blob。 设置为false关闭后，使用java.sql.ResultSet#getObject接口获取获取clob字段时会返回PGClob类型的对象，获取blob字段时会返回byte[]类型的对象。通过元数据接口java.sql.ResultSetMetaData#getColumnClassName获取clob字段的类型名称会返回java.sql.CLOB，获取blob字段的类型名称时会返回java.sql.BLOB。 executeUpdateQueryable：Boolean类型。默认值为false，用于指定executeUpdate方法是否开启执行DQL语句，true表示启用，false表示禁用。开启后，executeUpdate方法执行DQL语句的返回值为-1，能够得到结果集。不推荐开启此参数。 dbMonitor：Boolean类型。默认值为false，用于指定JDBC是否开启连接监控功能。true表示启用，false表示禁用。 连接监控功能支持监控JDBC端以下指标：应用开启连接的次数、关闭连接的次数、连接异常断开的次数、数据库访问量、客户端机器CPU的使用率、内存的使用率、上下行传输速率、应用端到数据库链路之间的网络时延、抖动、丢包率。 将dbMonitor设置为true，loggerLevel设置为debug，loggerFile设置为filePath，可将客户端的连接监控输出到日志文件filePath中，具体示例见示例4 数据库连接监控功能使用。 enableStreamingQuery：Boolean类型，默认值为false，用于控制是否开启流式读功能。true表示开启，false表示关闭。将该参数值设置为true，同时使用statement.setFetchSize(Integer.MIN_VALUE)或者statement.enableStreamingResults()，表示开启流式读功能。 流式读：读取数据时，一次获取全部，发送到客户端socket缓冲区中，缓冲区占满则暂停，有空余则继续向缓冲区中发送数据，同时JVM逐行从缓冲区中读取数据。优势是处理结果快，不会造成JVM内存溢出。劣势是只能向后遍历，数据处理完毕之前或者statement关闭之前，当前连接不能执行其他操作，具体示例见示例部分的示例2。 yearIsDateType：Boolean类型。默认值为true，表示开启。 设置为true开启后，使用java.sql.ResultSet#getObject接口获取year数据类型字段时会返回Date类型的对象，使用java.sql.ResultSet#getString接口获取数据时会返回yyyy-mm-dd格式的日期字符串，使用java.sql.ResultSet#getInt/getLong/getShort接口获取数据会返回年份数值。 设置为false关闭后，使用java.sql.ResultSet#getObject接口获取year数据类型字段时会返回Integer类型的对象，使用java.sql.ResultSet#getString接口获取数据时返回年份的字符串，使用java.sql.ResultSet#getInt/getLong/getShort接口获取数据会返回年份数值。 enableALT：Boolean类型。默认值为false，表示关闭。如果要开启ALT功能，需要同时配置enableALT和gns才可以生效。 设置为true后，计划内ALT功能开启连接数据库时会先与GNS建立连接，这个数据库实例后续连接DN时不会再与GNS重新建立连接。在数据库实例状态发生变化时，GNS会向JDBC发送FAN消息。 设置为false后，计划内ALT功能关闭，JDBC不会和GNS建立连接。 altLevel：Char类型。默认值为空，表示ALT只开启数据库实例状态通知功能。 设置为C时，表示开启加速连接和快速断连功能，在与DN建立新连接时会根据数据库实例连接管理器中各节点的主备状态对DN列表进行排序，加速新连接建立的过程。在收到数据库实例节点DOWN的状态通知消息后，主动关闭数据库实例连接管理器中管理的连接。 设置为P时，表示开启加速连接、快速断连以及计划内维护功能。在与DN建立新连接时会根据数据库实例连接管理器中各节点的主备状态对DN列表进行排序，加速新连接建立的过程。在收到数据库实例节点DOWN的状态通知消息后，主动关闭数据库实例连接管理器中管理的连接。在收到数据库实例节点进入计划内维护的消息后，会先将数据库实例连接管理器中所有连接进行事务排干，待数据库实例计划内维护完成后，重新连接DN，恢复连接的GUC参数，保证连接可用。 gns：String类型。默认值为空。表示GNS的IP地址和端口列表。在JDBC连接GNS时，会按照随机顺序对GNS列表依次进行连接，直到成功和某一个GNS建立连接、连接失败或超时。 setFloat：Boolean类型，表示调用setFloat或者setObject指定类型为float时，传递给内核的Oid是否为float4的Oid。true表示开启，传递给内核的Oid为float8，false表示关闭，传递给内核的Oid为float4，默认为false。 user 数据库用户。 password 数据库用户的密码。 uppercaseAttributeName参数开启后，如果数据库中有小写、大写和大小写混合的元数据，只能查询出小写部分的元数据，并以大写的形式输出，使用前请务必确认元数据的存储是否全为小写以避免数据出错。

基于JDBC开发 JDBC（Java Database Connectivity，Java数据库连接）是用于执行SQL语句的Java API，可以为多种关系数据库提供统一访问接口，应用程序可基于它操作数据。GaussDB库提供了对JDBC 4.2特性的支持，需要使用JDK1.8版本编译程序代码，不支持JDBC桥接ODBC方式。 JDBC包、驱动类和环境类 开发流程 加载驱动 连接数据库 连接数据库（以SSL方式） 连接数据库（UDS方式） 执行SQL语句 处理结果集 关闭数据库连接 日志管理 示例：常用操作 示例：重新执行应用SQL 示例：通过本地文件导入导出数据 示例：从MY迁移数据 示例：逻辑复制代码示例 示例：不同场景下连接数据库参数配置 JDBC接口参考 JDBC常用参数参考 常见问题处理 JDBC数据类型映射关系 父主题： 应用程序开发教程

数据加载和卸载 在INSERT语句中显式设置插入的字段列表。例如： 1 INSERT INTO task(name,id,comment) VALUES ('task1','100','第100个任务'); 在批量数据入库之后，或者数据增量达到一定阈值后，建议对表进行ANALYZE操作，防止统计信息不准确而导致的执行计划劣化。 如果要清理表中的所有数据，建议使用TRUNCATE TABLE方式，不要使用DELETE TABLE方式。DELETE TABLE方式删除性能差，且不会释放那些已经删除了的数据占用的磁盘空间。

DDL 在GaussDB中，建议DDL（建表、COMMENT等）操作统一执行。在批处理作业中尽量避免DDL操作，避免大量并发事务对性能的影响。 在非日志表（unlogged table）使用完后，立即执行数据清理（TRUNCATE）操作。因为在异常场景下，GaussDB不保证非日志表(unlogged table)数据的安全性。 临时表和非日志表的存储方式建议和基表相同。 索引字段的总长度不超过50字节。否则，索引大小会膨胀比较严重，带来较大的存储开销，同时索引性能也会下降。 不要使用DROP…CASCADE方式删除对象，除非已经明确对象间的依赖关系，以免误删。

Schema设计建议 实际用户环境中Schema数量不建议超过100个。当数据库中存在大量Schema时，会导致gs_dump等依赖Schema数量的操作性能变慢。 如果该用户不具有sysadmin权限或者不是该Schema的owner，要访问Schema下的对象，需要同时给用户授予Schema的usage权限和对象的相应权限。 如果要在Schema下创建对象，需要授予操作用户该Schema的CREATE权限。 Schema的owner默认拥有该Schema下对象的所有权限，包括删除权限。删除权限影响较大，请谨慎使用。

Database设计建议 在实际业务中，根据需要创建新的Database，不建议直接使用数据库实例默认的postgres数据库。 一个数据库实例内，用户自定义的Database数量推荐值为3个，不建议超过10个。用户自定义的Database数量过多会导致升级、备份等运维操作的效率降低。 为了适应全球化的需求，使数据库编码能够存储与表示绝大多数的字符，建议创建Database的时候使用UTF-8编码。 创建Database时，需要重点关注字符集编码（ENCODING）和兼容性（DBCOMPATIBILITY）两个配置项。GaussDB支持A、B、C、PG和M五种兼容模式，分别表示兼容O语法、MY语法、TD语法、POSTGRES和M-Compatibility语法。不同兼容模式下的语法存在一定差异，默认为A兼容模式。 Database的owner默认拥有该Database下所有对象的所有权限，包括删除权限。删除权限影响较大，请谨慎使用。

操作步骤 方法一： 声明字段类型为序列整型来定义标识符字段。例如： 1 2 3 4 5 gaussdb=# CREATE TABLE T1 ( id serial, name text ); 当结果显示为如下信息，则表示创建成功。 1 CREATE TABLE 方法二： 创建序列，并通过nextval('sequence_name')函数指定为某一字段的默认值。 创建序列。 1 gaussdb=# CREATE SEQUENCE seq1 cache 100; 当结果显示为如下信息，则表示创建成功。 1 CREATE SEQUENCE 指定为某一字段的默认值，使该字段具有唯一标识属性。 1 2 3 4 5 gaussdb=# CREATE TABLE T2 ( id int not null default nextval('seq1'), name text ); 当结果显示为如下信息，则表示默认值指定成功。 1 CREATE TABLE 指定序列与列的归属关系。 将序列和一个表的指定字段进行关联。这样，在删除该字段或其所在表的时候会自动删除已关联的序列。 1 gaussdb=# ALTER SEQUENCE seq1 OWNED BY T2.id; 当结果显示为如下信息，则表示指定成功。 1 ALTER SEQUENCE 除了为序列指定cache，方法二所实现的功能基本与方法一类似。但是一旦定义cache，序列将会产生空洞(序列值为不连贯的数值，如：1.4.5)，并且不能保序。另外为某序列指定从属列后，该列删除，对应的sequence也会被删除。 虽然数据库并不限制序列只能为一列产生默认值，但建议不要多列共用同一个序列。 当前版本只支持在定义表的时候指定自增列，或者指定某列的默认值为nextval('seqname')， 不支持在已有表中增加自增列或者增加默认值为nextval('seqname')的列。

背景信息 当用户对数据库中的一张或者多张表的某些字段的组合感兴趣，而又不想每次键入这些查询时，用户就可以定义一个视图，以便解决此问题。 视图与基本表不同，不是物理上实际存在的，是一个虚拟表。数据库中仅存放视图的定义，而不存放视图对应的数据，这些数据仍存放在原来的基本表中。若基本表中的数据发生变化，从视图中查询出的数据也随之改变。视图就像一个窗口，透过它可以看到数据库中用户感兴趣的数据及变化。视图每次被引用的时候都会运行一次。

背景信息 GaussDB数据库支持的分区表为范围分区表、间隔分区表、列表分区表和哈希分区表。 范围分区表：将数据基于范围映射到每一个分区，这个范围是由创建分区表时指定的分区键决定的。这种分区方式是最为常用的，并且分区键经常采用日期，例如将销售数据按照月份进行分区。 间隔分区表：是一种特殊的范围分区表，相比范围分区表，新增间隔值定义，当插入记录找不到匹配的分区时，可以根据间隔值自动创建分区。 列表分区表：将数据中包含的键值分别存储在不同的分区中，依次将数据映射到每一个分区，分区中包含的键值由创建分区表时指定。 哈希分区表：将数据根据内部哈希算法依次映射到每一个分区中，包含的分区个数由创建分区表时指定。 分区表和普通表相比具有以下优点： 改善查询性能：对分区对象的查询可以仅搜索自己关心的分区，提高检索效率。 增强可用性：如果分区表的某个分区出现故障，表在其他分区的数据仍然可用。 方便维护：如果分区表的某个分区出现故障，需要修复数据，只修复该分区即可。 普通表若要转成分区表，需要新建分区表，然后把普通表中的数据导入到新建的分区表中。因此在初始设计表时，请根据业务提前规划是否使用分区表。

查看数据库用户 通过PG_USER可以查看数据库中所有用户的列表，还可以查看用户ID（USESYSID）和用户权限。 1 SELECT * FROM pg_user; usename | usesysid | usecreatedb | usesuper | usecatupd | userepl | passwd | valbegin | valuntil | respool | parent | spacelimit | useconfig | no degroup | tempspacelimit | spillspacelimit | usemonitoradmin | useoperatoradmin | usepolicyadmin ---------+----------+-------------+----------+-----------+---------+----------+----------+----------+--------------+--------+------------+-----------+--- --------+----------------+-----------------+-----------------+------------------+---------------- omm | 10 | t | t | t | t | ******** | | | default_pool | 0 | | | | | | t | t | t

查看和停止正在运行的查询语句 通过视图PG_STAT_ACTIVITY可以查看正在运行的查询语句。方法如下： 设置参数track_activities为on。 1 SET track_activities = on; 当此参数为on时，数据库系统才会获取当前活动查询的运行信息。 查看正在运行的查询语句。以查看正在运行的查询语句所连接的数据库名、执行查询的用户、查询状态及查询对应的PID为例。 1 SELECT datname, usename, state,pid FROM pg_stat_activity; 1 2 3 4 5 6 7 8 datname | usename | state | pid ----------+---------+--------+----------------- testdb | Ruby | active | 140298793514752 testdb | Ruby | active | 140298718004992 testdb | Ruby | idle | 140298650908416 testdb | Ruby | idle | 140298625742592 testdb | omm | active | 140298575406848 (5 rows) 如果state字段显示为idle，则表明此连接处于空闲，等待用户输入命令。 如果仅需要查看非空闲的查询语句，则执行如下命令查看。 1 SELECT datname, usename, state, pid FROM pg_stat_activity WHERE state != 'idle'; 若需要取消运行时间过长的查询，通过PG_TERMINATE_BACKEND函数，根据线程ID（即2中查询结果的pid字段）结束会话，请执行如下命令。 1 SELECT PG_TERMINATE_BACKEND(140298793514752); 显示如下信息，表示结束会话成功。 1 2 3 4 PG_TERMINATE_BACKEND ---------------------- t (1 row) 显示如下信息，表示用户执行了结束当前会话的操作。 1 2 FATAL: terminating connection due to administrator command FATAL: terminating connection due to administrator command 1. gsql客户端使用PG_TERMINATE_BACKEND函数结束当前正在执行会话的后台线程时，如果当前的用户是初始用户，客户端不会退出而是自动重连，即返回“The connection to the server was lost. Attempting reset: Succeeded.”。否则客户端会重连失败，即返回“The connection to the server was lost. Attempting reset: Failed.”。这是因为只有初始用户可以免密登录，普通用户不能免密登录，从而重连失败。 2. 对于使用PG_TERMINATE_BACKEND函数结束非活跃的后台线程时，如果打开了线程池，此时空闲的会话没有线程ID，无法结束会话。非线程池模式下，结束的会话不会自动重连。 1 2 3 FATAL: terminating connection due to administrator command FATAL: terminating connection due to administrator command The connection to the server was lost. Attempting reset: Succeeded.

查看数据库中包含的表 在public Schema下新建以下表格。 gaussdb=# CREATE TABLE public.search_table_t1(a int); CREATE TABLE gaussdb=# CREATE TABLE public.search_table_t2(b int); CREATE TABLE gaussdb=# CREATE TABLE public.search_table_t3(c int); CREATE TABLE gaussdb=# CREATE TABLE public.search_table_t4(d int); CREATE TABLE gaussdb=# CREATE TABLE public.search_table_t5(e int); CREATE TABLE 在PG_TABLES系统表中查看public Schema中包含的前缀为search_table的表。 1 gaussdb=# SELECT distinct(tablename) FROM pg_tables WHERE SCHEMANAME = 'public' AND TABLENAME LIKE 'search_table%'; 结果如下： 1 2 3 4 5 6 7 8 tablename ----------------- search_table_t1 search_table_t2 search_table_t3 search_table_t4 search_table_t5 (5 rows)

删除表中数据 在使用表的过程中，可能会需要删除已过期的数据，删除数据必须从表中整行的删除。 SQL不能直接访问独立的行，只能通过声明被删除行匹配的条件进行。如果表中有一个主键，用户可以指定准确的行。用户可以删除匹配条件的一组行或者一次删除表中的所有行。 执行DELETE命令删除行，如果删除表customer_t1中所有c_customer_sk为3869的记录。 1 gaussdb=# DELETE FROM customer_t1 WHERE c_customer_sk = 3869; 如果执行如下命令之一，会删除表中所有的行。 1 gaussdb=# DELETE FROM customer_t1; 或： 1 gaussdb=# TRUNCATE TABLE customer_t1; 全表删除的场景下，建议使用TRUNCATE，不建议使用DELETE。 删除创建的表。 1 gaussdb=# DROP TABLE customer_t1; 父主题： 创建和管理表

查看数据 使用系统表pg_tables查询数据库所有表的信息。 1 gaussdb=# SELECT * FROM pg_tables; 使用gsql的\d+命令查询表的属性。 1 gaussdb=# \d+ customer_t1; 执行如下命令查询表customer_t1的数据量。 1 gaussdb=# SELECT count(*) FROM customer_t1; 执行如下命令查询表customer_t1的所有数据。 1 gaussdb=# SELECT * FROM customer_t1; 执行如下命令只查询字段c_customer_sk的数据。 1 gaussdb=# SELECT c_customer_sk FROM customer_t1; 执行如下命令过滤字段c_customer_sk的重复数据。 1 gaussdb=# SELECT DISTINCT( c_customer_sk ) FROM customer_t1; 执行如下命令查询字段c_customer_sk为3869的所有数据。 1 gaussdb=# SELECT * FROM customer_t1 WHERE c_customer_sk = 3869; 执行如下命令按照字段c_customer_sk进行排序。 1 gaussdb=# SELECT * FROM customer_t1 ORDER BY c_customer_sk; 父主题： 创建和管理表

更新表中数据 修改已经存储在数据库中数据的行为叫做更新。用户可以更新单独一行、所有行或者指定的部分行。还可以独立更新每个字段，而其他字段则不受影响。 使用UPDATE命令更新现有行，需要提供以下三种信息： 表的名称和需要更新的字段名 字段的新值 需要更新的行 SQL通常不会为数据行提供唯一标识，因此无法直接声明需要更新哪一行。但是可以通过声明一个被更新的行必须满足的条件。只有在表里存在主键的时候，才可以通过主键指定一个独立的行。 建立表和插入数据的步骤请参见创建表和向表中插入数据。 需要将表customer_t1中c_customer_sk为9527的地域重新定义为9876。 1 gaussdb=# UPDATE customer_t1 SET c_customer_sk = 9876 WHERE c_customer_sk = 9527; 这里的表名称也可以使用模式名修饰，否则会从默认的模式路径找到这个表。SET后面紧跟字段和新的字段值。新的字段值不仅可以是常量，也可以是变量表达式。 比如，把所有c_customer_sk的值增加100。 1 gaussdb=# UPDATE customer_t1 SET c_customer_sk = c_customer_sk + 100; 在这里省略了WHERE子句，表示表中的所有行都要被更新。如果出现了WHERE子句，那么只有匹配其条件的行才会被更新。 在SET子句中的等号是一个赋值，而在WHERE子句中的等号是比较。WHERE条件不一定是相等比较，许多其他的操作符也可以使用。 用户可以在一个UPDATE命令中更新更多的字段，方法是在SET子句中列出更多赋值，比如： 1 gaussdb=# UPDATE customer_t1 SET c_customer_id = 'Admin', c_first_name = 'Local' WHERE c_customer_sk = 4421; 批量更新或删除数据后，会在数据文件中产生大量的删除标记，查询过程中标记删除的数据也是需要扫描的。故多次批量更新/删除后，标记删除的数据量过大会严重影响查询的性能。建议在批量更新/删除业务会反复执行的场景下，定期执行VACUUM FULL以保证查询性能。 父主题： 创建和管理表

操作步骤 向表中插入数据前，意味着表已创建成功。创建表的步骤请参见创建和管理表。 向表customer_t1中插入一行数据。 数据值是按照这些字段在表中出现的顺序列出的，并且用逗号分隔。通常数据值是文本（常量），但也允许使用标量表达式。 1 gaussdb=# INSERT INTO customer_t1(c_customer_sk, c_customer_id, c_first_name) VALUES (3769, 'hello', 'Grace'); 如果用户已经知道表中字段的顺序，也可无需列出表中的字段。例如以下命令与上面的命令效果相同。 1 gaussdb=# INSERT INTO customer_t1 VALUES (3769, 'hello', 'Grace'); 如果用户不知道所有字段的数值，可以忽略其中的一些。如果INSERT语句中，用户没有显示指定目标表的字段名字，那么VALUES子句中待插入的多个值，将按照列号和目标表的字段一一对应，即VALUES子句的第一个值对应目标表的第一列，VALUES子句的第二个值对应目标表的第二列，依次类推，没有VALUES数值对应的列自动填充缺省值或NULL。例如： 1 2 3 gaussdb=# INSERT INTO customer_t1 (c_customer_sk, c_first_name) VALUES (3769, 'Grace'); gaussdb=# INSERT INTO customer_t1 VALUES (3769, 'hello'); 用户也可以对独立的字段或者整个行明确缺省值。 1 2 3 gaussdb=# INSERT INTO customer_t1 (c_customer_sk, c_customer_id, c_first_name) VALUES (3769, 'hello', DEFAULT); gaussdb=# INSERT INTO customer_t1 DEFAULT VALUES; 如果需要在表中插入多行，请执行如下命令。 1 2 3 4 gaussdb=# INSERT INTO customer_t1 (c_customer_sk, c_customer_id, c_first_name) VALUES (6885, 'maps', 'Joes'), (4321, 'tpcds', 'Lily'), (9527, 'world', 'James'); 如果需要向表中插入多条数据，除此命令外，也可以多次执行插入一行数据命令实现。但是建议使用此命令以提升效率。 如果从指定表插入数据到当前表，例如在数据库中创建了一个表customer_t1的备份表customer_t2，现在需要将表customer_t1中的数据插入到表customer_t2中，则可以执行如下命令。 1 2 3 4 5 6 7 8 9 gaussdb=# CREATE TABLE customer_t2 ( c_customer_sk integer, c_customer_id char(5), c_first_name char(6), c_last_name char(8) ); gaussdb=# INSERT INTO customer_t2 SELECT * FROM customer_t1; 从指定表插入数据到当前表时，若指定表与当前表对应的字段数据类型之间不存在隐式转换，则这两种数据类型必须相同。 使用不带AS的表别名向表中插入数据。 1 2 3 gaussdb=# CREATE TABLE T1(A INT,B TEXT,C TIMESTAMP,D FLOAT); gaussdb=# INSERT INTO T1 T VALUES(1,'HA','1997-01-01 10:00:00'::TIMESTAMP,1.234); gaussdb=# INSERT INTO T1 TT(B,C,D) VALUES('HA','1997-01-01 10:00:00'::TIMESTAMP,1.234); INSERT不带AS的表别名不能为关键字（如SELECT、VALUE）或者表达式，别名要求符合标识符命名规则。 INSERT不带AS的表别名不支持INSERT INTO table_name alias_name(alias_name.col1,...,alias_name.coln) VALUES(xxx)格式。 INSERT的分区表不带AS的表别名不支持指定分区插入操作。 删除备份表。 1 gaussdb=# DROP TABLE customer_t2 CASCADE; 在删除表的时候，若当前需删除的表与其他表有依赖关系，需先删除关联的表，然后再删除当前表。

背景信息 服务端与客户端使用不同的字符集时，两者字符集中单个字符的长度也会不同，客户端输入的字符串会以服务端字符集的格式进行处理，所以产生的最终结果可能会与预期不一致。 表1 客户端和服务端设置字符集的输出结果对比 操作过程 服务端和客户端编码一致 服务端和客户端编码不一致 存入和取出过程中没有对字符串进行操作 输出预期结果 输出预期结果（客户端编码保持不变）。 存入取出过程对字符串有做一定的操作（如字符串函数操作） 输出预期结果 根据对字符串具体操作可能产生非预期结果。 存入过程中对超长字符串有截断处理 输出预期结果 字符集中字符编码长度是否一致，如果不一致可能会产生非预期的结果。 上述字符串函数操作和自动截断产生的结果会有叠加效果，例如：在客户端与服务端字符集不一致的场景下，如果既有字符串操作，又有字符串截断，在字符串被处理完以后的情况下继续截断，这样也会产生非预期的效果。详细的示例请参见表2。 数据库DBCOMPATIBILITY设为兼容TD模式，且GUC参数td_compatible_truncation设置为on的情况下，才会对超长字符串进行截断。 执行如下命令建立示例中需要使用的表table1、table2。 1 2 gaussdb=# CREATE TABLE table1(id int, a char(6), b varchar(6),c varchar(6)); gaussdb=# CREATE TABLE table2(id int, a char(20), b varchar(20),c varchar(20)); 表2 示例 编号 服务端字符集 客户端字符集 是否启用自动截断 示例 结果 说明 1 SQL_ASCII UTF8 是 1 gaussdb=# INSERT INTO table1 VALUES(1,reverse('123ＡＡ78'),reverse('123ＡＡ78'),reverse('123ＡＡ78')); 1 2 3 id |a|b|c ----+------+------+------ 1 | 87| 87| 87 字符串在服务端翻转后，并进行截断，由于服务端和客户端的字符集不一致，字符A在客户端由多个字节表示，结果产生异常。 2 SQL_ASCII UTF8 是 1 gaussdb=# INSERT INTO table1 VALUES(2,reverse('123Ａ78'),reverse('123Ａ78'),reverse('123Ａ78')); 1 2 3 id |a|b|c ----+------+------+------ 2 | 873| 873| 873 字符串翻转后，又进行了自动截断，所以产生了非预期的效果。 3 SQL_ASCII UTF8 是 1 gaussdb=# INSERT INTO table1 VALUES(3,'87Ａ123','87Ａ123','87Ａ123'); 1 2 3 id | a | b | c ----+-------+-------+------- 3 | 87Ａ1 | 87Ａ1 | 87Ａ1 由于字符串类型字段的长度是客户端字符编码长度的整数倍，所以截断后产生结果正常。 4 SQL_ASCII UTF8 否 1 2 gaussdb=# INSERT INTO table2 VALUES(1,reverse('123ＡＡ78'),reverse('123ＡＡ78'),reverse('123ＡＡ78')); gaussdb=# INSERT INTO table2 VALUES(2,reverse('123Ａ78'),reverse('123Ａ78'),reverse('123Ａ78')); 1 2 3 4 id |a|b|c ----+-------------------+--------+-------- 1 | 87 321| 87 321 | 87 321 2 | 87321| 87321| 87321 与示例1类似，多字节字符翻转之后不再表示原来的字符。

操作步骤 创建表空间 执行如下命令创建用户为jack，密码为********。 1 gaussdb=# CREATE USER jack IDENTIFIED BY '********'; 当结果显示为如下信息，则表示创建成功。 1 CREATE ROLE 执行如下命令创建表空间。 1 gaussdb=# CREATE TABLESPACE fastspace RELATIVE LOCATION 'tablespace/tablespace_1'; 当结果显示为如下信息，则表示创建成功。 1 CREATE TABLESPACE 其中“fastspace”为新创建的表空间，“数据库节点数据目录/pg_location/tablespace/tablespace_1”是用户拥有读写权限的空目录。 数据库系统管理员执行如下命令将“fastspace”表空间的访问权限授予数据用户jack。 1 gaussdb=# GRANT CREATE ON TABLESPACE fastspace TO jack; 当结果显示为如下信息，则表示授予成功。 1 GRANT

用户权限设置 给用户直接授予某对象的权限，请参见GRANT。 将Schema中的表或者视图对象授权给其他用户或角色时，需要将表或视图所属Schema的USAGE权限同时授予该用户或角色。否则用户或角色将只能看到这些对象的名称，并不能实际进行对象访问。 例如，下面示例将Schema tpcds的权限授予用户joe后，将表tpcds.web_returns的select权限授予用户joe。 1 2 gaussdb=# GRANT USAGE ON SCHEMA tpcds TO joe; gaussdb=# GRANT SELECT ON TABLE tpcds.web_returns to joe; 给用户指定角色，使用户继承角色所拥有的对象权限。 创建角色。 新建一个角色lily，同时给角色指定系统权限CREATEDB。 1 gaussdb=# CREATE ROLE lily WITH CREATEDB PASSWORD "********"; 给角色授予对象权限，请参见GRANT。 例如，将模式tpcds的权限赋给角色lily后，将表tpcds.web_returns的select权限授予角色lily。 1 2 gaussdb=# GRANT USAGE ON SCHEMA tpcds TO lily; gaussdb=# GRANT SELECT ON TABLE tpcds.web_returns to lily; 将角色的权限授予用户。 1 gaussdb=# GRANT lily to joe; 当将角色的权限授予用户时，角色的属性并不会传递到用户。 回收用户权限，请参见REVOKE。 父主题： 用户及权限

搜索路径 搜索路径定义在search_path参数中，参数取值形式为采用逗号分隔的Schema名称列表。如果创建对象时未指定目标Schema，则该对象将会被添加到搜索路径中列出的第一个Schema中。当不同Schema中存在同名的对象时，查询对象未指定Schema的情况下，将从搜索路径中包含该对象的第一个Schema中返回对象。 查看当前搜索路径，请参见SHOW。 1 2 3 4 5 gaussdb=# SHOW SEARCH_PATH; search_path ---------------- "$user",public (1 row) search_path参数的默认值为："$user"，public。$user表示与当前会话用户名同名的Schema名，如果这样的模式不存在，$user将被忽略。所以默认情况下，用户连接数据库后，如果数据库下存在同名Schema，则对象会添加到同名Schema下，否则对象被添加到Public Schema下。 更改当前会话的默认Schema，请使用SET命令。 执行如下命令将搜索路径设置为myschema，public，首先搜索myschema，然后搜索public。 1 2 gaussdb=# SET SEARCH_PATH TO myschema, public; SET

创建、修改和删除Schema 创建Schema，请参见CREATE SCHEMA。默认初始用户和系统管理员可以创建Schema，其他用户需要具备数据库的CREATE权限才可以在该数据库中创建Schema，授权方式请参见GRANT中将数据库的访问权限授予指定的用户或角色中的语法。 更改Schema名称或者所有者，请参见ALTER SCHEMA。Schema所有者可以更改Schema。 删除Schema及其对象，请参见DROP SCHEMA。Schema所有者可以删除Schema。 在Schema内创建表，请以schema_name.table_name格式创建表。不指定schema_name时，对象默认创建到搜索路径中的第一个Schema内。 查看Schema所有者，请对系统表PG_NAMESPACE和PG_USER执行如下关联查询。语句中的schema_name请替换为实际要查找的Schema名称。 1 gaussdb=# SELECT s.nspname,u.usename AS nspowner FROM pg_namespace s, pg_user u WHERE nspname='schema_name' AND s.nspowner = u.usesysid; 查看所有Schema的列表，请查询PG_NAMESPACE系统表。 1 gaussdb=# SELECT * FROM pg_namespace; 查看属于某Schema下的表列表，请查询系统视图PG_TABLES。例如，以下查询会返回Schema PG_CATALOG中的表列表。 1 gaussdb=# SELECT distinct(tablename),schemaname from pg_tables where schemaname = 'pg_catalog';

创建、修改和删除角色 非三权分立时，只有系统管理员和具有CREATEROLE属性的用户才能创建、修改或删除角色。三权分立下，只有初始用户和具有CREATEROLE属性的用户才能创建、修改或删除角色。 创建角色，请参见CREATE ROLE。 在现有角色中添加或删除用户，请参见ALTER ROLE。 删除角色，请参见DROP ROLE。DROP ROLE只会删除角色，并不会删除角色中的成员用户账户。

内置角色 GaussDB提供了一组默认角色，以gs_role_开头命名。它们提供对特定的、通常需要高权限的操作的访问，可以将这些角色授权给数据库内的其他用户或角色，让这些用户能够使用特定的功能。在授予这些角色时应当非常小心，以确保它们被用在需要的地方。表1描述了内置角色允许的权限范围。 表1 内置角色权限描述 角色 权限描述 gs_role_signal_backend 具有调用函数pg_cancel_backend、pg_terminate_backend和pg_terminate_session来取消或终止其他会话的权限，但不能操作属于初始用户和PERSISTENCE用户的会话。 gs_role_tablespace 具有创建表空间（tablespace）的权限。 gs_role_replication 具有调用逻辑复制相关函数的权限，例如kill_snapshot、pg_create_logical_replication_slot、pg_create_physical_replication_slot、pg_drop_replication_slot、pg_replication_slot_advance、pg_create_physical_replication_slot_extern、pg_logical_slot_get_changes、pg_logical_slot_peek_changes、pg_logical_slot_get_binary_changes、pg_logical_slot_peek_binary_changes。 gs_role_account_lock 具有加解锁用户的权限，但不能加解锁初始用户和PERSISTENCE用户。 gs_role_pldebugger 具有执行dbe_pldebugger下调试函数的权限。 gs_role_public_dblink_drop 具有执行删除public database link对象的权限。 gs_role_public_dblink_alter 具有执行修改public database link对象的权限。 gs_role_seclabel 具有创建、删除和应用安全标签的权限。 gs_role_public_synonym_create 具有创建public同义词的权限。 gs_role_public_synonym_drop 具有删除public同义词的权限。 关于内置角色的管理有如下约束： 以gs_role_开头的角色名作为数据库的内置角色保留名，禁止新建以“gs_role_”开头的用户/角色/模式，也禁止将已有的用户/角色/模式重命名为以“gs_role_”开头。 禁止对内置角色进行ALTER和DROP操作。 内置角色默认没有LOGIN权限，不设预置密码。 gsql元命令\du和\dg不显示内置角色的相关信息，但若显示指定了pattern为特定内置角色则会显示。 三权分立关闭时，初始用户、具有SYSADMIN权限的用户和具有内置角色ADMIN OPTION权限的用户有权对内置角色执行GRANT/REVOKE管理。三权分立打开时，初始用户和具有内置角色ADMIN OPTION权限的用户有权对内置角色执行GRANT/REVOKE管理。例如： 1 2 GRANT gs_role_signal_backend TO user1; REVOKE gs_role_signal_backend FROM user1;

创建、修改和删除用户 创建用户，请使用SQL语句CREATE USER。 例如：创建用户joe，并设置用户拥有CREATEDB属性。 1 2 gaussdb=# CREATE USER joe WITH CREATEDB PASSWORD "********"; CREATE ROLE 创建系统管理员，请使用带有SYSADMIN选项的CREATE USER语句。 删除现有用户，请参见DROP USER。 更改用户账户（例如，重命名用户或更改密码），请参见ALTER USER。 查看用户列表，请查询视图PG_USER。 1 gaussdb=# SELECT * FROM pg_user; 查看用户属性，请查询系统表PG_AUTHID。 1 gaussdb=# SELECT * FROM pg_authid;

永久用户 GaussDB提供永久用户方案：创建具有PERSISTENCE属性的永久用户，具有PERSISTENCE属性的用户能够使用service_reserved_connections通道连接数据库。 1 gaussdb=# CREATE USER user_persistence WITH PERSISTENCE IDENTIFIED BY "********"; 只允许初始用户创建、修改和删除具有PERSISTENCE属性的永久用户。