Merge pull request #1 from louloulin/feature-gaussdb

Feature gaussdb

Author: liubao68

.gitignore

@@ -4,3 +4,5 @@ Cargo.lock
 .idea
 *.iml
 .vscode
+plan/
+scripts/

Cargo.toml

@@ -1,14 +1,15 @@
 [workspace]
 members = [
     "codegen",
-    "postgres",
-    "postgres-derive",
-    "postgres-derive-test",
-    "postgres-native-tls",
-    "postgres-openssl",
-    "postgres-protocol",
-    "postgres-types",
-    "tokio-postgres",
+    "gaussdb",
+    "gaussdb-derive",
+    "gaussdb-derive-test",
+    "gaussdb-native-tls",
+    "gaussdb-openssl",
+    "gaussdb-protocol",
+    "gaussdb-types",
+    "tokio-gaussdb",
+    "examples",
 ]
 resolver = "2"
 

README.md

@@ -1,46 +1,222 @@
-# Rust-Postgres
+# GaussDB-Rust
 
-PostgreSQL support for Rust.
+GaussDB and OpenGauss support for Rust.
 
-## postgres [![Latest Version](https://img.shields.io/crates/v/postgres.svg)](https://crates.io/crates/postgres)
+## gaussdb [![Latest Version](https://img.shields.io/crates/v/gaussdb.svg)](https://crates.io/crates/gaussdb)
 
