hcq/openGauss-connector-jdbc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

更新readme

Browse Source
This commit is contained in:
congzhou2603
2023-08-12 16:54:56 +08:00
parent 8cdbb66a99
commit c40395c061
2 changed files with 27 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README_cn.md
View File

@ -1,4 +1,4 @@
![openGauss Logo](https://opengauss.org/img/brand/view/logo2.jpg)
![openGauss Logo](https://opengauss.org/category/brand/view/logo1.png)
@ -7,14 +7,14 @@
openGauss是一款开源的关系型数据库管理系统，它具有多核高性能、全链路安全性、智能运维等企业级特性。
openGauss内核早期源自开源数据库PostgreSQL，融合了华为在数据库领域多年的内核经验，在架构、事务、存储引擎、优化器及ARM架构上进行了适配与优化。作为一个开源数据库，期望与广泛的开发者共同构建一个多元化技术的开源数据库社区。
Java数据库连接，（Java Database Connectivity，简称**JDBC**）是Java语言中用来规范客户端程序如何来访问数据库的应用程序接口，提供了诸如查询和更新数据库中数据的方法。openGauss-connector-JDBC就是提供给用户通过Java语言访问数据库的应用程序接口。用户可以使用openGauss官网提供的jar包（[参考直接获取部分](#安装)），也可以自行构建jar包（[参考从源码构建部分](#从源码构建)）以使用JDBC操作数据库。
Java数据库连接，（Java Database Connectivity，简称**JDBC**）是Java语言中用来规范客户端程序如何来访问数据库的应用程序接口，提供了诸如查询和更新数据库中数据的方法。openGauss-connector-JDBC就是提供给用户通过Java语言访问数据库的应用程序接口。用户可以使用openGauss官网提供的jar包（[参考直接获取部分](#直接获取)），也可以自行构建jar包（[参考从源码构建部分](#从源码构建)）以使用JDBC操作数据库。
## 直接获取
在使用openGauss JDBC 驱动之前，请确保您的服务器已经可以正常运行 openGauss 数据库（参考openGauss[快速入门](https://opengauss.org/zh/docs/latest/docs/Quickstart/Quickstart.html)）。
在使用openGauss JDBC 驱动之前，请确保您的服务器已经可以正常运行 openGauss 数据库（参考openGauss[快速入门](https://docs.opengauss.org/zh/docs/latest/docs/GettingStarted/GettingStarted.html)）。
### 从maven中央仓库获取
@ -29,7 +29,7 @@ Java开发者可从maven中央仓库中直接获取jar包，坐标如下：
1. 在官网下载安装包。
点击[链接](https://opengauss.org/zh/download.html)，在openGauss Connectors部分下，根据您部署数据库的服务器的对应系统选择JDBC_${version}的下载按钮。${version}即您需要的版本号。
点击[链接](https://opengauss.org/zh/download/)，在openGauss Connectors部分下，根据您部署数据库的服务器的对应系统选择JDBC_\\${version}的下载按钮。\\${version}即您需要的版本号。
2. 解压压缩包。
@ -37,7 +37,7 @@ Java开发者可从maven中央仓库中直接获取jar包，坐标如下：
tar -zxvf openGauss-${version}-JDBC.tar.gz
```
3. 解压后可以看到同级目录下出现了两个jar包，分别是opengauss-jdbc-${version}.jar和postgresql.jar。opengauss-jdbc-${version}.jar是可以与PG-JDBC共存的包, 包名自2.0.1之后的版本全部从org.postgresql变更为org.opengauss,并且驱动名称从jdbc:postgresql://替换为jdbc:opengauss://。目前从maven中央仓库中获取的也是这个包。
3. 解压后可以看到同级目录下出现了两个jar包，分别是opengauss-jdbc-\\${version}.jar和postgresql.jar。opengauss-jdbc-\\${version}.jar是可以与PG-JDBC共存的包, 包名自2.0.1之后的版本全部从org.postgresql变更为org.opengauss,并且驱动名称从jdbc:postgresql://替换为jdbc:opengauss://。目前从maven中央仓库中获取的也是这个包。
## 从源码构建
@ -54,7 +54,7 @@ openGauss JDBC 驱动的生成支持以下操作系统：
- openEuler-20.03-LTS（aarch64架构）
- Windows
适配其他系统，参照博客[openGauss数据库编译指导](https://opengauss.org/zh/blogs/blogs.html?post/xingchen/opengauss_compile/)
适配其他系统，参照博客[openGauss数据库编译指导](https://opengauss.org/zh/blogs/xingchen/opengauss_compile.html)
以下表格列举了编译openGauss的软件要求。
@ -146,16 +146,16 @@ openGauss-connector-jdbc中的build.sh是编译过程中的重要脚本工具。
[INFO] ------------------------------------------------------------------------
```
构建成功后会出现两个jar包，分别是opengauss-jdbc-${version}.jar与original-opengauss-jdbc-${version}.jar。jar包路径为/sda/openGauss-connector-jdbc/pgjdbc/target/。
**注意:默认的mvn编译出的jdbc包名为org.postgresql,它与maven中央仓库的包名org.opengauss不同,想打包此包名，请参考build.sh脚本**
构建成功后会出现两个jar包，分别是opengauss-jdbc-\\${version}.jar与postgresql.jar。jar包路径为/sda/openGauss-connector-jdbc/pgjdbc/target/。
**注意:3.1.0之后，我们在maven中央仓库提供了org.postgresql和org.opengauss两种jar包版本.其中默认的的版本号对应org.postgresql的jar包，x.0.0-og对应org.opengauss的jar包。**
## JDBC的使用
参考[基于JDBC开发](https://opengauss.org/zh/docs/latest/docs/Developerguide/%E5%9F%BA%E4%BA%8EJDBC%E5%BC%80%E5%8F%91.html)。
参考[基于JDBC开发](https://docs.opengauss.org/zh/docs/latest/docs/DeveloperGuide/%E5%9F%BA%E4%BA%8EJDBC%E5%BC%80%E5%8F%91.html)。
## 文档
更多安装指南、教程和API请参考[用户文档](https://gitee.com/opengauss/docs)。
更多安装指南、教程和API请参考[用户文档](https://docs.opengauss.org/zh/docs/latest/docs/GettingStarted/GettingStarted.html)。
## 社区
@ -171,11 +171,11 @@ openGauss-connector-jdbc中的build.sh是编译过程中的重要脚本工具。
## 贡献
欢迎大家来参与贡献。详情请参阅我们的[社区贡献](https://opengauss.org/zh/contribution.html)。
欢迎大家来参与贡献。详情请参阅我们的[社区贡献](https://opengauss.org/zh/contribution/)。
## 发行说明
请参见[发行说明](https://opengauss.org/zh/docs/2.0.0/docs/Releasenotes/Releasenotes.html)。
请参见[发行说明](https://docs.opengauss.org/zh/docs/latest/docs/ReleaseNotes/Releasenotes.html)。
## 许可证

30
README_en.md
View File

@ -1,4 +1,4 @@
![openGauss Logo](https://opengauss.org/img/brand/view/logo2.jpg)
![openGauss Logo](https://opengauss.org/category/brand/view/logo1.png)
@ -6,14 +6,14 @@
openGauss is an open source relational database management system. It has multi-core high-performance, full link security, intelligent operation and maintenance for enterprise features. openGauss, which is early originated from PostgreSQL, integrates Huawei's core experience in database field for many years. It optimizes the architecture, transaction, storage engine, optimizer and ARM architecture. At the meantime, openGauss as a global database open source community, aims to further advance the development and enrichment of the database software/hardware application ecosystem.
**Java Database Connectivity** (**JDBC**) is an application programming interface (API) for the programming language Java, which defines how a client may access a database. It is a Java-based data access technology used for Java database connectivity. It provides methods to query and update data in a database, and is oriented toward relational databases. openGauss-connector-jdbc is to provide users with access to the database through the Java language application interface . Users can use the jar package provided by the openGauss official website (refer to the [Direct Access section](#1)) or build their own jar package ([refer to the Building from Source section](#BuildfromSource) to operate the database using JDBC.
**Java Database Connectivity** (**JDBC**) is an application programming interface (API) for the programming language Java, which defines how a client may access a database. It is a Java-based data access technology used for Java database connectivity. It provides methods to query and update data in a database, and is oriented toward relational databases. openGauss-connector-jdbc is to provide users with access to the database through the Java language application interface . Users can use the jar package provided by the openGauss official website or build their own jar package to operate the database using JDBC.
## Direct access {#1}
## Direct access
Before using the openGauss JDBC driver, make sure your server is up and running with the openGauss database (refer to the openGauss [Quickstart](https://opengauss.org/en/docs/latest/docs/Quickstart/Quickstart.html)）。
Before using the openGauss JDBC driver, make sure your server is up and running with the openGauss database (refer to the openGauss [Quickstart](https://docs.opengauss.org/en/docs/latest/docs/GettingStarted/GettingStarted.html)）。
### Get from maven central repository
@ -28,7 +28,7 @@ Java developers can get jar packages directly from the maven central repository
1. Download the installation package from the official website.
Click on [link](https://opengauss.org/en/download.html) and under the openGauss Connectors section, select the download button for JDBC_${version} according to the corresponding system of the server where you are deploying the database. ${version} is the version number you need.
Click on [link](https://opengauss.org/en/download/) and under the openGauss Connectors section, select the download button for JDBC_\\${version} according to the corresponding system of the server where you are deploying the database. \\${version} is the version number you need.
2. Decompress the zip file.
@ -36,7 +36,7 @@ Java developers can get jar packages directly from the maven central repository
tar -zxvf openGauss-${version}-JDBC.tar.gz
```
3. After unpacking, you can see two jar packages in the same directory, opengauss-jdbc-${version}.jar and postgresql.jar. opengauss-jdbc-${version}.jar is a package that can coexist with PG-JDBC, the package name is changed from 2.0.1 to org.postgresql.jar. postgresql to org.opengauss, and the driver name is replaced from jdbc:postgresql:// to jdbc:opengauss://. This is the same package that is currently available from the maven central repository.
3. After unpacking, you can see two jar packages in the same directory, opengauss-jdbc-\\${version}.jar and postgresql.jar. opengauss-jdbc-\\${version}.jar is a package that can coexist with PG-JDBC, the package name is changed from 2.0.1 to org.postgresql.jar. postgresql to org.opengauss, and the driver name is replaced from jdbc:postgresql:// to jdbc:opengauss://. This is the same package that is currently available from the maven central repository.
### INSTALLING THE DRIVER
@ -54,15 +54,15 @@ export CLASSPATH=.:/usr/local/pgsql/share/java/opengauss-jdbc-${version}.jar
## Build from Source {#BuildfromSource}
## Build from Source
### Overview
The openGauss JDBC driver currently offers 3 ways to build. One is to build via the one-click script build.sh. The second is a step-by-step build via script. The third is to build via the mvn command.
This will compile the correct driver for your JVM, and build a .jar file (Java ARchive) called postgresql.jar and opengauss-jdbc--${version}.jar in output/, and you can get openGauss-${version}-jdbc.tar.gz too.
This will compile the correct driver for your JVM, and build a .jar file (Java ARchive) called postgresql.jar and opengauss-jdbc--\\${version}.jar in output/, and you can get openGauss-\\${version}-jdbc.tar.gz too.
Notice: postgresql.jar is conflict use with postgres database. Because all class was in package org.postgresql. opengauss-jdbc-${version}.jar is compatibility with postgres database, all java package renamed `org.opengauss`, and jdbc driver is: `jdbc:opengauss:/`
Notice: postgresql.jar is conflict use with postgres database. Because all class was in package org.postgresql. opengauss-jdbc-\\${version}.jar is compatibility with postgres database, all java package renamed `org.opengauss`, and jdbc driver is: `jdbc:opengauss:/`
Remember: Once you have compiled the driver, it will work on ALL platforms that support that version of the API. You don't need to build it for each platform.
@ -163,17 +163,17 @@ so you can compile the openGauss-connector-jdbc by one command with build.sh. In
[INFO] ------------------------------------------------------------------------
```
Two jar packages will appear after a successful build, opengauss-jdbc-${version}.jar and original-opengauss-jdbc-${version}.jar. jar package path is /sda/openGauss-connector-jdbc/pgjdbc /target/.
Two jar packages will appear after a successful build, opengauss-jdbc-\\${version}.jar and postgresql.jar. jar package path is /sda/openGauss-connector-jdbc/pgjdbc /target/.
**notice: this build artifact's package name is org.postgresql which different with maven central repository. if you want build package with org.opengauss, please refer to build.sh.**
## Using JDBC
Reference [JDBC-based development](https://opengauss.org/en/docs/latest/docs/Developerguide/development-based-on-jdbc.html).
Reference [JDBC-based development](https://docs.opengauss.org/en/docs/latest/docs/DeveloperGuide/development-based-on-jdbc.html).
## Docs
For more details about the installation guide, tutorials, and APIs, please see the [User Documentation](https://gitee.com/opengauss/docs).
For more details about the installation guide, tutorials, and APIs, please see the [User Documentation](https://docs.opengauss.org/en/docs/latest/docs/GettingStarted/GettingStarted.html).
## Community
@ -185,15 +185,15 @@ Check out how openGauss implements open governance [works](https://gitee.com/ope
- WeLink- Communication platform for developers.
- IRC channel at `#opengauss-meeting` (only for meeting minutes logging purpose)
- Mailing-list: https://opengauss.org/en/community/onlineCommunication.html
- Mailing-list: [Communication | openGauss](https://opengauss.org/en/community/onlineCommunication/)
## Contribution
Welcome contributions. See our [Contributor](https://opengauss.org/en/contribution.html) for more details.
Welcome contributions. See our [Contributor](https://opengauss.org/en/contribution/) for more details.
## Release Notes
For the release notes, see our [RELEASE](https://opengauss.org/en/docs/2.0.0/docs/Releasenotes/Releasenotes.html).
For the release notes, see our [RELEASE](https://docs.opengauss.org/en/docs/latest/docs/ReleaseNotes/Releasenotes.html).
## License