-[Documentation](https://docs.rs/postgres)
+[Documentation](https://docs.rs/gaussdb)
 
-A native, synchronous PostgreSQL client.
+A native, synchronous GaussDB client with full PostgreSQL compatibility.
 
-## tokio-postgres [![Latest Version](https://img.shields.io/crates/v/tokio-postgres.svg)](https://crates.io/crates/tokio-postgres)
+## tokio-gaussdb [![Latest Version](https://img.shields.io/crates/v/tokio-gaussdb.svg)](https://crates.io/crates/tokio-gaussdb)
 
-[Documentation](https://docs.rs/tokio-postgres)
+[Documentation](https://docs.rs/tokio-gaussdb)
 
-A native, asynchronous PostgreSQL client.
+A native, asynchronous GaussDB client with full PostgreSQL compatibility.
 
-## postgres-types [![Latest Version](https://img.shields.io/crates/v/postgres-types.svg)](https://crates.io/crates/postgres-types)
+## gaussdb-types [![Latest Version](https://img.shields.io/crates/v/gaussdb-types.svg)](https://crates.io/crates/gaussdb-types)
 
-[Documentation](https://docs.rs/postgres-types)
+[Documentation](https://docs.rs/gaussdb-types)
 
-Conversions between Rust and Postgres types.
+Conversions between Rust and GaussDB/PostgreSQL types.
 
-## postgres-native-tls [![Latest Version](https://img.shields.io/crates/v/postgres-native-tls.svg)](https://crates.io/crates/postgres-native-tls)
+## gaussdb-native-tls [![Latest Version](https://img.shields.io/crates/v/gaussdb-native-tls.svg)](https://crates.io/crates/gaussdb-native-tls)
 
-[Documentation](https://docs.rs/postgres-native-tls)
+[Documentation](https://docs.rs/gaussdb-native-tls)
 
-TLS support for postgres and tokio-postgres via native-tls.
+TLS support for gaussdb and tokio-gaussdb via native-tls.
 
-## postgres-openssl [![Latest Version](https://img.shields.io/crates/v/postgres-openssl.svg)](https://crates.io/crates/postgres-openssl)
+## gaussdb-openssl [![Latest Version](https://img.shields.io/crates/v/gaussdb-openssl.svg)](https://crates.io/crates/gaussdb-openssl)
 
-[Documentation](https://docs.rs/postgres-openssl)
+[Documentation](https://docs.rs/gaussdb-openssl)
 
-TLS support for postgres and tokio-postgres via openssl.
+TLS support for gaussdb and tokio-gaussdb via openssl.
 
-# Running test suite
+# Features
 
-The test suite requires postgres to be running in the correct configuration. The easiest way to do this is with docker:
+## GaussDB Authentication Support
 
-1. Install `docker` and `docker-compose`.
-   1. On ubuntu: `sudo apt install docker.io docker-compose`.
-1. Make sure your user has permissions for docker.
-   1. On ubuntu: ``sudo usermod -aG docker $USER``
-1. Change to top-level directory of `rust-postgres` repo.
-1. Run `docker-compose up -d`.
-1. Run `cargo test`.
-1. Run `docker-compose stop`.
+This library provides full support for GaussDB's enhanced authentication mechanisms:
+
+- **SHA256 Authentication**: GaussDB's secure SHA256-based authentication
+- **MD5_SHA256 Authentication**: Hybrid authentication combining MD5 and SHA256
+- **Standard PostgreSQL Authentication**: Full compatibility with MD5, SCRAM-SHA-256, and other PostgreSQL auth methods
+
+## Quick Start
+
+### Basic Connection
+
+```rust
+use tokio_gaussdb::{NoTls, Error};
+
+#[tokio::main]
+async fn main() -> Result<(), Error> {
+    // Connect to GaussDB with SHA256 authentication
+    let (client, connection) = tokio_gaussdb::connect(
+        "host=localhost user=gaussdb password=Gaussdb@123 dbname=postgres port=5433",
+        NoTls,
+    ).await?;
+
+    // Spawn the connection task
+    tokio::spawn(async move {
+        if let Err(e) = connection.await {
+            eprintln!("connection error: {}", e);
+        }
+    });
+
+    // Execute a simple query
+    let rows = client.query("SELECT $1::TEXT", &[&"hello world"]).await?;
+    let value: &str = rows[0].get(0);
+    println!("Result: {}", value);
+
+    Ok(())
+}
+```
+
+### Advanced Authentication
+
+```rust
+use tokio_gaussdb::{Config, NoTls};
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    // Configure connection with specific authentication
+    let mut config = Config::new();
+    config
+        .host("localhost")
+        .port(5433)
+        .user("gaussdb")
+        .password("Gaussdb@123")
+        .dbname("postgres");
+
+    let (client, connection) = config.connect(NoTls).await?;
+
+    // Handle connection...
+    tokio::spawn(async move {
+        if let Err(e) = connection.await {
+            eprintln!("connection error: {}", e);
+        }
+    });
+
+    // Your application logic here
+    Ok(())
+}
+```
+
+## Compatibility
+
+### Database Support
+
+| Database | Version | Authentication | Status |
+|----------|---------|----------------|--------|
+| GaussDB | 2.0+ | SHA256, MD5_SHA256, MD5 | ✅ Full Support |
+| OpenGauss | 3.0+ | SHA256, MD5_SHA256, MD5 | ✅ Full Support |
+| PostgreSQL | 10+ | SCRAM-SHA-256, MD5 | ✅ Full Support |
+
+### Feature Compatibility
+
+| Feature | GaussDB | OpenGauss | PostgreSQL |
+|---------|---------|-----------|------------|
+| Basic SQL Operations | ✅ | ✅ | ✅ |
+| Transactions | ✅ | ✅ | ✅ |
+| Prepared Statements | ✅ | ✅ | ✅ |
+| COPY Operations | ✅ | ✅ | ✅ |
+| LISTEN/NOTIFY | ⚠️ Limited | ⚠️ Limited | ✅ |
+| Binary COPY | ⚠️ Issues | ⚠️ Issues | ✅ |
+
+## Running Tests
+
+### Prerequisites
+
+The test suite requires GaussDB or OpenGauss to be running. The easiest way is with Docker:
+
+1. Install `docker` and `docker-compose`
+   - On Ubuntu: `sudo apt install docker.io docker-compose`
+   - On Windows: Install Docker Desktop
+   - On macOS: Install Docker Desktop
+
+2. Make sure your user has Docker permissions
+   - On Ubuntu: `sudo usermod -aG docker $USER`
+
+### Running Tests
+
+1. Change to the top-level directory of `gaussdb-rust` repo
+2. Start the test database:
+   ```bash
+   docker-compose up -d
+   ```
+3. Run the test suite:
+   ```bash
+   cargo test
+   ```
+4. Stop the test database:
+   ```bash
+   docker-compose stop
+   ```
+
+### Test Configuration
+
+The test suite supports both GaussDB and OpenGauss environments. Connection strings are automatically configured for:
+
+- **Host**: localhost
+- **Port**: 5433 (GaussDB/OpenGauss default)
+- **User**: gaussdb
+- **Password**: Gaussdb@123
+- **Database**: postgres
+
+## Documentation
+
+### API Documentation
+
+- [gaussdb](https://docs.rs/gaussdb) - Synchronous client API
+- [tokio-gaussdb](https://docs.rs/tokio-gaussdb) - Asynchronous client API
+- [gaussdb-types](https://docs.rs/gaussdb-types) - Type conversion utilities
+- [gaussdb-protocol](https://docs.rs/gaussdb-protocol) - Low-level protocol implementation
+
+### Guides and Examples
+
+- [GaussDB Connection Guide](docs/connection-guide.md)
+- [Authentication Methods](docs/authentication.md)
+- [Migration from rust-postgres](docs/migration.md)
+- [GaussDB vs PostgreSQL Differences](docs/GaussDB-PostgreSQL-差异分析报告.md)
+
+## Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+### Development Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/HuaweiCloudDeveloper/gaussdb-rust.git
+   cd gaussdb-rust
+   ```
+
+2. Install Rust (if not already installed):
+   ```bash
+   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+   ```
+
+3. Run tests:
+   ```bash
+   cargo test
+   ```
+
+## License
+
+This project is licensed under either of
+
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+## Acknowledgments
+
+This project is based on the excellent [rust-postgres](https://github.com/sfackler/rust-postgres) library by Steven Fackler. We extend our gratitude to the original authors and contributors.
+
+## Support
+
+- [GitHub Issues](https://github.com/HuaweiCloudDeveloper/gaussdb-rust/issues) - Bug reports and feature requests
+- [Documentation](https://docs.rs/gaussdb) - API documentation and guides
+- [Examples](examples/) - Code examples and tutorials

codegen/Cargo.toml

@@ -2,6 +2,7 @@
 name = "codegen"
 version = "0.1.0"
 authors = ["Steven Fackler <[email protected]>"]
+edition = "2021"
 
 [dependencies]
 phf_codegen = "0.11"

docker-compose-opengauss.yml

@@ -0,0 +1,30 @@
+version: '3.8'
+
+services:
+  opengauss:
+    image: opengauss/opengauss-server:latest
+    container_name: opengauss-test
+    privileged: true
+    restart: unless-stopped
+    ports:
+      - "5433:5432"  # 映射到5433端口，与现有PostgreSQL测试保持一致
+    environment:
+      - GS_PASSWORD=Gaussdb@123  # OpenGauss密码：大写字母+小写字母+数字+特殊字符，长度>=8
+      - GS_NODENAME=opengauss
+      - GS_USERNAME=gaussdb   # 自定义用户名
+
+    #volumes:
+      #- opengauss_data:/var/lib/opengauss/data
+      #- ./docker/opengauss_setup.sh:/docker-entrypoint-initdb.d/opengauss_setup.sh
+    networks:
+      - gaussdb_network
+    healthcheck:
+      test: ["CMD-SHELL", "gsql -d postgres -U gaussdb -c 'SELECT 1;' || exit 1"]
+      interval: 30s
+      timeout: 10s
+      retries: 5
+      start_period: 60s
+
+networks:
+  gaussdb_network:
+    driver: bridge